TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Fluid\Core\ViewHelper\Arguments Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\Core\ViewHelper\Arguments:
Tx_Fluid_Core_ViewHelper_Arguments

Public Member Functions

 __construct (array $arguments)
 
 offsetExists ($key)
 
 offsetGet ($key)
 
 offsetSet ($key, $value)
 
 offsetUnset ($key)
 
 hasArgument ($argumentName)
 

Protected Attributes

 $arguments = array()
 

Detailed Description

Arguments list. Wraps an array, but only allows read-only methods on it. Is available inside every view helper as $this->arguments - and you use it as if it was an array. However, you can only read, and not write to it.

Definition at line 30 of file Arguments.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Fluid\Core\ViewHelper\Arguments::__construct ( array  $arguments)

Constructor.

Parameters
array$argumentsArray of arguments

Definition at line 43 of file Arguments.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\Arguments\$arguments.

Member Function Documentation

◆ hasArgument()

TYPO3\CMS\Fluid\Core\ViewHelper\Arguments::hasArgument (   $argumentName)

Checks if an argument with the specified name exists

Parameters
string$argumentNameName of the argument to check for
Returns
boolean TRUE if such an argument exists, otherwise FALSE
See also
offsetExists()

Definition at line 96 of file Arguments.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\Arguments\offsetExists().

◆ offsetExists()

TYPO3\CMS\Fluid\Core\ViewHelper\Arguments::offsetExists (   $key)

Checks if a given key exists in the array

Parameters
string$keyKey to check
Returns
boolean true if exists

Definition at line 53 of file Arguments.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\Arguments\hasArgument().

◆ offsetGet()

TYPO3\CMS\Fluid\Core\ViewHelper\Arguments::offsetGet (   $key)

Returns the value to the given key.

Parameters
string$keyKey to get.
Returns
object associated value

Definition at line 63 of file Arguments.php.

◆ offsetSet()

TYPO3\CMS\Fluid\Core\ViewHelper\Arguments::offsetSet (   $key,
  $value 
)

Throw exception if you try to set a value.

Parameters
string$key
object$value

Definition at line 76 of file Arguments.php.

◆ offsetUnset()

TYPO3\CMS\Fluid\Core\ViewHelper\Arguments::offsetUnset (   $key)

Throw exception if you try to unset a value.

Parameters
string$key

Definition at line 85 of file Arguments.php.

Member Data Documentation

◆ $arguments

TYPO3\CMS\Fluid\Core\ViewHelper\Arguments::$arguments = array()
protected

Array storing the arguments themselves

Definition at line 35 of file Arguments.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\Arguments\__construct().