TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider Class Reference

Inheritance diagram for TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider:

Public Member Functions
	add (string $finisherIdentifier, string $key, $value)
	addOrUpdate (string $finisherIdentifier, string $key, $value)
mixed	get (string $finisherIdentifier, string $key, $default=null)
bool	exists ($finisherIdentifier, $key)
	remove (string $finisherIdentifier, string $key)
array	__sleep ()
bool	offsetExists ($offset)
mixed	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
Traversable	getIterator ()
int	count ()

Protected Attributes
array	$objects = array( )

Detailed Description

Store data for usage between the finishers.

Scope: frontend This class is NOT meant to be sub classed by developers.

Definition at line 30 of file FinisherVariableProvider.php.

Member Function Documentation

__sleep()

array TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::__sleep

(

)

Clean up for serializing.

Returns

‪array

Definition at line 128 of file FinisherVariableProvider.php.

add()

TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::add	(	string	$finisherIdentifier,
		string	$key,
			$value
	)

Add a variable to the finisher container.

Parameters

string	$finisherIdentifier
string	$key
mixed	$value

Definition at line 47 of file FinisherVariableProvider.php.

References TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider\addOrUpdate().

addOrUpdate()

TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::addOrUpdate	(	string	$finisherIdentifier,
		string	$key,
			$value
	)

Add a variable to the Variable Container. In case the value is already inside, it is silently overridden.

Parameters

string	$finisherIdentifier
string	$key
mixed	$value

Definition at line 60 of file FinisherVariableProvider.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\setValueByPath().

Referenced by TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider\add().

count()

int TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::count

(

)

Count elements of an object

int The custom count as an integer.

Definition at line 196 of file FinisherVariableProvider.php.

exists()

bool TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::exists	(		$finisherIdentifier,
			$key
	)

Determine whether there is a variable stored for the given key

Parameters

string	$finisherIdentifier
string	$key

Returns

‪bool

Definition at line 96 of file FinisherVariableProvider.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath().

Referenced by TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider\get(), and TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider\remove().

get()

mixed TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::get	(	string	$finisherIdentifier,
		string	$key,
			$default = null
	)

Gets a variable which is stored

Parameters

string	$finisherIdentifier
string	$key
mixed	$default

Returns

‪mixed

Definition at line 81 of file FinisherVariableProvider.php.

References TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider\exists(), and TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath().

getIterator()

Traversable TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::getIterator

(

)

Returns

‪\Traversable

Definition at line 183 of file FinisherVariableProvider.php.

offsetExists()

bool TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::offsetExists

(

$offset

)

Whether an offset exists

mixed $offset An offset to check for. bool TRUE on success or FALSE on failure.

Definition at line 140 of file FinisherVariableProvider.php.

offsetGet()

mixed TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::offsetGet

(

$offset

)

Offset to retrieve

mixed $offset The offset to retrieve. mixed Can return all value types.

Definition at line 152 of file FinisherVariableProvider.php.

offsetSet()

TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::offsetSet	(		$offset,
			$value
	)

Offset to set

mixed $offset The offset to assign the value to. mixed $value The value to set.

Definition at line 164 of file FinisherVariableProvider.php.

offsetUnset()

TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::offsetUnset

(

$offset

)

Offset to unset

mixed $offset The offset to unset.

Definition at line 175 of file FinisherVariableProvider.php.

remove()

TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::remove	(	string	$finisherIdentifier,
		string	$key
	)

Remove a value from the variable container

Parameters

string	$finisherIdentifier
string	$key

Definition at line 112 of file FinisherVariableProvider.php.

References TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider\exists(), and TYPO3\CMS\Core\Utility\ArrayUtility\removeByPath().

Member Data Documentation

$objects

array TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider::$objects = array( )

protected

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.

Definition at line 38 of file FinisherVariableProvider.php.