iPluginStorage
in
Table of Contents
Methods
- __construct() : mixed
- Constructor must not take argument.
- get() : mixed
- Returns plugin data.
- set() : mixed
- Stores plugin data.
Methods
__construct()
Constructor must not take argument.
public
__construct() : mixed
The constructor must be part of the interface since our Plugin factory calls it and thus must know its arguments.
get()
Returns plugin data.
public
get(object $plugin[, mixed $key = null ][, string $model = null ][, int $id = null ][, mixed $default = null ][, string $language = null ]) : mixed
Parameters
- $plugin : object
-
The plugin object getting its data.
- $key : mixed = null
- $model : string = null
-
Name of a model in case its model specific plugin data, like for a specific question or survey.
- $id : int = null
-
Id of the model for which the data is retreived
- $default : mixed = null
-
The default value to use when none present
- $language : string = null
-
The optional language to use
Return values
mixed —The data stored.
set()
Stores plugin data.
public
set(object $plugin, string $key, mixed $data[, string $model = null ][, int $id = null ][, string $language = null ]) : mixed
Parameters
- $plugin : object
-
The plugin object getting its data.
- $key : string
-
The storage key to identify the data.
- $data : mixed
-
The data to be stored, serialized using serialize.
- $model : string = null
-
Name of a model in case its model specific plugin data, like for a specific question or survey.
- $id : int = null
-
Id of the model for which the data is retreived
- $language : string = null
-
The optional language to use