PropertyMappingConfigurationInterface
Configuration object for the property mapper.
Table of Contents
Methods
- getConfigurationFor() : PropertyMappingConfigurationInterface
- Returns the sub-configuration for the passed $propertyName. Must ALWAYS return a valid configuration object!
- getConfigurationValue() : mixed
- getTargetPropertyName() : string
- Maps the given $sourcePropertyName to a target property name.
- getTypeConverter() : TypeConverterInterface|null
- This method can be used to explicitly force a TypeConverter to be used for this Configuration.
- shouldSkip() : bool
- returns TRUE if the given propertyName should be mapped, FALSE otherwise.
- shouldSkipUnknownProperties() : bool
- Whether unknown (unconfigured) properties should be skipped during mapping, instead if causing an error.
Methods
getConfigurationFor()
Returns the sub-configuration for the passed $propertyName. Must ALWAYS return a valid configuration object!
public
getConfigurationFor(string $propertyName) : PropertyMappingConfigurationInterface
Parameters
- $propertyName : string
Return values
PropertyMappingConfigurationInterface —the property mapping configuration for the given $propertyName.
getConfigurationValue()
public
getConfigurationValue(string $typeConverterClassName, string $key) : mixed
Parameters
- $typeConverterClassName : string
- $key : string
Return values
mixed —configuration value for the specific $typeConverterClassName. Can be used by Type Converters to fetch converter-specific configuration
getTargetPropertyName()
Maps the given $sourcePropertyName to a target property name.
public
getTargetPropertyName(string $sourcePropertyName) : string
Can be used to rename properties from source to target.
Parameters
- $sourcePropertyName : string
Return values
string —property name of target
getTypeConverter()
This method can be used to explicitly force a TypeConverter to be used for this Configuration.
public
getTypeConverter() : TypeConverterInterface|null
Return values
TypeConverterInterface|null —The type converter to be used for this particular PropertyMappingConfiguration, or NULL if the system-wide configured type converter should be used.
shouldSkip()
returns TRUE if the given propertyName should be mapped, FALSE otherwise.
public
shouldSkip(string $propertyName) : bool
Parameters
- $propertyName : string
Return values
boolshouldSkipUnknownProperties()
Whether unknown (unconfigured) properties should be skipped during mapping, instead if causing an error.
public
shouldSkipUnknownProperties() : bool