PHP Класс Neos\Flow\Mvc\Controller\Argument

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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