PropertyMappingConfigurationInterface
interface PropertyMappingConfigurationInterface (View source)
Configuration object for the property mapper. This interface specifies all methods which are used by the property mapper and by the type converters during the conversion process. Thus, this interface does only contain read-only methods, and no methods to set any of these options.
As developer, you should probably subclass the PropertyMappingConfiguration class if adjustments are needed there.
Methods
No description
Check if the given $propertyName should be skipped during mapping.
Whether unknown (unconfigured) properties should be skipped during mapping, instead if causing an error.
Returns the sub-configuration for the passed $propertyName. Must ALWAYS return a valid configuration object!
Maps the given $sourcePropertyName to a target property name.
No description
This method can be used to explicitely force a TypeConverter to be used for this Configuration.
Details
bool
shouldMap(string $propertyName)
No description
bool
shouldSkip(string $propertyName)
Check if the given $propertyName should be skipped during mapping.
bool
shouldSkipUnknownProperties()
Whether unknown (unconfigured) properties should be skipped during mapping, instead if causing an error.
PropertyMappingConfigurationInterface
getConfigurationFor(string $propertyName)
Returns the sub-configuration for the passed $propertyName. Must ALWAYS return a valid configuration object!
string
getTargetPropertyName(string $sourcePropertyName)
Maps the given $sourcePropertyName to a target property name.
Can be used to rename properties from source to target.
mixed
getConfigurationValue(string $typeConverterClassName, string $key)
No description
TypeConverterInterface
getTypeConverter()
This method can be used to explicitely force a TypeConverter to be used for this Configuration.