PHP Class Neos\Flow\Mvc\Controller\Arguments

Inheritance: extends ArrayObject
Mostra file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$argumentNames array Names of the arguments contained by this object

Public Methods

Method Description
__call ( string $methodName, array $arguments ) : void Magic setter method for the argument values. Each argument value can be set by just calling the setArgumentName() method.
addArgument ( Argument $argument ) : void Adds the specified controller argument to this composite object.
addNewArgument ( string $name, string $dataType = 'string', boolean $isRequired = true, mixed $defaultValue = null ) : Argument Creates, adds and returns a new controller argument to this composite object.
append ( mixed $value ) : void Sets an argument, aliased to offsetSet()
getArgument ( string $argumentName ) : Argument Returns an argument specified by name
getArgumentNames ( ) : array Returns the names of all arguments contained in this object
getValidationResults ( ) : Neos\Error\Messages\Result Get all property mapping / validation errors
hasArgument ( string $argumentName ) : boolean Checks if an argument with the specified name exists
offsetExists ( mixed $offset ) : boolean Returns whether the requested index exists
offsetGet ( mixed $offset ) : Argument Returns the value at the specified index
offsetSet ( mixed $offset, mixed $value ) : void 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.
offsetUnset ( mixed $offset ) : void Unsets an argument
removeAll ( ) : void Remove all arguments and resets this object

Protected Methods

Method Description
validateArgumentExistence ( string $argumentName ) : string Translates a short argument name to its corresponding long name. If the specified argument name is a real argument name already, it will be returned again.

Method Details

__call() public method

Magic setter method for the argument values. Each argument value can be set by just calling the setArgumentName() method.
public __call ( string $methodName, array $arguments ) : void
$methodName string Name of the method
$arguments array Method arguments
return void

addArgument() public method

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.
public addArgument ( Argument $argument ) : void
$argument Argument The argument to add
return void

addNewArgument() public method

If an argument with the same name exists already, it will be replaced by the new argument object.
public addNewArgument ( string $name, string $dataType = 'string', boolean $isRequired = true, mixed $defaultValue = null ) : Argument
$name string Name of the argument
$dataType string Name of one of the built-in data types
$isRequired boolean TRUE if this argument should be marked as required
$defaultValue mixed Default value of the argument. Only makes sense if $isRequired==FALSE
return Argument The new argument

append() public method

Sets an argument, aliased to offsetSet()
public append ( mixed $value ) : void
$value mixed The value
return void

getArgument() public method

Returns an argument specified by name
public getArgument ( string $argumentName ) : Argument
$argumentName string Name of the argument to retrieve
return Argument

getArgumentNames() public method

Returns the names of all arguments contained in this object
public getArgumentNames ( ) : array
return array Argument names

getValidationResults() public method

Get all property mapping / validation errors
public getValidationResults ( ) : Neos\Error\Messages\Result
return Neos\Error\Messages\Result

hasArgument() public method

Checks if an argument with the specified name exists
See also: offsetExists()
public hasArgument ( string $argumentName ) : boolean
$argumentName string Name of the argument to check for
return boolean TRUE if such an argument exists, otherwise FALSE

offsetExists() public method

Returns whether the requested index exists
public offsetExists ( mixed $offset ) : boolean
$offset mixed Offset
return boolean

offsetGet() public method

Returns the value at the specified index
public offsetGet ( mixed $offset ) : Argument
$offset mixed Offset
return Argument The requested argument object

offsetSet() public method

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.
public offsetSet ( mixed $offset, mixed $value ) : void
$offset mixed Offset - not used here
$value mixed The argument.
return void

offsetUnset() public method

Unsets an argument
public offsetUnset ( mixed $offset ) : void
$offset mixed Offset
return void

removeAll() public method

Remove all arguments and resets this object
public removeAll ( ) : void
return void

validateArgumentExistence() protected method

If an argument with the specified name or short name does not exist, an empty string is returned.
protected validateArgumentExistence ( string $argumentName ) : string
$argumentName string argument name
return string long argument name or empty string

Property Details

$argumentNames protected_oe property

Names of the arguments contained by this object
protected array $argumentNames
return array