Inheritance diagram for TYPO3\CMS\Extbase\Property\PropertyMapper:

Public Member Functions
	__construct (ContainerInterface $container, PropertyMappingConfigurationBuilder $configurationBuilder)

	initializeObject ()

mixed	convert ($source, $targetType, PropertyMappingConfigurationInterface $configuration=null)

TYPO3 CMS Extbase Error Result	getMessages ()

	resetMessages ()

string	parseCompositeType ($compositeType)

Protected Member Functions
mixed	doMapping ($source, $targetType, PropertyMappingConfigurationInterface $configuration, &$currentPropertyPath)

TYPO3 CMS Extbase Property TypeConverterInterface	findTypeConverter ($source, $targetType, PropertyMappingConfigurationInterface $configuration)

mixed	findFirstEligibleTypeConverterInObjectHierarchy ($source, $sourceType, $targetClass)

mixed	findEligibleConverterWithHighestPriority ($converters, $source, $targetType)

array	getConvertersForInterfaces (array $convertersForSource, array $interfaceNames)

string	determineSourceType ($source)

Protected Attributes
ContainerInterface	$container

PropertyMappingConfigurationBuilder	$configurationBuilder

array	$typeConverters = array( )

TYPO3 CMS Extbase Error Result	$messages

Detailed Description

The Property Mapper transforms simple types (arrays, strings, integers, floats, booleans) to objects or other simple types. It is used most prominently to map incoming HTTP arguments to objects.

Definition at line 38 of file PropertyMapper.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Property\PropertyMapper::__construct	(	ContainerInterface	$container,
		PropertyMappingConfigurationBuilder	$configurationBuilder
	)

Definition at line 60 of file PropertyMapper.php.

References TYPO3\CMS\Extbase\Property\PropertyMapper\$configurationBuilder, and TYPO3\CMS\Extbase\Property\PropertyMapper\$container.

Member Function Documentation

◆ convert()

mixed TYPO3\CMS\Extbase\Property\PropertyMapper::convert	(		$source,
			$targetType,
		PropertyMappingConfigurationInterface	$configuration = `null`
	)

Map $source to $targetType, and return the result

Parameters

mixed	$source	‪the source data to map. MUST be a simple type, NO object allowed!
string	$targetType	‪The type of the target; can be either a class name or a simple type.
PropertyMappingConfigurationInterface	$configuration	‪Configuration for the property mapping. If NULL, the PropertyMappingConfigurationBuilder will create a default configuration.

Exceptions

Exception

Returns: ‪mixed an instance of $targetType

Definition at line 104 of file PropertyMapper.php.

References TYPO3\CMS\Extbase\Property\PropertyMapper\doMapping().

◆ determineSourceType()

string TYPO3\CMS\Extbase\Property\PropertyMapper::determineSourceType ( $source )

protected

Determine the type of the source data, or throw an exception if source was an unsupported format.

Parameters

mixed $source

Exceptions

Exception

Definition at line 365 of file PropertyMapper.php.

◆ doMapping()

mixed TYPO3\CMS\Extbase\Property\PropertyMapper::doMapping	(		$source,
			$targetType,
		PropertyMappingConfigurationInterface	$configuration,
		&	$currentPropertyPath
	)

protected

Internal function which actually does the property mapping.

Parameters

mixed	$source	‪the source data to map. MUST be a simple type, NO object allowed!
string	$targetType	‪The type of the target; can be either a class name or a simple type.
PropertyMappingConfigurationInterface	$configuration	‪Configuration for the property mapping.
array	$currentPropertyPath	‪The property path currently being mapped; used for knowing the context in case an exception is thrown.

Exceptions

Exception

Definition at line 153 of file PropertyMapper.php.

References TYPO3\CMS\Extbase\Property\PropertyMapper\findTypeConverter(), TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface\getTargetPropertyName(), TYPO3\CMS\Extbase\Property\PropertyMapper\parseCompositeType(), TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface\shouldSkip(), and TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface\shouldSkipUnknownProperties().

Referenced by TYPO3\CMS\Extbase\Property\PropertyMapper\convert().

◆ findEligibleConverterWithHighestPriority()

mixed TYPO3\CMS\Extbase\Property\PropertyMapper::findEligibleConverterWithHighestPriority	(	$converters,
		$source,
		$targetType
	)

protected

Parameters

mixed	$converters
mixed	$source
string	$targetType

Returns: ‪mixed Either the matching object converter or NULL

Definition at line 319 of file PropertyMapper.php.

◆ findFirstEligibleTypeConverterInObjectHierarchy()

mixed TYPO3\CMS\Extbase\Property\PropertyMapper::findFirstEligibleTypeConverterInObjectHierarchy	(	$source,
		$sourceType,
		$targetClass
	)

protected

Tries to find a suitable type converter for the given source and target type.

Parameters

string	$source	‪The actual source value
string	$sourceType	‪Type of the source to convert from
string	$targetClass	‪Name of the target class to find a type converter for

Returns: ‪mixed Either the matching object converter or NULL

Exceptions

Exception

Definition at line 269 of file PropertyMapper.php.

◆ findTypeConverter()

TYPO3 CMS Extbase Property TypeConverterInterface TYPO3\CMS\Extbase\Property\PropertyMapper::findTypeConverter	(		$source,
			$targetType,
		PropertyMappingConfigurationInterface	$configuration
	)

protected

Determine the type converter to be used. If no converter has been found, an exception is raised.

Parameters

mixed	$source
string	$targetType
PropertyMappingConfigurationInterface	$configuration

Exceptions

Exception

Definition at line 221 of file PropertyMapper.php.

Referenced by TYPO3\CMS\Extbase\Property\PropertyMapper\doMapping().

◆ getConvertersForInterfaces()

array TYPO3\CMS\Extbase\Property\PropertyMapper::getConvertersForInterfaces	(	array	$convertersForSource,
		array	$interfaceNames
	)

protected

Parameters

array	$convertersForSource
array	$interfaceNames

Returns: ‪array

Exceptions

Exception

Definition at line 342 of file PropertyMapper.php.

◆ getMessages()

TYPO3 CMS Extbase Error Result TYPO3\CMS\Extbase\Property\PropertyMapper::getMessages ( )

Get the messages of the last Property Mapping.

Returns: ‪\TYPO3\CMS\Extbase\Error\Result

Definition at line 129 of file PropertyMapper.php.

References TYPO3\CMS\Extbase\Property\PropertyMapper\$messages.

◆ initializeObject()

TYPO3\CMS\Extbase\Property\PropertyMapper::initializeObject ( )

Lifecycle method, called after all dependencies have been injected. Here, the typeConverter array gets initialized.

Exceptions

Exception

Definition at line 75 of file PropertyMapper.php.

References $GLOBALS, and TYPO3\CMS\Extbase\Property\PropertyMapper\resetMessages().

◆ parseCompositeType()

string TYPO3\CMS\Extbase\Property\PropertyMapper::parseCompositeType ( $compositeType )

Parse a composite type like \Foo\Collection<\Bar\Entity> into \Foo\Collection

Parameters

string $compositeType

Returns: ‪string

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 393 of file PropertyMapper.php.

Referenced by TYPO3\CMS\Extbase\Property\PropertyMapper\doMapping().

◆ resetMessages()

TYPO3\CMS\Extbase\Property\PropertyMapper::resetMessages ( )

Resets the messages of the last Property Mapping.

Definition at line 137 of file PropertyMapper.php.

Referenced by TYPO3\CMS\Extbase\Property\PropertyMapper\initializeObject().

Member Data Documentation

◆ $configurationBuilder

PropertyMappingConfigurationBuilder TYPO3\CMS\Extbase\Property\PropertyMapper::$configurationBuilder

protected

Definition at line 41 of file PropertyMapper.php.

Referenced by TYPO3\CMS\Extbase\Property\PropertyMapper\__construct().

◆ $container

ContainerInterface TYPO3\CMS\Extbase\Property\PropertyMapper::$container

protected

Definition at line 40 of file PropertyMapper.php.

Referenced by TYPO3\CMS\Extbase\Property\PropertyMapper\__construct().

◆ $messages

TYPO3 CMS Extbase Error Result TYPO3\CMS\Extbase\Property\PropertyMapper::$messages

protected

A list of property mapping messages (errors, warnings) which have occurred on last mapping.

Definition at line 58 of file PropertyMapper.php.

Referenced by TYPO3\CMS\Extbase\Property\PropertyMapper\getMessages().

◆ $typeConverters

array TYPO3\CMS\Extbase\Property\PropertyMapper::$typeConverters = array( )

protected

A multi-dimensional array which stores the Type Converters available in the system. It has the following structure:

‪Dimension: Source Type
‪Dimension: Target Type
‪Dimension: Priority Value: Type Converter instance

Definition at line 52 of file PropertyMapper.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convert()

◆ determineSourceType()

◆ doMapping()

◆ findEligibleConverterWithHighestPriority()

◆ findFirstEligibleTypeConverterInObjectHierarchy()

◆ findTypeConverter()

◆ getConvertersForInterfaces()

◆ getMessages()

◆ initializeObject()

◆ parseCompositeType()

◆ resetMessages()

Member Data Documentation

◆ $configurationBuilder

◆ $container

◆ $messages

◆ $typeConverters