Documentation

PropertyMappingsRunner
in package

Runs the property mappings transformations and adds the found properties to the result set.

Table of Contents

$propertyMappings  : mixed
__construct()  : mixed
run()  : mixed
createProperty()  : mixed
getProperty()  : mixed
The property is obtained by transforming the source value.
getSourceValue()  : mixed
The source value can be found in the HTTP headers, or can come from the Client-side, in which case it has already been parsed into a Property Object
removeClientSideProperties()  : mixed
Some source value may come from the Client-side, in such cases they have been parsed into Property objects and are contained within the result set. Here we remove these objects from the result set as they are of no further used.
runMapping()  : mixed
Tries to find a property value from the mappings sources.

Properties

Methods

__construct()

public __construct(mixed $propertyMappings) : mixed
Parameters
$propertyMappings : mixed
Return values
mixed

run()

public run(mixed &$dynamicProperties, mixed $headers) : mixed
Parameters
$dynamicProperties : mixed
$headers : mixed
Return values
mixed

createProperty()

private createProperty(mixed $sourceValue, mixed $dataTypeId) : mixed
Parameters
$sourceValue : mixed
$dataTypeId : mixed
Return values
mixed

getProperty()

The property is obtained by transforming the source value.

private getProperty(mixed $source, mixed $propertyDataTypeId, mixed $dynamicProperties, mixed $headers) : mixed

The source value is either trimmed and returned or used in a comparison operation(s) to return a defined value. If neither a trim transformation nor a comparison transformation is defined then the source value is passed through unchanged.

Parameters
$source : mixed
$propertyDataTypeId : mixed
$dynamicProperties : mixed
$headers : mixed
Return values
mixed

getSourceValue()

The source value can be found in the HTTP headers, or can come from the Client-side, in which case it has already been parsed into a Property Object

private getSourceValue(mixed $identifier, mixed $dynamicProperties, mixed $headers) : mixed
Parameters
$identifier : mixed
$dynamicProperties : mixed
$headers : mixed
Return values
mixed

removeClientSideProperties()

Some source value may come from the Client-side, in such cases they have been parsed into Property objects and are contained within the result set. Here we remove these objects from the result set as they are of no further used.

private removeClientSideProperties(mixed $mapping, mixed &$dynamicProperties) : mixed
Parameters
$mapping : mixed
$dynamicProperties : mixed
Return values
mixed

runMapping()

Tries to find a property value from the mappings sources.

private runMapping(mixed $mapping, mixed &$dynamicProperties, mixed $headers) : mixed

If a value is found the property is added to the result set and the rest of the sources are ignored.

Parameters
$mapping : mixed
$dynamicProperties : mixed
$headers : mixed
Return values
mixed

        

Search results