Merge pull request #167 from cleverage/166

#166 Add PregMatchTransformer

Author: njoubert-cleverage

docs/index.md

@@ -124,6 +124,7 @@
             - [ExplodeTransformer]
             - [HashTransformer]
             - [ImplodeTransformer](reference/transformers/implode_transformer.md)
+            - [PregMatchTransformer](reference/transformers/preg_match_transformer.md)
             - [SlugifyTransformer](reference/transformers/slugify_transformer.md)
             - [SprintfTransformer]
             - [TrimTransformer](reference/transformers/trim_transformer.md)

docs/reference/transformers/preg_match_transformer.md

@@ -0,0 +1,53 @@
+PregMatchTransformer
+=========================
+
+Perform a regular expression match
+
+This transformer uses the php internal function: https://www.php.net/manual/en/function.preg-match.php
+
+Task reference
+--------------
+
+* **Service**: `CleverAge\ProcessBundle\Transformer\String\PregMatchTransformer`
+* **Transformer code**: `preg_match`
+
+Accepted inputs
+---------------
+
+`string`
+
+Possible outputs
+----------------
+
+`array` or `null`
+
+Options
+-------
+
+| Code       | Type      | Required | Default | Description                              |
+|------------|-----------|:--------:|---------|------------------------------------------|
+| `pattern`  | `string`  |  **X**   |         |                                          |
+| `flags`    | `int`     |          | 0       |                                          |
+| `offset`   | `int`     |          | 0       |                                          |
+| `mode_all` | `boolean` |          | false   | Use preg_match_all instead of preg_match |
+
+Examples
+--------
+
+```yaml
+# Transformer options level
+entry:
+  service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
+  outputs: [ preg_match ]
+  options:
+    output: 'foobarbaz'
+preg_match:
+  service: '@CleverAge\ProcessBundle\Task\TransformerTask'
+  options:
+    transformers:
+      preg_match:
+        pattern: '/(foo)(bar)(baz)/'
+        flags: !php/const PREG_OFFSET_CAPTURE
+      property_accessor:
+        property_path: '[2]'
+```

src/Transformer/String/PregMatchTransformer.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the CleverAge/ProcessBundle package.
+ *
+ * Copyright (c) Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\ProcessBundle\Transformer\String;
+
+use CleverAge\ProcessBundle\Transformer\ConfigurableTransformerInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Perform a regular expression match.
+ */
+class PregMatchTransformer implements ConfigurableTransformerInterface
+{
+    public function transform(mixed $value, array $options = []): ?array
+    {
+        if (null === $value || '' === $value) {
+            return null;
+        }
+
+        if ($options['mode_all']) {
+            preg_match_all($options['pattern'], (string) $value, $matches, $options['flags'], $options['offset']);
+        } else {
+            preg_match($options['pattern'], (string) $value, $matches, $options['flags'], $options['offset']);
+        }
+
+        return $matches;
+    }
+
+    /**
+     * Returns the unique code to identify the transformer.
+     */
+    public function getCode(): string
+    {
+        return 'preg_match';
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setRequired(['pattern']);
+        $resolver->setAllowedTypes('pattern', ['string']);
+        $resolver->setDefault('flags', 0);
+        $resolver->setAllowedTypes('flags', ['int']);
+        $resolver->setDefault('offset', 0);
+        $resolver->setAllowedTypes('offset', ['int']);
+        $resolver->setDefault('mode_all', false);
+        $resolver->setAllowedTypes('mode_all', ['boolean']);
+    }
+}