EnumConverter
class \
- Extends
- AbstractTypeConverter
Converter which transforms strings/integers/floats to Enum Instance.
Table of Contents
Methods
- convertFrom() : T|null
- Convert an enum from $source to an enum.
- getSourceChildPropertiesToBeConverted() : array
- Return a list of sub-properties inside the source object.
- 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
Methods
convertFrom()
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|nullgetSourceChildPropertiesToBeConverted()
Return a list of sub-properties inside the source object.
public
getSourceChildPropertiesToBeConverted(mixed $source) : array
Parameters
- $source : mixed
Tags
Return values
arraygetTargetTypeForSource()
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