TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer Class Reference

Public Member Functions
	add ($viewHelperName, $key, $value)
	addOrUpdate ($viewHelperName, $key, $value)
	get ($viewHelperName, $key)
	exists ($viewHelperName, $key)
	remove ($viewHelperName, $key)
	setView (\TYPO3\CMS\Fluid\View\AbstractTemplateView $view)
	getView ()
	__sleep ()

Protected Attributes
	$objects = []
	$view

Detailed Description

Definition at line 17 of file ViewHelperVariableContainer.php.

Member Function Documentation

__sleep()

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::__sleep

(

)

Clean up for serializing.

Returns

array

Definition at line 146 of file ViewHelperVariableContainer.php.

add()

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::add	(		$viewHelperName,
			$key,
			$value
	)

Add a variable to the Variable Container. Make sure that $viewHelperName is ALWAYS set to your fully qualified ViewHelper Class Name

In case the value is already inside, an exception is thrown.

Parameters

string	$viewHelperName	The ViewHelper Class name (Fully qualified, like )
string	$key	Key of the data
mixed	$value	The value to store

Returns

void

Exceptions

Definition at line 45 of file ViewHelperVariableContainer.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\addOrUpdate(), and TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\exists().

addOrUpdate()

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::addOrUpdate	(		$viewHelperName,
			$key,
			$value
	)

Add a variable to the Variable Container. Make sure that $viewHelperName is ALWAYS set to your fully qualified ViewHelper Class Name. In case the value is already inside, it is silently overridden.

Parameters

string	$viewHelperName	The ViewHelper Class name (Fully qualified, like )
string	$key	Key of the data
mixed	$value	The value to store

Returns

void

Definition at line 63 of file ViewHelperVariableContainer.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\add().

exists()

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::exists	(		$viewHelperName,
			$key
	)

Determine whether there is a variable stored for the given key

Parameters

string	$viewHelperName	The ViewHelper Class name (Fully qualified, like )
string	$key	Key of the data

Returns

bool TRUE if a value for the given ViewHelperName / Key is stored, FALSE otherwise.

Definition at line 96 of file ViewHelperVariableContainer.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\add(), TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\get(), and TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\remove().

get()

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::get	(		$viewHelperName,
			$key
	)

Gets a variable which is stored

Parameters

string	$viewHelperName	The ViewHelper Class name (Fully qualified, like )
string	$key	Key of the data

Returns

mixed The object stored

Exceptions

Definition at line 80 of file ViewHelperVariableContainer.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\exists().

getView()

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::getView

(

)

Get the view.

!!! This is NOT a public API and might still change!!!

Returns

The View

Definition at line 136 of file ViewHelperVariableContainer.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\$view.

remove()

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::remove	(		$viewHelperName,
			$key
	)

Remove a value from the variable container

Parameters

string	$viewHelperName	The ViewHelper Class name (Fully qualified, like )
string	$key	Key of the data to remove

Returns

void

Exceptions

Definition at line 110 of file ViewHelperVariableContainer.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\exists().

setView()

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::setView

(

\TYPO3\CMS\Fluid\View\AbstractTemplateView

$view

)

Set the view to pass it to ViewHelpers.

Parameters

\TYPO3\CMS\Fluid\View\AbstractTemplateView

$view

View to set

Returns

void

Definition at line 124 of file ViewHelperVariableContainer.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\$view.

Member Data Documentation

$objects

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::$objects = []

protected

Definition at line 25 of file ViewHelperVariableContainer.php.

$view

TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer::$view

protected

Definition at line 30 of file ViewHelperVariableContainer.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\getView(), and TYPO3\CMS\Fluid\Core\ViewHelper\ViewHelperVariableContainer\setView().