TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter:

Public Member Functions
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	getSupportedSourceTypes ()
	getSupportedTargetType ()
	getTargetTypeForSource ($source, $originalTargetType, \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration=null)
	getPriority ()
	canConvertFrom ($source, $targetType)
	getSourceChildPropertiesToBeConverted ($source)
	getTypeOfChildProperty ($targetType, $propertyName, \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration)
Public Member Functions inherited from TYPO3\CMS\Extbase\Property\TypeConverterInterface
	getTargetTypeForSource ($source, $originalTargetType, PropertyMappingConfigurationInterface $configuration=null)
	convertFrom ($source, $targetType, array $convertedChildProperties=[], \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration=null)

Protected Attributes
	$sourceTypes = []
	$targetType = ''
	$priority
	$objectManager

Detailed Description

Type converter which provides sensible default implementations for most methods. If you extend this class you only need to do the following:

• set $sourceTypes
• set $targetType
• set $priority
• implement convertFrom()

Definition at line 33 of file AbstractTypeConverter.php.

Member Function Documentation

canConvertFrom()

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::canConvertFrom	(		$source,
			$targetType
	)

This implementation always returns TRUE for this method.

Parameters

mixed	$source	the source data
string	$targetType	the type to convert to.

Returns

bool TRUE if this TypeConverter can convert from $source to $targetType, FALSE otherwise.

Implements TYPO3\CMS\Extbase\Property\TypeConverterInterface.

Definition at line 129 of file AbstractTypeConverter.php.

getPriority()

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::getPriority

(

)

Return the priority of this TypeConverter. TypeConverters with a high priority are chosen before low priority.

Returns

int

Implements TYPO3\CMS\Extbase\Property\TypeConverterInterface.

Definition at line 116 of file AbstractTypeConverter.php.

References TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter\$priority.

getSourceChildPropertiesToBeConverted()

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::getSourceChildPropertiesToBeConverted

(

$source

)

Returns an empty list of sub property names

Parameters

mixed

$source

Returns

array

Implements TYPO3\CMS\Extbase\Property\TypeConverterInterface.

Definition at line 141 of file AbstractTypeConverter.php.

getSupportedSourceTypes()

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::getSupportedSourceTypes

(

)

Returns the list of source types the TypeConverter can handle. Must be PHP simple types, classes or object is not allowed.

Returns

array<string>

Implements TYPO3\CMS\Extbase\Property\TypeConverterInterface.

Definition at line 79 of file AbstractTypeConverter.php.

References TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter\$sourceTypes.

getSupportedTargetType()

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::getSupportedTargetType

(

)

Return the target type this TypeConverter converts to. Can be a simple type or a class name.

Returns

string

Implements TYPO3\CMS\Extbase\Property\TypeConverterInterface.

Definition at line 91 of file AbstractTypeConverter.php.

References TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter\$targetType.

getTargetTypeForSource()

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::getTargetTypeForSource	(		$source,
			$originalTargetType,
		\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface	$configuration = null
	)

Returns the $originalTargetType unchanged in this implementation.

Parameters

mixed	$source	the source data
string	$originalTargetType	the type we originally want to convert to
\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface	$configuration

Returns

string

Definition at line 105 of file AbstractTypeConverter.php.

getTypeOfChildProperty()

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::getTypeOfChildProperty	(		$targetType,
			$propertyName,
		\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface	$configuration
	)

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

Parameters

string	$targetType
string	$propertyName
\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface	$configuration

Implements TYPO3\CMS\Extbase\Property\TypeConverterInterface.

Definition at line 154 of file AbstractTypeConverter.php.

injectObjectManager()

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::injectObjectManager

(

\TYPO3\CMS\Extbase\Object\ObjectManagerInterface

$objectManager

)

Parameters

\TYPO3\CMS\Extbase\Object\ObjectManagerInterface

$objectManager

Definition at line 67 of file AbstractTypeConverter.php.

References TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter\$objectManager.

Member Data Documentation

$objectManager

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::$objectManager

protected

Definition at line 62 of file AbstractTypeConverter.php.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter\injectObjectManager().

$priority

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::$priority

protected

Definition at line 57 of file AbstractTypeConverter.php.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter\getPriority().

$sourceTypes

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::$sourceTypes = []

protected

Definition at line 41 of file AbstractTypeConverter.php.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter\getSupportedSourceTypes().

$targetType

TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter::$targetType = ''

protected

Definition at line 49 of file AbstractTypeConverter.php.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter\getSupportedTargetType(), TYPO3\CMS\Extbase\Property\TypeConverter\AbstractFileCollectionConverter\injectFileFactory(), and TYPO3\CMS\Extbase\Property\TypeConverter\AbstractFileFolderConverter\injectFileFactory().