CommonGateway\CoreBundle\Service\MappingService
The mapping service handles the mapping (or transformation) of array A (input) to array B (output).
More information on how to write your own mappings can be found at Mappings.
Methods
| Name | Description |
|---|---|
| __construct | Setting up the base class with required services. |
| coordinateStringToArray | Converts a coordinate string to an array of coordinates. |
| encodeArrayKeys | Replaces strings in array keys, helpful for characters like . in array keys. |
| mapping | Maps (transforms) an array (input) to a different array (output). |
| setStyle | Set symfony style in order to output to the console. |
MappingService::__construct
Description
public __construct (\Environment $twig)
Setting up the base class with required services.
Parameters
(\Environment) $twig
Return Values
void
MappingService::coordinateStringToArray
Description
public coordinateStringToArray (string $coordinates)
Converts a coordinate string to an array of coordinates.
Parameters
(string) $coordinates: A string containing coordinates.
Return Values
array
An array of coordinates.
MappingService::encodeArrayKeys
Description
public encodeArrayKeys (array $array, string $toReplace, string $replacement)
Replaces strings in array keys, helpful for characters like . in array keys.
Parameters
(array) $array: The array to encode the array keys for.(string) $toReplace: The character to encode.(string) $replacement: The encoded character.
Return Values
array
The array with encoded array keys
MappingService::mapping
Description
public mapping (\Mapping $mappingObject, array $input, bool $list)
Maps (transforms) an array (input) to a different array (output).
Parameters
(\Mapping) $mappingObject: The mapping object that forms the recipe for the mapping(array) $input: The array that need to be mapped (transformed) otherwise known as input(bool) $list: Wheter we want a list instead of a sngle item
Return Values
array
The result (output) of the mapping process
Throws Exceptions
\LoaderError|\SyntaxError
Twig Exceptions
MappingService::setStyle
Description
public setStyle (\SymfonyStyle $io)
Set symfony style in order to output to the console.
Parameters
(\SymfonyStyle) $io
Return Values
self