EnumConverter
class \
- Extends
- AbstractTypeConverter
Converter which transforms strings/integers/floats to Enum Instance.
Table of Contents
Properties
- $priority : int
- The priority for this converter.
- $sourceTypes : string[]
- The source types this converter can convert.
- $targetType : string
- The target type this converter can convert to.
Methods
- canConvertFrom() : bool
- Only convert if target is enum
- convertFrom() : T|null
- Convert an enum from $source to an enum.
- getPriority() : int
- Return the priority of this TypeConverter. TypeConverters with a high priority are chosen before low priority.
- getSourceChildPropertiesToBeConverted() : array
- Return a list of sub-properties inside the source object.
- getSupportedSourceTypes() : string[]
- Returns the list of source types the TypeConverter can handle.
- getSupportedTargetType() : string
- Return the target type this TypeConverter converts to.
- getTargetTypeForSource() : string
- Returns the type for a given source, depending on e.g. the __type setting or other properties.
- getTypeOfChildProperty() : string
- Return the type of a given sub-property inside the $targetType
- getEnumElement() : T|null
Properties
$priority
The priority for this converter.
Deprecated
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
protected
int
$priority
$sourceTypes
The source types this converter can convert.
Deprecated
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
protected
string[]
$sourceTypes
= []
$targetType
The target type this converter can convert to.
Deprecated
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
protected
string
$targetType
= ''
Methods
canConvertFrom()
Only convert if target is enum
public
canConvertFrom(mixed $source, class-string $targetType) : bool
Parameters
- $source : mixed
-
the source data
-
$targetType
: class-string
Internal
only to be used within Extbase, not part of TYPO3 Core API.
Tags
Return values
boolconvertFrom()
Convert an enum from $source to an enum.
public
convertFrom(mixed $source, class-string $targetType[, array $convertedChildProperties = [] ][, PropertyMappingConfigurationInterface|null $configuration = null ]) : T|null
Parameters
- $source : mixed
-
$targetType
: class-string
- $convertedChildProperties : array = []
- $configuration : PropertyMappingConfigurationInterface|null = null
Internal
only to be used within Extbase, not part of TYPO3 Core API.
Tags
Return values
T|nullgetPriority()
Return the priority of this TypeConverter. TypeConverters with a high priority are chosen before low priority.
public
getPriority() : int
Deprecated
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
Return values
intgetSourceChildPropertiesToBeConverted()
Return a list of sub-properties inside the source object.
public
getSourceChildPropertiesToBeConverted(mixed $source) : array
Parameters
- $source : mixed
Tags
Return values
arraygetSupportedSourceTypes()
Returns the list of source types the TypeConverter can handle.
public
getSupportedSourceTypes() : string[]
Deprecated
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
Must be PHP simple types, classes or object is not allowed.
Return values
string[]getSupportedTargetType()
Return the target type this TypeConverter converts to.
public
getSupportedTargetType() : string
Deprecated
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
Can be a simple type or a class name.
Return values
stringgetTargetTypeForSource()
Returns the type for a given source, depending on e.g. the __type setting or other properties.
public
getTargetTypeForSource(mixed $source, string $originalTargetType[, PropertyMappingConfigurationInterface|null $configuration = null ]) : string
Parameters
- $source : mixed
-
the source data
- $originalTargetType : string
-
the type we originally want to convert to
- $configuration : PropertyMappingConfigurationInterface|null = null
Tags
Return values
stringgetTypeOfChildProperty()
Return the type of a given sub-property inside the $targetType
public
getTypeOfChildProperty(string $targetType, string $propertyName, PropertyMappingConfigurationInterface $configuration) : string
Parameters
- $targetType : string
- $propertyName : string
- $configuration : PropertyMappingConfigurationInterface
Tags
Return values
string —the type of $propertyName in $targetType
getEnumElement()
protected
getEnumElement(float|int|string $source, class-string $targetType) : T|null
Parameters
- $source : float|int|string
-
$targetType
: class-string