Argument
A controller argument
Table of Contents
Properties
- $dataType : string
- $defaultValue : mixed
- Default value. Used if argument is optional.
- $fileHandlingServiceConfiguration : FileHandlingServiceConfiguration
- $isRequired : bool
- $name : string
- $propertyMappingConfiguration : MvcPropertyMappingConfiguration
- $shortName : string
- $uploadedFiles : array<string, UploadedFileInterface|array<int, UploadedFileInterface>>
- Uploaded files for the argument
- $validationResults : Result
- The validation results. This can be asked if the argument has errors.
- $validator : ValidatorInterface|null
- A custom validator, used supplementary to the base validation
- $value : mixed
Methods
- __construct() : mixed
- Constructs this controller argument
- __toString() : string
- Returns a string representation of this argument's value
- getDataType() : string
- getDefaultValue() : mixed
- getFileHandlingServiceConfiguration() : FileHandlingServiceConfiguration
- Return the FileHandlingServiceConfiguration used for this argument; can be used by the initialize*action to modify the file upload configuration for properties.
- getName() : string
- getPropertyMappingConfiguration() : MvcPropertyMappingConfiguration
- Return the Property Mapping Configuration used for this argument; can be used by the initialize*action to modify the Property Mapping.
- getShortName() : string
- getUploadedFiles() : array<string|int, mixed>
- getUploadedFilesForProperty() : array<int, UploadedFileInterface>
- Returns an array of possible UploadedFile objects for the given property
- getValidationResults() : Result
- getValidator() : ValidatorInterface|null
- getValue() : mixed
- isRequired() : bool
- isValid() : bool
- setDefaultValue() : Argument
- setRequired() : Argument
- setShortName() : Argument
- setUploadedFiles() : void
- setValidator() : Argument
- Sets a custom validator which is used supplementary to the base validation
- setValue() : Argument
- validate() : Result
Properties
$dataType
protected
string
$dataType
= ''
$defaultValue
Default value. Used if argument is optional.
protected
mixed
$defaultValue
= null
$fileHandlingServiceConfiguration
protected
FileHandlingServiceConfiguration
$fileHandlingServiceConfiguration
$isRequired
protected
bool
$isRequired
= false
$name
protected
string
$name
= ''
$propertyMappingConfiguration
protected
MvcPropertyMappingConfiguration
$propertyMappingConfiguration
$shortName
protected
string
$shortName
= ''
$uploadedFiles
Uploaded files for the argument
protected
array<string, UploadedFileInterface|array<int, UploadedFileInterface>>
$uploadedFiles
= []
$validationResults
The validation results. This can be asked if the argument has errors.
protected
Result
$validationResults
$validator
A custom validator, used supplementary to the base validation
protected
ValidatorInterface|null
$validator
= null
$value
protected
mixed
$value
= null
Methods
__construct()
Constructs this controller argument
public
__construct(string $name, string $dataType) : mixed
Parameters
- $name : string
- $dataType : string
Tags
__toString()
Returns a string representation of this argument's value
public
__toString() : string
Return values
stringgetDataType()
public
getDataType() : string
Return values
stringgetDefaultValue()
public
getDefaultValue() : mixed
getFileHandlingServiceConfiguration()
Return the FileHandlingServiceConfiguration used for this argument; can be used by the initialize*action to modify the file upload configuration for properties.
public
getFileHandlingServiceConfiguration() : FileHandlingServiceConfiguration
Return values
FileHandlingServiceConfigurationgetName()
public
getName() : string
Return values
stringgetPropertyMappingConfiguration()
Return the Property Mapping Configuration used for this argument; can be used by the initialize*action to modify the Property Mapping.
public
getPropertyMappingConfiguration() : MvcPropertyMappingConfiguration
Return values
MvcPropertyMappingConfigurationgetShortName()
public
getShortName() : string
Return values
stringgetUploadedFiles()
public
getUploadedFiles() : array<string|int, mixed>
Return values
array<string|int, mixed>getUploadedFilesForProperty()
Returns an array of possible UploadedFile objects for the given property
public
getUploadedFilesForProperty(string $propertyName) : array<int, UploadedFileInterface>
Parameters
- $propertyName : string
Return values
array<int, UploadedFileInterface>getValidationResults()
public
getValidationResults() : Result
only to be used within Extbase, not part of TYPO3 Core API.
Return values
ResultgetValidator()
public
getValidator() : ValidatorInterface|null
Return values
ValidatorInterface|nullgetValue()
public
getValue() : mixed
isRequired()
public
isRequired() : bool
Return values
boolisValid()
public
isValid() : bool
Return values
bool —TRUE if the argument is valid, FALSE otherwise
setDefaultValue()
public
setDefaultValue(mixed $defaultValue) : Argument
Parameters
- $defaultValue : mixed
Return values
ArgumentsetRequired()
public
setRequired(bool $required) : Argument
Parameters
- $required : bool
Return values
ArgumentsetShortName()
public
setShortName(string $shortName) : Argument
Parameters
- $shortName : string
Tags
Return values
ArgumentsetUploadedFiles()
public
setUploadedFiles(array<string|int, mixed> $uploadedFiles) : void
Parameters
- $uploadedFiles : array<string|int, mixed>
setValidator()
Sets a custom validator which is used supplementary to the base validation
public
setValidator(ValidatorInterface $validator) : Argument
Parameters
- $validator : ValidatorInterface
Return values
ArgumentsetValue()
public
setValue(mixed $rawValue) : Argument
Parameters
- $rawValue : mixed
Return values
Argumentvalidate()
public
validate() : Result