TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
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 = array()
 
 $view
 

Detailed Description

Definition at line 17 of file ViewHelperVariableContainer.php.

Member Function Documentation

__sleep ( )

Clean up for serializing.

Returns
array

Definition at line 146 of file ViewHelperVariableContainer.php.

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$viewHelperNameThe ViewHelper Class name (Fully qualified, like )
string$keyKey of the data
mixed$valueThe value to store
Returns
void
Exceptions
\TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableExceptionif there was no key with the specified name

Definition at line 45 of file ViewHelperVariableContainer.php.

References ViewHelperVariableContainer\addOrUpdate(), and ViewHelperVariableContainer\exists().

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$viewHelperNameThe ViewHelper Class name (Fully qualified, like )
string$keyKey of the data
mixed$valueThe value to store
Returns
void

Definition at line 63 of file ViewHelperVariableContainer.php.

Referenced by ViewHelperVariableContainer\add().

exists (   $viewHelperName,
  $key 
)

Determine whether there is a variable stored for the given key

Parameters
string$viewHelperNameThe ViewHelper Class name (Fully qualified, like )
string$keyKey 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 ViewHelperVariableContainer\add(), ViewHelperVariableContainer\get(), and ViewHelperVariableContainer\remove().

get (   $viewHelperName,
  $key 
)

Gets a variable which is stored

Parameters
string$viewHelperNameThe ViewHelper Class name (Fully qualified, like )
string$keyKey of the data
Returns
mixed The object stored
Exceptions
\TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableExceptionif there was no key with the specified name

Definition at line 80 of file ViewHelperVariableContainer.php.

References ViewHelperVariableContainer\exists().

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 ViewHelperVariableContainer\$view.

remove (   $viewHelperName,
  $key 
)

Remove a value from the variable container

Parameters
string$viewHelperNameThe ViewHelper Class name (Fully qualified, like )
string$keyKey of the data to remove
Returns
void
Exceptions
\TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableExceptionif there was no key with the specified name

Definition at line 110 of file ViewHelperVariableContainer.php.

References ViewHelperVariableContainer\exists().

Set the view to pass it to ViewHelpers.

Parameters
\TYPO3\CMS\Fluid\View\AbstractTemplateView$viewView to set
Returns
void

Definition at line 124 of file ViewHelperVariableContainer.php.

References ViewHelperVariableContainer\$view.

Member Data Documentation

$objects = array()
protected

Definition at line 25 of file ViewHelperVariableContainer.php.

$view
protected