TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
Arguments Class Reference
Inheritance diagram for Arguments:

Public Member Functions

 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 __construct ()
 
 offsetSet ($offset, $value)
 
 append ($value)
 
 offsetUnset ($offset)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 addArgument (Argument $argument)
 
 getArgument ($argumentName)
 
 hasArgument ($argumentName)
 
 getArgumentNames ()
 
 __call ($methodName, array $arguments)
 
 removeAll ()
 

Protected Attributes

 $objectManager
 
 $argumentNames = array()
 
 $argumentShortNames = array()
 

Detailed Description

A composite of controller arguments

Definition at line 20 of file extbase/Classes/Mvc/Controller/Arguments.php.

Constructor & Destructor Documentation

__construct ( )

Constructor. If this one is removed, reflection breaks.

Definition at line 48 of file extbase/Classes/Mvc/Controller/Arguments.php.

Member Function Documentation

__call (   $methodName,
array  $arguments 
)

Magic setter method for the argument values. Each argument value can be set by just calling the setArgumentName() method.

Parameters
string$methodNameName of the method
array$argumentsMethod arguments
Exceptions
\LogicException
Returns
void

Definition at line 228 of file extbase/Classes/Mvc/Controller/Arguments.php.

References elseif, and Arguments\getArgumentNames().

addArgument ( Argument  $argument)

Adds the specified controller argument to this composite object. If an argument with the same name exists already, it will be replaced by the new argument object.

Note that the argument will be cloned, not referenced.

Parameters
Argument$argumentThe argument to add
Returns
void

Definition at line 162 of file extbase/Classes/Mvc/Controller/Arguments.php.

References Arguments\offsetSet().

append (   $value)

Sets an argument, aliased to offsetSet()

Parameters
mixed$valueThe value
Exceptions
\InvalidArgumentExceptionif the argument is not a valid Controller Argument object
Returns
void

Definition at line 79 of file extbase/Classes/Mvc/Controller/Arguments.php.

References Arguments\offsetSet().

getArgument (   $argumentName)

Returns an argument specified by name

Parameters
string$argumentNameName of the argument to retrieve
Returns
Argument
Exceptions
\TYPO3\CMS\Extbase\Mvc\Exception\NoSuchArgumentException

Definition at line 174 of file extbase/Classes/Mvc/Controller/Arguments.php.

References Arguments\offsetExists(), and Arguments\offsetGet().

getArgumentNames ( )

Returns the names of all arguments contained in this object

Returns
array Argument names

Definition at line 199 of file extbase/Classes/Mvc/Controller/Arguments.php.

Referenced by Arguments\__call().

hasArgument (   $argumentName)

Checks if an argument with the specified name exists

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

Definition at line 189 of file extbase/Classes/Mvc/Controller/Arguments.php.

References Arguments\offsetExists().

injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface  $objectManager)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface$objectManager

Definition at line 40 of file extbase/Classes/Mvc/Controller/Arguments.php.

References Arguments\$objectManager.

offsetExists (   $offset)

Returns whether the requested index exists

Parameters
mixed$offsetOffset
Returns
bool

Definition at line 109 of file extbase/Classes/Mvc/Controller/Arguments.php.

Referenced by Arguments\getArgument(), and Arguments\hasArgument().

offsetGet (   $offset)

Returns the value at the specified index

Parameters
mixed$offsetOffset
Returns
Argument The requested argument object
Exceptions
\TYPO3\CMS\Extbase\Mvc\Exception\NoSuchArgumentExceptionif the argument does not exist

Definition at line 122 of file extbase/Classes/Mvc/Controller/Arguments.php.

Referenced by Arguments\getArgument().

offsetSet (   $offset,
  $value 
)

Adds or replaces the argument specified by $value. The argument's name is taken from the argument object itself, therefore the $offset does not have any meaning in this context.

Parameters
mixed$offsetOffset - not used here
mixed$valueThe argument
Exceptions
\InvalidArgumentExceptionif the argument is not a valid Controller Argument object
Returns
void

Definition at line 62 of file extbase/Classes/Mvc/Controller/Arguments.php.

Referenced by Arguments\addArgument(), and Arguments\append().

offsetUnset (   $offset)

Unsets an argument

Parameters
mixed$offsetOffset
Returns
void

Definition at line 93 of file extbase/Classes/Mvc/Controller/Arguments.php.

removeAll ( )

Remove all arguments and resets this object

Returns
void

Definition at line 273 of file extbase/Classes/Mvc/Controller/Arguments.php.

Member Data Documentation

$argumentNames = array()
protected

Definition at line 30 of file extbase/Classes/Mvc/Controller/Arguments.php.

$argumentShortNames = array()
protected

Definition at line 35 of file extbase/Classes/Mvc/Controller/Arguments.php.

$objectManager
protected