AbstractTypeConverter

abstract class \TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter

Implements
TypeConverterInterface

Type converter which provides sensible default implementations for most methods. If you extend this class you only need to implement convertFrom()

Table of Contents

Interfaces

TypeConverterInterface
Interface for type converters, which can convert from a simple type to an object or another simple type.

Methods

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

Methods

getSourceChildPropertiesToBeConverted()

Return a list of sub-properties inside the source object.

public getSourceChildPropertiesToBeConverted(mixed $source) : array

Parameters

$source : mixed

Tags

todo

this method is only used for converter sources that have children (i.e. objects). Introduce another ChildPropertyAwareTypeConverterInterface and drop this method from the main interface

Returns an empty list of sub property names

Return values

array

getTargetTypeForSource()

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

todo

The concept of this method is flawed because it enables the override of the target type depending on the structure of the source. So, technically we no longer convert type A to B but source of type A with structure X to type B defined by X. This makes a type converter non-deterministic.

Returns the $originalTargetType unchanged in this implementation.

Return values

string

getTypeOfChildProperty()

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

todo

this method is only used for converter sources that have children (i.e. objects). Introduce another ChildPropertyAwareTypeConverterInterface and drop this method from the main interface

This method is never called, as getSourceChildPropertiesToBeConverted() returns an empty array.

Return values

string —

the type of $propertyName in $targetType

On this page