From 2508ea8ea26e6c82d634f28675fbc0eec8411774 Mon Sep 17 00:00:00 2001 From: Valentin Clavreul Date: Fri, 15 Nov 2019 16:43:02 +0100 Subject: [PATCH 1/5] Added an XML reader/transformer feature --- Documentation/reference/tasks/_template.md | 44 ++++++ .../reference/tasks/xml_reader_task.md | 39 ++++++ .../reference/transformers/_template.md | 4 +- .../reference/transformers/xpath_evaluator.md | 92 +++++++++++++ Filesystem/XmlFile.php | 54 ++++++++ Task/File/Xml/XmlReaderTask.php | 63 +++++++++ Tests/AbstractProcessTest.php | 20 ++- .../XpathEvaluatorTransformerTest.php | 105 ++++++++++++++ Transformer/Xml/XpathEvaluatorTransformer.php | 130 ++++++++++++++++++ composer.json | 1 + 10 files changed, 548 insertions(+), 4 deletions(-) create mode 100644 Documentation/reference/tasks/_template.md create mode 100644 Documentation/reference/tasks/xml_reader_task.md create mode 100644 Documentation/reference/transformers/xpath_evaluator.md create mode 100644 Filesystem/XmlFile.php create mode 100644 Task/File/Xml/XmlReaderTask.php create mode 100644 Tests/Transformer/XpathEvaluatorTransformerTest.php create mode 100644 Transformer/Xml/XpathEvaluatorTransformer.php diff --git a/Documentation/reference/tasks/_template.md b/Documentation/reference/tasks/_template.md new file mode 100644 index 00000000..ed1d4a57 --- /dev/null +++ b/Documentation/reference/tasks/_template.md @@ -0,0 +1,44 @@ +TaskName +======== + +_Describe main goal an use cases of the task_ + +Task reference +-------------- + +* **Service**: `ClassName` + +Accepted inputs +--------------- + +_Description of allowed types_ + +Possible outputs +---------------- + +_Description of possible types_ + +Options +------- + +| Code | Type | Required | Default | Description | +| ---- | ---- | :------: | ------- | ----------- | +| `code` | `type` | **X** _or nothing_ | `default value` _if available_ | _description_ | + +Examples +-------- + +_YAML samples and explanations_ + +* Example 1 + - details + - details + +```yaml +# Task configuration level +code: + service: '@service_ref' + options: + a: 1 + b: 2 +``` diff --git a/Documentation/reference/tasks/xml_reader_task.md b/Documentation/reference/tasks/xml_reader_task.md new file mode 100644 index 00000000..b90cca68 --- /dev/null +++ b/Documentation/reference/tasks/xml_reader_task.md @@ -0,0 +1,39 @@ +XmlReaderTask +============= + +Open and read an XML file. +Requires `php-xml`. + +Task reference +-------------- + +* **Service**: `CleverAge\ProcessBundle\Task\File\Xml\XmlReaderTask` + +Accepted inputs +--------------- + +No input accepted. + +Possible outputs +---------------- + +A `\DOMDocument` built from the file. + +Options +------- + +| Code | Type | Required | Default | Description | +| ---- | ---- | :------: | ------- | ----------- | +| `file_path` | `string` | **X** | | Path of the file to read from (relative to symfony root or absolute) | +| `mode` | `string` | | `rb` | File open mode (see [fopen mode parameter](https://secure.php.net/manual/en/function.fopen.php)) | + +Examples +-------- + +```yaml +# Transformer options level +my_xml_reader: + service: '@CleverAge\ProcessBundle\Task\File\Xml\XmlReaderTask' + options: + file_path: '%kernel.project_dir%/var/data/file.xml' +``` diff --git a/Documentation/reference/transformers/_template.md b/Documentation/reference/transformers/_template.md index f11e3099..d5e98a70 100644 --- a/Documentation/reference/transformers/_template.md +++ b/Documentation/reference/transformers/_template.md @@ -3,8 +3,8 @@ TransformerName _Describe main goal an use cases of the transformer_ -Task reference --------------- +Transformer reference +--------------------- * **Service**: `ClassName` * **Transformer code**: `code` diff --git a/Documentation/reference/transformers/xpath_evaluator.md b/Documentation/reference/transformers/xpath_evaluator.md new file mode 100644 index 00000000..e6274cbf --- /dev/null +++ b/Documentation/reference/transformers/xpath_evaluator.md @@ -0,0 +1,92 @@ +XpathEvaluatorTransformer +========================= + +Manipulate a DOMNode to extract some information using xpath. +Requires `php-xml`. + +**Important** : due to the [behavior of `\DOMXpath::query`](https://www.php.net/manual/en/domxpath.query.php), if you want +to make a query on a sub element of the full `\DOMDocument` you need to start your query with a `.` to specify the current node. + +Task reference +-------------- + +* **Service**: `CleverAge\ProcessBundle\Transformer\Xml\XpathEvaluatorTransformer` +* **Transformer code**: `xpath_evaluator` + +Accepted inputs +--------------- + +`\DOMNode` only. + +Possible outputs +---------------- + +Depending on the options : +- `string` +- `\DOMNode` +- `null` +- an `array` of one of the type above + +Options +------- + +| Code | Type | Required | Default | Description | +| ---- | ---- | :------: | ------- | ----------- | +| `query` | `string` or `array` | **X** | | One or multiple Xpath queries, array keys are conserved | +| `single_result` | `boolean` | | `true` | Force the result to match a single value | +| `ignore_missing` | `boolean` | | `true` | Only used with `single_result`, avoid errors if the query doesn't match anything | +| `as_text` | `boolean` | | `true` | Return the textual content of the node, only if the query is a `\DOMText` (you might need to use the `text()` xpath selector) | + +Examples +-------- + +All examples assume this XML +```xml + + + ok1 + ok2 + ok3 + + + ok4 + ok5 + ok6 + + +``` + +* Example 1 : get a single value + +```yaml +# Transformer options level +xpath_evaluator: + query: '/a/b/c[0]/text()' +``` + +* Example 2 : get a multiple values + +```yaml +# Transformer options level +xpath_evaluator: + query: '/a/b/c/text()' + single_result: false +``` + +```yaml +# Transformer options level +xpath_evaluator: + query: + - '/a/d/e/text()' + - '/a/d/f/text()' + - '/a/d/g/text()' +``` + +* Example 3 : get a \DOMNode + +```yaml +# Transformer options level +xpath_evaluator: + query: '/a/b' + as_text: false +``` diff --git a/Filesystem/XmlFile.php b/Filesystem/XmlFile.php new file mode 100644 index 00000000..3a14d49d --- /dev/null +++ b/Filesystem/XmlFile.php @@ -0,0 +1,54 @@ + + */ +class XmlFile +{ + /** @var \SplFileObject */ + protected $file; + + /** + * XmlFile constructor. + * + * @param string $path + * @param string $mode + */ + public function __construct(string $path, string $mode = 'rb') + { + $this->file = new \SplFileObject($path, $mode); + } + + public function read(): \DOMDocument + { + $dom = new \DOMDocument(); + $this->file->rewind(); + $fileSize = $this->file->getSize(); + $fileContent = $this->file->fread($fileSize); + + $dom->loadXML($fileContent); + + return $dom; + } + + public function write(\DOMDocument $dom) + { + $content = $dom->saveXML(); + $result = $this->file->fwrite($content); + + if ($result === null) { + throw new \RuntimeException("Could not write content to file"); + } + } +} diff --git a/Task/File/Xml/XmlReaderTask.php b/Task/File/Xml/XmlReaderTask.php new file mode 100644 index 00000000..a827741b --- /dev/null +++ b/Task/File/Xml/XmlReaderTask.php @@ -0,0 +1,63 @@ + + */ +class XmlReaderTask extends AbstractConfigurableTask +{ + /** @var LoggerInterface */ + protected $logger; + + /** + * XmlReaderTask constructor. + * + * @param LoggerInterface $logger + */ + public function __construct(LoggerInterface $logger) + { + $this->logger = $logger; + } + + /** + * {@inheritDoc} + */ + protected function configureOptions(OptionsResolver $resolver) + { + $resolver->setRequired('file_path'); + $resolver->setAllowedTypes('file_path', 'string'); + + $resolver->setDefault('mode', 'rb'); + $resolver->setAllowedTypes('mode', 'string'); + } + + /** + * {@inheritDoc} + */ + public function execute(ProcessState $state) + { + if ($state->getInput() !== null) { + $this->logger->warning('Input has been ignored for XMLReaderTask'); + } + + $file = new XmlFile($this->getOption($state, 'file_path'), $this->getOption($state, 'mode')); + $state->setOutput($file->read()); + } +} diff --git a/Tests/AbstractProcessTest.php b/Tests/AbstractProcessTest.php index 1f89f28b..9c5b8390 100644 --- a/Tests/AbstractProcessTest.php +++ b/Tests/AbstractProcessTest.php @@ -94,7 +94,7 @@ protected function assertDataQueue(array $expected, string $processName, bool $c */ protected function getContainer(): ContainerInterface { - if(isset(self::$container)) { + if (isset(self::$container)) { return self::$container; } @@ -115,6 +115,22 @@ protected function getContainer(): ContainerInterface * @throws ExceptionInterface */ protected function assertTransformation(string $transformerCode, $expected, $value, array $options = []) + { + $result = $this->transform($transformerCode, $value, $options); + self::assertEquals($expected, $result); + } + + /** + * Transform some value using referenced transformer with given options + * + * @param string $transformerCode + * @param mixed $value + * @param array $options + * + * @return mixed + * @throws ExceptionInterface + */ + protected function transform(string $transformerCode, $value, array $options = []) { $transformer = $this->transformerRegistry->getTransformer($transformerCode); @@ -124,6 +140,6 @@ protected function assertTransformation(string $transformerCode, $expected, $val $options = $resolver->resolve($options); } - self::assertEquals($expected, $transformer->transform($value, $options)); + return $transformer->transform($value, $options); } } diff --git a/Tests/Transformer/XpathEvaluatorTransformerTest.php b/Tests/Transformer/XpathEvaluatorTransformerTest.php new file mode 100644 index 00000000..f8302a54 --- /dev/null +++ b/Tests/Transformer/XpathEvaluatorTransformerTest.php @@ -0,0 +1,105 @@ +loadXML('ok'); + $this->assertTransformation('xpath_evaluator', 'ok', $domDocument, [ + 'query' => '/a/text()', + ]); + } + + public function testSubQuery() + { + $domDocument = new \DOMDocument(); + $domDocument->loadXML('ok'); + + $node = $domDocument->getElementsByTagName('b')[0]; + $this->assertTransformation('xpath_evaluator', 'ok', $node, [ + 'query' => './c/text()', + ]); + } + + public function testMultiResults() + { + $domDocument = new \DOMDocument(); + $domDocument->loadXML('ok1ok2ok3'); + + $node = $domDocument->getElementsByTagName('b')[0]; + $this->assertTransformation('xpath_evaluator', ['ok1', 'ok2', 'ok3'], $node, [ + 'query' => './c/text()', + 'single_result' => false, + ]); + } + + public function testMultiResultsAsNodeList() + { + $domDocument = new \DOMDocument(); + $domDocument->loadXML('ok1ok2ok3'); + + $node = $domDocument->getElementsByTagName('b')[0]; + /** @var \DOMNodeList $result */ + $result = $this->transform('xpath_evaluator', $node, [ + 'query' => './c/text()', + 'single_result' => false, + 'as_text' => false, + ]); + + self::assertCount(3, $result); + self::assertEquals('ok1', $result[0]->textContent); + self::assertEquals('ok2', $result[1]->textContent); + self::assertEquals('ok3', $result[2]->textContent); + } + + public function testMultiQuery() + { + $domDocument = new \DOMDocument(); + $domDocument->loadXML('ok1ok2ok3'); + + $node = $domDocument->getElementsByTagName('b')[0]; + $this->assertTransformation('xpath_evaluator', ['ok1', 'ok2', 'ok3'], $node, [ + 'query' => [ + './c/text()', + './d/text()', + './e/text()', + ], + ]); + } + + public function testMultiQueryWithKey() + { + $domDocument = new \DOMDocument(); + $domDocument->loadXML('ok1ok2ok3'); + + $node = $domDocument->getElementsByTagName('b')[0]; + $this->assertTransformation('xpath_evaluator', [ + 'c' => 'ok1', + 'd' => 'ok2', + 'e' => 'ok3', + ], $node, [ + 'query' => [ + 'c' => './c/text()', + 'd' => './d/text()', + 'e' => './e/text()', + ], + ]); + } +} diff --git a/Transformer/Xml/XpathEvaluatorTransformer.php b/Transformer/Xml/XpathEvaluatorTransformer.php new file mode 100644 index 00000000..9a30d33c --- /dev/null +++ b/Transformer/Xml/XpathEvaluatorTransformer.php @@ -0,0 +1,130 @@ +setRequired('query'); + $resolver->setAllowedTypes('query', ['string', 'array']); + + $resolver->setDefault('single_result', true); + $resolver->setAllowedTypes('single_result', 'bool'); + + $resolver->setDefault('ignore_missing', true); + $resolver->setAllowedTypes('ignore_missing', 'bool'); + + $resolver->setDefault('as_text', true); + $resolver->setAllowedTypes('as_text', 'bool'); + } + + /** + * {@inheritDoc} + */ + public function transform($value, array $options = []) + { + if (!$value instanceof \DOMNode) { + throw new \UnexpectedValueException("Input should be a " . \DOMNode::class); + } + + $xpath = $this->buildXpath($value); + + $query = $options['query']; + if (\is_array($query)) { + $result = \array_map(function ($subquery) use ($xpath, $value, $options) { + return $this->query($xpath, $subquery, $value, $options); + }, $query); + } else { + $result = $this->query($xpath, $query, $value, $options); + } + + return $result; + } + + /** + * {@inheritDoc} + */ + public function getCode() + { + return 'xpath_evaluator'; + } + + /** + * @param \DOMNode $node + * + * @return \DOMXPath + */ + public function buildXpath(\DOMNode $node): \DOMXPath + { + $doc = $node instanceof \DOMDocument ? $node : $node->ownerDocument; + + return new \DOMXPath($doc); + } + + /** + * @param \DOMXPath $xpath + * @param string $query + * @param \DOMNode $node + * @param array $options + * + * @return mixed + */ + public function query(\DOMXPath $xpath, string $query, \DOMNode $node, array $options) + { + // TODO check if query is relative ? + $nodeList = $xpath->query($query, $node); + $results = iterator_to_array($nodeList); + + // Convert results to text + if ($options['as_text']) { + $results = \array_map(function (\DOMNode $item) use ($options) { + if (!$item instanceof \DOMText) { + // If you have this error maybe you need to use the "text()" xpath selector + throw new \UnexpectedValueException("Xpath result is not a text node"); + } + + return $item->textContent; + }, $results); + } + + // Unwrap the node list + if ($options['single_result']) { + if (count($results) > 1) { + throw new \UnexpectedValueException("There is too much results for query '{$query}'"); + } + + if (count($results) === 0 && !$options['ignore_missing']) { + throw new \UnexpectedValueException("There is not enough results for query '{$query}'"); + } + + if(count($results) === 1) { + $results = $results[0]; + } else { + $results = null; + } + + } + + return $results; + } + +} diff --git a/composer.json b/composer.json index 9cb59464..2d10787f 100644 --- a/composer.json +++ b/composer.json @@ -39,6 +39,7 @@ "require": { "php": ">=7.1", "ext-json": "*", + "ext-dom": "*", "symfony/framework-bundle": "~3.0|~4.0", "symfony/expression-language": "~3.0|~4.0", "symfony/monolog-bundle": "~3.3", From 16cd3d0d9d265eea202b1442ef12a557327a51e9 Mon Sep 17 00:00:00 2001 From: Valentin Clavreul Date: Mon, 18 Nov 2019 15:08:14 +0100 Subject: [PATCH 2/5] Allow to match directly XML attributes --- .../reference/tasks/xml_reader_task.md | 2 +- .../reference/transformers/xpath_evaluator.md | 6 +++--- Transformer/Xml/XpathEvaluatorTransformer.php | 20 +++++++++++-------- 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/Documentation/reference/tasks/xml_reader_task.md b/Documentation/reference/tasks/xml_reader_task.md index b90cca68..4383f491 100644 --- a/Documentation/reference/tasks/xml_reader_task.md +++ b/Documentation/reference/tasks/xml_reader_task.md @@ -31,7 +31,7 @@ Examples -------- ```yaml -# Transformer options level +# Task configuration level my_xml_reader: service: '@CleverAge\ProcessBundle\Task\File\Xml\XmlReaderTask' options: diff --git a/Documentation/reference/transformers/xpath_evaluator.md b/Documentation/reference/transformers/xpath_evaluator.md index e6274cbf..2424925f 100644 --- a/Documentation/reference/transformers/xpath_evaluator.md +++ b/Documentation/reference/transformers/xpath_evaluator.md @@ -35,7 +35,7 @@ Options | `query` | `string` or `array` | **X** | | One or multiple Xpath queries, array keys are conserved | | `single_result` | `boolean` | | `true` | Force the result to match a single value | | `ignore_missing` | `boolean` | | `true` | Only used with `single_result`, avoid errors if the query doesn't match anything | -| `as_text` | `boolean` | | `true` | Return the textual content of the node, only if the query is a `\DOMText` (you might need to use the `text()` xpath selector) | +| `unwrap_value` | `boolean` | | `true` | Return the textual content of the node, only works if the result is a `\DOMText` (you might need to use the `text()` xpath selector) or a `\DOMAttr` | Examples -------- @@ -82,11 +82,11 @@ xpath_evaluator: - '/a/d/g/text()' ``` -* Example 3 : get a \DOMNode +* Example 3 : get a `\DOMNode` ```yaml # Transformer options level xpath_evaluator: query: '/a/b' - as_text: false + unwrap_value: false ``` diff --git a/Transformer/Xml/XpathEvaluatorTransformer.php b/Transformer/Xml/XpathEvaluatorTransformer.php index 9a30d33c..96a61e17 100644 --- a/Transformer/Xml/XpathEvaluatorTransformer.php +++ b/Transformer/Xml/XpathEvaluatorTransformer.php @@ -33,8 +33,8 @@ public function configureOptions(OptionsResolver $resolver) $resolver->setDefault('ignore_missing', true); $resolver->setAllowedTypes('ignore_missing', 'bool'); - $resolver->setDefault('as_text', true); - $resolver->setAllowedTypes('as_text', 'bool'); + $resolver->setDefault('unwrap_value', true); + $resolver->setAllowedTypes('unwrap_value', 'bool'); } /** @@ -95,14 +95,18 @@ public function query(\DOMXPath $xpath, string $query, \DOMNode $node, array $op $results = iterator_to_array($nodeList); // Convert results to text - if ($options['as_text']) { - $results = \array_map(function (\DOMNode $item) use ($options) { - if (!$item instanceof \DOMText) { - // If you have this error maybe you need to use the "text()" xpath selector - throw new \UnexpectedValueException("Xpath result is not a text node"); + if ($options['unwrap_value']) { + $results = \array_map(function (\DOMNode $item) use ($query, $options) { + if ($item instanceof \DOMAttr) { + return $item->value; } - return $item->textContent; + if ($item instanceof \DOMText) { + // If you have an error, remember that you may need to use the "text()" xpath selector + return $item->textContent; + } + + throw new \UnexpectedValueException("Xpath result cannot be unwrapped for query '{$query}'"); }, $results); } From 7f0e7ae7628cadf100f4dc13ba5d10ea2e35328f Mon Sep 17 00:00:00 2001 From: Valentin Clavreul Date: Mon, 18 Nov 2019 15:12:03 +0100 Subject: [PATCH 3/5] Fixed test & added a test for attribute selector --- Tests/Transformer/XpathEvaluatorTransformerTest.php | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Tests/Transformer/XpathEvaluatorTransformerTest.php b/Tests/Transformer/XpathEvaluatorTransformerTest.php index f8302a54..cadb21f6 100644 --- a/Tests/Transformer/XpathEvaluatorTransformerTest.php +++ b/Tests/Transformer/XpathEvaluatorTransformerTest.php @@ -27,6 +27,15 @@ public function testSimpleQuery() ]); } + public function testAttributeValueQuery() + { + $domDocument = new \DOMDocument(); + $domDocument->loadXML('ko'); + $this->assertTransformation('xpath_evaluator', 'ok', $domDocument, [ + 'query' => '/node/@data', + ]); + } + public function testSubQuery() { $domDocument = new \DOMDocument(); @@ -60,7 +69,7 @@ public function testMultiResultsAsNodeList() $result = $this->transform('xpath_evaluator', $node, [ 'query' => './c/text()', 'single_result' => false, - 'as_text' => false, + 'unwrap_value' => false, ]); self::assertCount(3, $result); From 71bfa752328b4ab138b7e9025932d54e98177e01 Mon Sep 17 00:00:00 2001 From: Valentin Clavreul Date: Mon, 18 Nov 2019 17:11:03 +0100 Subject: [PATCH 4/5] Added the possibility to override subquery result options --- .../reference/transformers/xpath_evaluator.md | 26 +++++++++- .../XpathEvaluatorTransformerTest.php | 42 +++++++++++++++- Transformer/Xml/XpathEvaluatorTransformer.php | 50 +++++++++++++++++-- 3 files changed, 112 insertions(+), 6 deletions(-) diff --git a/Documentation/reference/transformers/xpath_evaluator.md b/Documentation/reference/transformers/xpath_evaluator.md index 2424925f..43fe7a4e 100644 --- a/Documentation/reference/transformers/xpath_evaluator.md +++ b/Documentation/reference/transformers/xpath_evaluator.md @@ -32,11 +32,21 @@ Options | Code | Type | Required | Default | Description | | ---- | ---- | :------: | ------- | ----------- | -| `query` | `string` or `array` | **X** | | One or multiple Xpath queries, array keys are conserved | +| `query` | `string` or `array` | **X** | | One or multiple Xpath queries. Using an array, you can either have a simple list of subqueries, or override some root-level query options | | `single_result` | `boolean` | | `true` | Force the result to match a single value | | `ignore_missing` | `boolean` | | `true` | Only used with `single_result`, avoid errors if the query doesn't match anything | | `unwrap_value` | `boolean` | | `true` | Return the textual content of the node, only works if the result is a `\DOMText` (you might need to use the `text()` xpath selector) or a `\DOMAttr` | +Subqueries, in their complex form, have the following options : + +| Code | Type | Required | Default | Description | +| ---- | ---- | :------: | ------- | ----------- | +| `subquery` | `string` | **X** | | An Xpath query, no additional sublevel is allowed | +| `single_result` | `boolean` | | _Root-level value for `single_result`_ | Force the result to match a single value | +| `ignore_missing` | `boolean` | | _Root-level value for `ignore_missing`_ | Only used with `single_result`, avoid errors if the query doesn't match anything | +| `unwrap_value` | `boolean` | | _Root-level value for `unwrap_value`_ | Return the textual content of the node, only works if the result is a `\DOMText` (you might need to use the `text()` xpath selector) or a `\DOMAttr` | + + Examples -------- @@ -90,3 +100,17 @@ xpath_evaluator: query: '/a/b' unwrap_value: false ``` + +* Example 4 : subquery with partially overridden options + +```yaml +# Transformer options level +xpath_evaluator: + query: + all_c_values: + subquery: '/a/b/c/text()' + single_result: false + e_value: '/a/d/e/text()' + f_value: + subquery: '/a/d/f/text()' +``` diff --git a/Tests/Transformer/XpathEvaluatorTransformerTest.php b/Tests/Transformer/XpathEvaluatorTransformerTest.php index cadb21f6..2b78d15b 100644 --- a/Tests/Transformer/XpathEvaluatorTransformerTest.php +++ b/Tests/Transformer/XpathEvaluatorTransformerTest.php @@ -1,4 +1,5 @@ - + + ok1 + ok2 + ok3 + + + ok4 + ok5 + ok6 + + +XML; + $domDocument = new \DOMDocument(); + $domDocument->loadXML($xml); + + $node = $domDocument->getElementsByTagName('b')[0]; + $this->assertTransformation('xpath_evaluator', [ + 'all_c_values' => ['ok1', 'ok2', 'ok3'], + 'e_value' => 'ok4', + 'f_value' => 'ok5', + ], $node, [ + 'query' => [ + 'all_c_values' => [ + 'subquery' => '/a/b/c/text()', + 'single_result' => false, + ], + 'e_value' => '/a/d/e/text()', + 'f_value' => [ + 'subquery' => '/a/d/f/text()', + ], + ], + ]); + } } diff --git a/Transformer/Xml/XpathEvaluatorTransformer.php b/Transformer/Xml/XpathEvaluatorTransformer.php index 96a61e17..ba0686ea 100644 --- a/Transformer/Xml/XpathEvaluatorTransformer.php +++ b/Transformer/Xml/XpathEvaluatorTransformer.php @@ -11,6 +11,7 @@ namespace CleverAge\ProcessBundle\Transformer\Xml; use CleverAge\ProcessBundle\Transformer\ConfigurableTransformerInterface; +use Symfony\Component\OptionsResolver\Options; use Symfony\Component\OptionsResolver\OptionsResolver; /** @@ -26,14 +27,55 @@ public function configureOptions(OptionsResolver $resolver) { $resolver->setRequired('query'); $resolver->setAllowedTypes('query', ['string', 'array']); + $resolver->setNormalizer('query', function(Options $options, $value) { + // Basic case : a single query + if(\is_string($value)) { + return $value; + } + + // Complex case : a list of subqueries, each can override root level options + if(\is_array($value)) { + $queryOptions = []; + $queryResolver = new OptionsResolver(); + $this->configureQueryOptions($queryResolver, $options); + $queryResolver->setRequired('subquery'); + $queryResolver->setAllowedTypes('subquery', 'string'); + + foreach ($value as $code => $subquery) { + if(\is_string($subquery)) { + $subquery = ['subquery' => $subquery]; + } + + $queryOptions[$code] = $queryResolver->resolve($subquery); + } + + return $queryOptions; + } - $resolver->setDefault('single_result', true); + // This should never be reached + throw new \InvalidArgumentException('Unhandled query'); + }); + + // Use same options & defaults for root option level and subquery options + $this->configureQueryOptions($resolver); + } + + /** + * Configure options about how to handle xpath query results. + * Available at root and subquery level. + * + * @param OptionsResolver $resolver + * @param Options|null $parentOptions + */ + public function configureQueryOptions(OptionsResolver $resolver, Options $parentOptions = null) + { + $resolver->setDefault('single_result', $parentOptions ? $parentOptions['single_result'] : true); $resolver->setAllowedTypes('single_result', 'bool'); - $resolver->setDefault('ignore_missing', true); + $resolver->setDefault('ignore_missing', $parentOptions ? $parentOptions['ignore_missing'] : true); $resolver->setAllowedTypes('ignore_missing', 'bool'); - $resolver->setDefault('unwrap_value', true); + $resolver->setDefault('unwrap_value', $parentOptions ? $parentOptions['unwrap_value'] : true); $resolver->setAllowedTypes('unwrap_value', 'bool'); } @@ -51,7 +93,7 @@ public function transform($value, array $options = []) $query = $options['query']; if (\is_array($query)) { $result = \array_map(function ($subquery) use ($xpath, $value, $options) { - return $this->query($xpath, $subquery, $value, $options); + return $this->query($xpath, $subquery['subquery'], $value, $subquery); }, $query); } else { $result = $this->query($xpath, $query, $value, $options); From 2438f37397164768400824cb566fc1af2fe5db24 Mon Sep 17 00:00:00 2001 From: Valentin Clavreul Date: Mon, 18 Nov 2019 17:14:10 +0100 Subject: [PATCH 5/5] Fixed missing readme links --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c481d08b..9acdae8b 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,6 @@ Basically, it will greatly ease the configuration of import and exports but can - Reference - [Process definition](Documentation/reference/01-process_definition.md) - [Task definition](Documentation/reference/02-task_definition.md) - - [Generic transformers definition](Documentation/reference/03-generic_transformers_definition.md) - Basic and debug - [ConstantOutputTask](Documentation/reference/tasks/constant_output_task.md) - [ConstantIterableOutputTask](Documentation/reference/tasks/constant_iterable_output_task.md) @@ -44,6 +43,8 @@ Basically, it will greatly ease the configuration of import and exports but can - File/CSV - [CsvReaderTask](Documentation/reference/tasks/csv_reader_task.md) - [CsvWriterTask](Documentation/reference/tasks/csv_writer_task.md) + - File/XML + - [XmlReaderTask](Documentation/reference/tasks/xml_reader_task.md) - Flow manipulation - [AggregateIterableTask](Documentation/reference/tasks/aggregate_iterable_task.md) - [InputAggregatorTask](Documentation/reference/tasks/input_aggregator_task.md) @@ -52,6 +53,8 @@ Basically, it will greatly ease the configuration of import and exports but can - [ArrayFilterTransformer](Documentation/reference/transformers/array_filter_transformer.md) - [MappingTransformer](Documentation/reference/transformers/mapping_transformer.md) - [RulesTransformer](Documentation/reference/transformers/rules_transformer.md) + - [XpathEvaluatorTransformer](Documentation/reference/transformers/xpath_evaluator.md) + - [Generic transformers definition](Documentation/reference/03-generic_transformers_definition.md) - Examples - [Simple ETL] - [Roadmap and versions](Documentation/100-roadmap.md)