AddonValueContainerInterface
in
Interface AddonValueContainerInterface
Tags
Table of Contents
- addAddonValues() : mixed
- Merges the existing addon values with new ones.
- deleteAddonValue() : mixed
- Deletes a specific addon value entry by key.
- getAddonValue() : string
- Returns a specific addon value by providing its key.
- getAddonValueContainerId() : int
- Returns the addon value container ID.
- getAddonValues() : KeyValueCollection
- Returns all the addon values as a KeyValueCollection.
- setAddonValue() : mixed
- Sets the value of a specific addon key.
Methods
addAddonValues()
Merges the existing addon values with new ones.
public
addAddonValues(KeyValueCollection $addonValues) : mixed
Parameters
- $addonValues : KeyValueCollection
-
Contains the new addon values to be merged with the existing ones.
Return values
mixed —deleteAddonValue()
Deletes a specific addon value entry by key.
public
deleteAddonValue(StringType $key) : mixed
Parameters
- $key : StringType
-
Addon key.
Return values
mixed —getAddonValue()
Returns a specific addon value by providing its key.
public
getAddonValue(StringType $key) : string
Parameters
- $key : StringType
-
Addon key.
Return values
string —getAddonValueContainerId()
Returns the addon value container ID.
public
getAddonValueContainerId() : int
Return values
int —Addon value container ID.
getAddonValues()
Returns all the addon values as a KeyValueCollection.
public
getAddonValues() : KeyValueCollection
Return values
KeyValueCollection —Addons key value collection.
setAddonValue()
Sets the value of a specific addon key.
public
setAddonValue(StringType $key, StringType $value) : mixed
Parameters
- $key : StringType
-
The addon key to be processed.
- $value : StringType
-
The new value of the addon entry.