PHP Interface Neos\Flow\Property\PropertyMappingConfigurationInterface

As developer, you should probably subclass the PropertyMappingConfiguration class if adjustments are needed there.
Show file Open project: neos/flow-development-collection Interface Usage Examples

Public Methods

Method Description
getConfigurationFor ( string $propertyName ) : Neos\Flow\Property\PropertyMappingConfigurationInterface Returns the sub-configuration for the passed $propertyName. Must ALWAYS return a valid configuration object!
getConfigurationValue ( string $typeConverterClassName, string $key ) : mixed
getTargetPropertyName ( string $sourcePropertyName ) : string Maps the given $sourcePropertyName to a target property name.
getTypeConverter ( ) : Neos\Flow\Property\TypeConverterInterface This method can be used to explicitely force a TypeConverter to be used for this Configuration.
shouldMap ( string $propertyName ) : boolean
shouldSkip ( string $propertyName ) : boolean Check if the given $propertyName should be skipped during mapping.
shouldSkipUnknownProperties ( ) : boolean Whether unknown (unconfigured) properties should be skipped during mapping, instead if causing an error.

Method Details

getConfigurationFor() public method

Returns the sub-configuration for the passed $propertyName. Must ALWAYS return a valid configuration object!
public getConfigurationFor ( string $propertyName ) : Neos\Flow\Property\PropertyMappingConfigurationInterface
$propertyName string
return Neos\Flow\Property\PropertyMappingConfigurationInterface the property mapping configuration for the given $propertyName.

getConfigurationValue() public method

public getConfigurationValue ( string $typeConverterClassName, string $key ) : mixed
$typeConverterClassName string
$key string
return mixed configuration value for the specific $typeConverterClassName. Can be used by Type Converters to fetch converter-specific configuration

getTargetPropertyName() public method

Can be used to rename properties from source to target.
public getTargetPropertyName ( string $sourcePropertyName ) : string
$sourcePropertyName string
return string property name of target

getTypeConverter() public method

This method can be used to explicitely force a TypeConverter to be used for this Configuration.
public getTypeConverter ( ) : Neos\Flow\Property\TypeConverterInterface
return Neos\Flow\Property\TypeConverterInterface The type converter to be used for this particular PropertyMappingConfiguration, or NULL if the system-wide configured type converter should be used.

shouldMap() public method

public shouldMap ( string $propertyName ) : boolean
$propertyName string
return boolean TRUE if the given propertyName should be mapped, FALSE otherwise.

shouldSkip() public method

Check if the given $propertyName should be skipped during mapping.
public shouldSkip ( string $propertyName ) : boolean
$propertyName string
return boolean

shouldSkipUnknownProperties() public method

Whether unknown (unconfigured) properties should be skipped during mapping, instead if causing an error.
public shouldSkipUnknownProperties ( ) : boolean
return boolean