1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
<?php
/* --------------------------------------------------------------
AddonValueContainerInterface.inc.php 2015-11-20 gm
Gambio GmbH
http://www.gambio.de
Copyright (c) 2015 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface AddonValueContainerInterface
*
* @category System
* @package AddonValue
* @subpackage Interfaces
*/
interface AddonValueContainerInterface
{
/**
* Returns the addon value container ID.
*
* @return int Addon value container ID.
*/
public function getAddonValueContainerId();
/**
* Returns a specific addon value by providing its key.
*
* @param StringType $key Addon key.
*
* @return string
*/
public function getAddonValue(StringType $key);
/**
* Returns all the addon values as a KeyValueCollection.
*
* @return KeyValueCollection Addons key value collection.
*/
public function getAddonValues();
/**
* Sets the value of a specific addon key.
*
* @param StringType $key The addon key to be processed.
* @param StringType $value The new value of the addon entry.
*/
public function setAddonValue(StringType $key, StringType $value);
/**
* Merges the existing addon values with new ones.
*
* @param KeyValueCollection $addonValues Contains the new addon values to be merged with the existing ones.
*/
public function addAddonValues(KeyValueCollection $addonValues);
/**
* Deletes a specific addon value entry by key.
*
* @param StringType $key Addon key.
*/
public function deleteAddonValue(StringType $key);
}