PHP 클래스 Neos\Flow\Mvc\Controller\Arguments

상속: extends ArrayObject
파일 보기 프로젝트 열기: neos/flow-development-collection 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$argumentNames array Names of the arguments contained by this object

공개 메소드들

메소드 설명
__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

보호된 메소드들

메소드 설명
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.

메소드 상세

__call() 공개 메소드

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
리턴 void

addArgument() 공개 메소드

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
리턴 void

addNewArgument() 공개 메소드

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
리턴 Argument The new argument

append() 공개 메소드

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

getArgument() 공개 메소드

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

getArgumentNames() 공개 메소드

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

getValidationResults() 공개 메소드

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

hasArgument() 공개 메소드

Checks if an argument with the specified name exists
또한 보기: offsetExists()
public hasArgument ( string $argumentName ) : boolean
$argumentName string Name of the argument to check for
리턴 boolean TRUE if such an argument exists, otherwise FALSE

offsetExists() 공개 메소드

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

offsetGet() 공개 메소드

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

offsetSet() 공개 메소드

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.
리턴 void

offsetUnset() 공개 메소드

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

removeAll() 공개 메소드

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

validateArgumentExistence() 보호된 메소드

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
리턴 string long argument name or empty string

프로퍼티 상세

$argumentNames 보호되어 있는 프로퍼티

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