TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface Interface Reference

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

Public Member Functions
bool	shouldSkip ($propertyName)
bool	shouldSkipUnknownProperties ()
TYPO3 CMS Extbase Property PropertyMappingConfigurationInterface	getConfigurationFor ($propertyName)
string	getTargetPropertyName ($sourcePropertyName)
mixed	getConfigurationValue ($typeConverterClassName, $key)
TYPO3 CMS Extbase Property TypeConverterInterface null	getTypeConverter ()

Detailed Description

Configuration object for the property mapper.

Definition at line 21 of file PropertyMappingConfigurationInterface.php.

Member Function Documentation

getConfigurationFor()

TYPO3 CMS Extbase Property PropertyMappingConfigurationInterface TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface::getConfigurationFor

(

$propertyName

)

Returns the sub-configuration for the passed $propertyName. Must ALWAYS return a valid configuration object!

Parameters

string

$propertyName

Returns

‪\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface the property mapping configuration for the given $propertyName.

Implemented in TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\ObjectConverter\getTypeOfChildProperty(), and TYPO3\CMS\Extbase\Property\TypeConverter\PersistentObjectConverter\getTypeOfChildProperty().

getConfigurationValue()

mixed TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface::getConfigurationValue	(		$typeConverterClassName,
			$key
	)

Parameters

string	$typeConverterClassName
string	$key

Returns

‪mixed configuration value for the specific $typeConverterClassName. Can be used by Type Converters to fetch converter-specific configuration

Implemented in TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\ObjectConverter\getTypeOfChildProperty(), TYPO3\CMS\Extbase\Property\TypeConverter\PersistentObjectConverter\getTypeOfChildProperty(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\importUploadedResource().

getTargetPropertyName()

string TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface::getTargetPropertyName

(

$sourcePropertyName

)

Maps the given $sourcePropertyName to a target property name. Can be used to rename properties from source to target.

Parameters

string

$sourcePropertyName

Returns

‪string property name of target

Implemented in TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration.

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

getTypeConverter()

TYPO3 CMS Extbase Property TypeConverterInterface null TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface::getTypeConverter

(

)

This method can be used to explicitly force a TypeConverter to be used for this Configuration.

Returns

‪\TYPO3\CMS\Extbase\Property\TypeConverterInterface|null The type converter to be used for this particular PropertyMappingConfiguration, or NULL if the system-wide configured type converter should be used.

Implemented in TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration.

shouldSkip()

bool TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface::shouldSkip

(

$propertyName

)

returns TRUE if the given propertyName should be mapped, FALSE otherwise.

Parameters

string

$propertyName

Returns

‪bool

Implemented in TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration.

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

shouldSkipUnknownProperties()

bool TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface::shouldSkipUnknownProperties

(

)

Whether unknown (unconfigured) properties should be skipped during mapping, instead if causing an error.

Returns

‪bool

Implemented in TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration.

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