83 lines
1.8 KiB
PHP
83 lines
1.8 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Component.Builder
|
|
*
|
|
* @created 4th September, 2022
|
|
* @author Llewellyn van der Merwe <https://dev.vdm.io>
|
|
* @git Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
|
|
* @copyright Copyright (C) 2015 Vast Development Method. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
namespace VDM\Joomla\Componentbuilder\Interfaces;
|
|
|
|
|
|
/**
|
|
* The Single Mapper Interface
|
|
*/
|
|
interface Mappersingleinterface
|
|
{
|
|
/**
|
|
* Check if any values are set in the active array
|
|
*
|
|
* @return bool Returns true if the active array is not empty, false otherwise
|
|
* @since 3.2.0
|
|
*/
|
|
public function isActive(): bool;
|
|
|
|
/**
|
|
* Set content
|
|
*
|
|
* @param string $key The main string key
|
|
* @param mixed $value The values to set
|
|
*
|
|
* @return void
|
|
* @since 3.2.0
|
|
*/
|
|
public function set(string $key, $value): void;
|
|
|
|
/**
|
|
* Get content
|
|
*
|
|
* @param string $key The main string key
|
|
* @param mixed $value The values to set
|
|
*
|
|
* @return mixed
|
|
* @since 3.2.0
|
|
*/
|
|
public function get(string $key);
|
|
|
|
/**
|
|
* Does key exist
|
|
*
|
|
* @param string $key The main string key
|
|
*
|
|
* @return bool
|
|
* @since 3.2.0
|
|
*/
|
|
public function exist(string $key): bool;
|
|
|
|
/**
|
|
* Add content
|
|
*
|
|
* @param string $key The main string key
|
|
* @param mixed $value The values to set
|
|
* @param bool $array The is array switch
|
|
*
|
|
* @return void
|
|
* @since 3.2.0
|
|
*/
|
|
public function add(string $key, $value, bool $array = false): void;
|
|
|
|
/**
|
|
* Remove content
|
|
*
|
|
* @param string $key The main string key
|
|
*
|
|
* @return void
|
|
* @since 3.2.0
|
|
*/
|
|
public function remove(string $key): void;
|
|
}
|
|
|