FinisherVariableProvider implements ArrayAccess, IteratorAggregate, Countable
Store data for usage between the finishers.
Scope: frontend This class is NOT meant to be sub classed by developers.
Table of Contents
Interfaces
- ArrayAccess
- IteratorAggregate
- Countable
Properties
- $objects : array<string|int, mixed>
- Two-dimensional object array storing the values. The first dimension is the finisher identifier, and the second dimension is the identifier for the data the finisher wants to store.
Methods
- __sleep() : array<string|int, mixed>
- Clean up for serializing.
- add() : mixed
- Add a variable to the finisher container.
- addOrUpdate() : mixed
- Add a variable to the Variable Container.
- count() : int
- Count elements of an object
- exists() : bool
- Determine whether there is a variable stored for the given key
- get() : mixed
- Gets a variable which is stored
- getIterator() : Traversable
- offsetExists() : bool
- Whether an offset exists
- offsetGet() : mixed
- Offset to retrieve
- offsetSet() : void
- Offset to set
- offsetUnset() : void
- Offset to unset
- remove() : mixed
- Remove a value from the variable container
Properties
$objects
Two-dimensional object array storing the values. The first dimension is the finisher identifier, and the second dimension is the identifier for the data the finisher wants to store.
protected
array<string|int, mixed>
$objects
= []
Methods
__sleep()
Clean up for serializing.
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>add()
Add a variable to the finisher container.
public
add(string $finisherIdentifier, string $key, mixed $value) : mixed
Parameters
- $finisherIdentifier : string
- $key : string
- $value : mixed
addOrUpdate()
Add a variable to the Variable Container.
public
addOrUpdate(string $finisherIdentifier, string $key, mixed $value) : mixed
In case the value is already inside, it is silently overridden.
Parameters
- $finisherIdentifier : string
- $key : string
- $value : mixed
count()
Count elements of an object
public
count() : int
Tags
Return values
int —The custom count as an integer.
exists()
Determine whether there is a variable stored for the given key
public
exists(string $finisherIdentifier, string $key) : bool
Parameters
- $finisherIdentifier : string
- $key : string
Return values
boolget()
Gets a variable which is stored
public
get(string $finisherIdentifier, string $key[, mixed $default = null ]) : mixed
Parameters
- $finisherIdentifier : string
- $key : string
- $default : mixed = null
getIterator()
public
getIterator() : Traversable
Return values
TraversableoffsetExists()
Whether an offset exists
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
-
An offset to check for.
Tags
Return values
bool —TRUE on success or FALSE on failure.
offsetGet()
Offset to retrieve
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
-
The offset to retrieve.
Tags
Return values
mixed —Can return all value types.
offsetSet()
Offset to set
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
-
The offset to assign the value to.
- $value : mixed
-
The value to set.
Tags
offsetUnset()
Offset to unset
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
-
The offset to unset.
Tags
remove()
Remove a value from the variable container
public
remove(string $finisherIdentifier, string $key) : mixed
Parameters
- $finisherIdentifier : string
- $key : string