ObjectStorageConverter extends AbstractTypeConverter
Converter which transforms simple types to an ObjectStorage.
Table of Contents
Properties
- $priority : int
- The priority for this converter.
- $sourceTypes : array<string|int, string>
- The source types this converter can convert.
- $targetType : string
- The target type this converter can convert to.
Methods
- canConvertFrom() : bool
- convertFrom() : mixed|Error
- Actually convert from $source to $targetType, taking into account the fully built $convertedChildProperties and $configuration.
- getPriority() : int
- Return the priority of this TypeConverter. TypeConverters with a high priority are chosen before low priority.
- getSourceChildPropertiesToBeConverted() : array<string|int, mixed>
- Returns the source, if it is an array, otherwise an empty array.
- getSupportedSourceTypes() : array<string|int, 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
Properties
$priority
The priority for this converter.
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
protected
int
$priority
= 10
$sourceTypes
The source types this converter can convert.
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
protected
array<string|int, string>
$sourceTypes
= ['string', 'array']
$targetType
The target type this converter can convert to.
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
protected
string
$targetType
= \TYPO3\CMS\Extbase\Persistence\ObjectStorage::class
Methods
canConvertFrom()
public
canConvertFrom(mixed $source, string $targetType) : bool
will be removed in TYPO3 v13.0
Parameters
- $source : mixed
-
the source data
- $targetType : string
Return values
boolconvertFrom()
Actually convert from $source to $targetType, taking into account the fully built $convertedChildProperties and $configuration.
public
convertFrom(mixed $source, string $targetType[, array<string|int, mixed> $convertedChildProperties = [] ][, PropertyMappingConfigurationInterface|null $configuration = null ]) : mixed|Error
Parameters
- $source : mixed
- $targetType : string
- $convertedChildProperties : array<string|int, mixed> = []
- $configuration : PropertyMappingConfigurationInterface|null = null
Return values
mixed|Error —the target type, or an error object if a user-error occurred
getPriority()
Return the priority of this TypeConverter. TypeConverters with a high priority are chosen before low priority.
public
getPriority() : int
will be removed in TYPO3 v13.0, as this is defined in Services.yaml.
Return values
intgetSourceChildPropertiesToBeConverted()
Returns the source, if it is an array, otherwise an empty array.
public
getSourceChildPropertiesToBeConverted(mixed $source) : array<string|int, mixed>
Parameters
- $source : mixed
Return values
array<string|int, mixed>getSupportedSourceTypes()
Returns the list of source types the TypeConverter can handle.
public
getSupportedSourceTypes() : array<string|int, string>
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
array<string|int, string>getSupportedTargetType()
Return the target type this TypeConverter converts to.
public
getSupportedTargetType() : string
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
Return values
string —the type of $propertyName in $targetType