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

Public Member Functions
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)

	injectConfigurationBuilder (\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationBuilder $configurationBuilder)

	initializeObject ()

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

	getMessages ()

	parseCompositeType ($compositeType)

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

	findTypeConverter ($source, $targetType, PropertyMappingConfigurationInterface $configuration)

	findFirstEligibleTypeConverterInObjectHierarchy ($source, $sourceType, $targetClass)

	getConvertersForInterfaces (array $convertersForSource, array $interfaceNames)

	determineSourceType ($source)

Protected Attributes
	$objectManager

	$configurationBuilder

	$typeConverters = []

	$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.

http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later

Definition at line 34 of file PropertyMapper.php.

Member Function Documentation

◆ convert()

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 111 of file PropertyMapper.php.

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

◆ determineSourceType()

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 356 of file PropertyMapper.php.

◆ doMapping()

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 154 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().

◆ findFirstEligibleTypeConverterInObjectHierarchy()

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 263 of file PropertyMapper.php.

◆ findTypeConverter()

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 218 of file PropertyMapper.php.

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

◆ getConvertersForInterfaces()

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

protected

Parameters

array	$convertersForSource
array	$interfaceNames

Returns: array

Exceptions

Exception

Definition at line 333 of file PropertyMapper.php.

◆ getMessages()

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

Get the messages of the last Property Mapping

Returns

Definition at line 138 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 88 of file PropertyMapper.php.

References $GLOBALS.

◆ injectConfigurationBuilder()

TYPO3\CMS\Extbase\Property\PropertyMapper::injectConfigurationBuilder ( \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationBuilder $configurationBuilder )

Parameters

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

Definition at line 76 of file PropertyMapper.php.

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

◆ injectObjectManager()

TYPO3\CMS\Extbase\Property\PropertyMapper::injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager )

Parameters

\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager

Definition at line 68 of file PropertyMapper.php.

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

◆ parseCompositeType()

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

Parse a composite type like <> into

Parameters

string $compositeType

Returns: string

Definition at line 380 of file PropertyMapper.php.

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

Member Data Documentation

◆ $configurationBuilder

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

protected

Definition at line 44 of file PropertyMapper.php.

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

◆ $messages

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

protected

Definition at line 63 of file PropertyMapper.php.

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

◆ $objectManager

TYPO3\CMS\Extbase\Property\PropertyMapper::$objectManager

protected

Definition at line 39 of file PropertyMapper.php.

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

◆ $typeConverters

TYPO3\CMS\Extbase\Property\PropertyMapper::$typeConverters = []

protected

Definition at line 56 of file PropertyMapper.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ convert()

◆ determineSourceType()

◆ doMapping()

◆ findFirstEligibleTypeConverterInObjectHierarchy()

◆ findTypeConverter()

◆ getConvertersForInterfaces()

◆ getMessages()

◆ initializeObject()

◆ injectConfigurationBuilder()

◆ injectObjectManager()

◆ parseCompositeType()

Member Data Documentation

◆ $configurationBuilder

◆ $messages

◆ $objectManager

◆ $typeConverters