API Documentation
Back to top  

AddonValueContainerInterface

Extends

Interface AddonValueContainerInterface

category

System
package

AddonValue
subpackage

Interfaces

Methods

Merges the existing addon values with new ones.

addAddonValues(\KeyValueCollection $addonValues)

Arguments

$addonValues

\KeyValueCollection

Contains the new addon values to be merged with the existing ones.

Deletes a specific addon value entry by key.

deleteAddonValue(\StringType $key)

Arguments

$key

\StringType

Addon key.

Returns a specific addon value by providing its key.

getAddonValue(\StringType $key) : string

Arguments

$key

\StringType

Addon key.

Response

string

Returns the addon value container ID.

getAddonValueContainerId() : integer

Response

integer

Addon value container ID.

Returns all the addon values as a KeyValueCollection.

getAddonValues() : \KeyValueCollection

Response

\KeyValueCollection

Addons key value collection.

Sets the value of a specific addon key.

setAddonValue(\StringType $key, \StringType $value)

Arguments

$key

\StringType

The addon key to be processed.

$value

\StringType

The new value of the addon entry.