class ImportExportPropertyMappingConfiguration implements PropertyMappingConfigurationInterface (View source)

Property mapping configuration which is used for import / export:

  • works for all levels of the PropertyMapping (recursively)
  • sets the correct export and import configuration for the type converters

Properties

protected string $resourceLoadSavePath

Methods

__construct($resourceLoadSavePath)

No description

PropertyMappingConfigurationInterface
getConfigurationFor(string $propertyName)

The sub-configuration to be used is the current one.

mixed
getConfigurationValue(string $typeConverterClassName, string $key)

No description

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.

string
getTargetPropertyName(string $sourcePropertyName)

Maps the given $sourcePropertyName to a target property name.

TypeConverterInterface
getTypeConverter()

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

Details

__construct($resourceLoadSavePath)

No description

Parameters

$resourceLoadSavePath

PropertyMappingConfigurationInterface getConfigurationFor(string $propertyName)

The sub-configuration to be used is the current one.

Parameters

string $propertyName

Return Value

PropertyMappingConfigurationInterface

the property mapping configuration for the given $propertyName.

mixed getConfigurationValue(string $typeConverterClassName, string $key)

No description

Parameters

string $typeConverterClassName
string $key

Return Value

mixed

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

bool shouldMap(string $propertyName)

No description

Parameters

string $propertyName

Return Value

bool

true if the given propertyName should be mapped, false otherwise.

bool shouldSkip(string $propertyName)

Check if the given $propertyName should be skipped during mapping.

Parameters

string $propertyName

Return Value

bool

bool shouldSkipUnknownProperties()

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

Return Value

bool

string getTargetPropertyName(string $sourcePropertyName)

Maps the given $sourcePropertyName to a target property name.

Can be used to rename properties from source to target.

Parameters

string $sourcePropertyName

Return Value

string

property name of target

TypeConverterInterface getTypeConverter()

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

Return Value

TypeConverterInterface

The type converter to be used for this particular PropertyMappingConfiguration, or NULL if the system-wide configured type converter should be used.