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

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

보호된 프로퍼티들

프로퍼티 타입 설명
$dataType string Data type of this argument's value
$defaultValue mixed Default value. Used if argument is optional.
$isRequired boolean TRUE if this argument is required
$name string Name of this argument
$propertyMapper Neos\Flow\Property\PropertyMapper
$propertyMappingConfiguration MvcPropertyMappingConfiguration
$validationResults Neos\Error\Messages\Result The validation results. This can be asked if the argument has errors.
$validator Neos\Flow\Validation\Validator\ValidatorInterface A custom validator, used supplementary to the base validation
$value object Actual value of this argument

공개 메소드들

메소드 설명
__construct ( string $name, string $dataType ) Constructs this controller argument
getDataType ( ) : string Returns the data type of this argument's value
getDefaultValue ( ) : mixed Returns the default value of this argument
getName ( ) : string Returns the name of this argument
getPropertyMappingConfiguration ( ) : MvcPropertyMappingConfiguration Return the Property Mapping Configuration used for this argument; can be used by the initialize*action to modify the Property Mapping.
getValidationResults ( ) : array
getValidator ( ) : Neos\Flow\Validation\Validator\ValidatorInterface Returns the set validator
getValue ( ) : object Returns the value of this argument. If the value is NULL, we use the defaultValue.
isRequired ( ) : boolean Returns TRUE if this argument is required
isValid ( ) : boolean
setDefaultValue ( mixed $defaultValue ) : Argument Sets the default value of the argument
setRequired ( boolean $required ) : Argument Marks this argument to be required
setValidator ( Neos\Flow\Validation\Validator\ValidatorInterface $validator ) : Argument Sets a custom validator which is used supplementary to the base validation
setValue ( mixed $rawValue ) : Argument Sets the value of this argument.

메소드 상세

__construct() 공개 메소드

Constructs this controller argument
public __construct ( string $name, string $dataType )
$name string Name of this argument
$dataType string The data type of this argument

getDataType() 공개 메소드

Returns the data type of this argument's value
public getDataType ( ) : string
리턴 string The data type

getDefaultValue() 공개 메소드

Returns the default value of this argument
public getDefaultValue ( ) : mixed
리턴 mixed The default value

getName() 공개 메소드

Returns the name of this argument
public getName ( ) : string
리턴 string This argument's name

getPropertyMappingConfiguration() 공개 메소드

Return the Property Mapping Configuration used for this argument; can be used by the initialize*action to modify the Property Mapping.
public getPropertyMappingConfiguration ( ) : MvcPropertyMappingConfiguration
리턴 MvcPropertyMappingConfiguration

getValidationResults() 공개 메소드

public getValidationResults ( ) : array
리턴 array

getValidator() 공개 메소드

Returns the set validator
public getValidator ( ) : Neos\Flow\Validation\Validator\ValidatorInterface
리턴 Neos\Flow\Validation\Validator\ValidatorInterface The set validator, NULL if none was set

getValue() 공개 메소드

Returns the value of this argument. If the value is NULL, we use the defaultValue.
public getValue ( ) : object
리턴 object The value of this argument - if none was set, the default value is returned

isRequired() 공개 메소드

Returns TRUE if this argument is required
public isRequired ( ) : boolean
리턴 boolean TRUE if this argument is required

isValid() 공개 메소드

사용 중단: Will be removed for next major Flow version.
public isValid ( ) : boolean
리턴 boolean TRUE if the argument is valid, FALSE otherwise

setDefaultValue() 공개 메소드

Sets the default value of the argument
public setDefaultValue ( mixed $defaultValue ) : Argument
$defaultValue mixed Default value
리턴 Argument $this

setRequired() 공개 메소드

Marks this argument to be required
public setRequired ( boolean $required ) : Argument
$required boolean TRUE if this argument should be required
리턴 Argument $this

setValidator() 공개 메소드

Sets a custom validator which is used supplementary to the base validation
public setValidator ( Neos\Flow\Validation\Validator\ValidatorInterface $validator ) : Argument
$validator Neos\Flow\Validation\Validator\ValidatorInterface The actual validator object
리턴 Argument Returns $this (used for fluent interface)

setValue() 공개 메소드

Sets the value of this argument.
public setValue ( mixed $rawValue ) : Argument
$rawValue mixed The value of this argument
리턴 Argument $this

프로퍼티 상세

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

Data type of this argument's value
protected string $dataType
리턴 string

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

Default value. Used if argument is optional.
protected mixed $defaultValue
리턴 mixed

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

TRUE if this argument is required
protected bool $isRequired
리턴 boolean

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

Name of this argument
protected string $name
리턴 string

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

protected PropertyMapper,Neos\Flow\Property $propertyMapper
리턴 Neos\Flow\Property\PropertyMapper

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

protected MvcPropertyMappingConfiguration,Neos\Flow\Mvc\Controller $propertyMappingConfiguration
리턴 MvcPropertyMappingConfiguration

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

The validation results. This can be asked if the argument has errors.
protected Result,Neos\Error\Messages $validationResults
리턴 Neos\Error\Messages\Result

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

A custom validator, used supplementary to the base validation
protected ValidatorInterface,Neos\Flow\Validation\Validator $validator
리턴 Neos\Flow\Validation\Validator\ValidatorInterface

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

Actual value of this argument
protected object $value
리턴 object