Merge pull request #178 from cleverage/145-sprintf

doc: #145 Add array_map_transformer, multi_replace_transformer and sp…

Author: njoubert-cleverage

CHANGELOG.md

@@ -2,7 +2,6 @@ v4.5
 -----
 
 ## Changes
-
 * [#176](https://github.com/cleverage/process-bundle/issues/176) Upgrade to Symfony 7.3 & PHP 8.4
 
 v4.4

docs/index.md

@@ -99,7 +99,7 @@
             - [EvaluatorTransformer]
             - [ExpressionLanguageMapTransformer]
             - [MappingTransformer](reference/transformers/mapping_transformer.md)
-            - [MultiReplaceTransformer]
+            - [MultiReplaceTransformer](reference/transformers/multi_replace_transformer.md)
             - [PregFilterTransformer]
             - [RulesTransformer](reference/transformers/rules_transformer.md)
             - [TypeSetterTransformer]
@@ -110,7 +110,7 @@
             - [ArrayFilterTransformer](reference/transformers/array_filter_transformer.md)
             - [ArrayFirstTransformer]
             - [ArrayLastTransformer]
-            - [ArrayMapTransformer]
+            - [ArrayMapTransformer](reference/transformers/array_map_transformer.md)
             - [ArrayUnsetTransformer]
         - Date
             - [DateFormatTransformer](reference/transformers/date_format.md)
@@ -128,7 +128,7 @@
             - [ImplodeTransformer](reference/transformers/implode_transformer.md)
             - [PregMatchTransformer](reference/transformers/preg_match_transformer.md)
             - [SlugifyTransformer](reference/transformers/slugify_transformer.md)
-            - [SprintfTransformer]
+            - [SprintfTransformer](reference/transformers/sprintf_transformer.md)
             - [TrimTransformer](reference/transformers/trim_transformer.md)
         - XML
             - [XpathEvaluatorTransformer](reference/transformers/xpath_evaluator.md)

docs/reference/transformers/array_map_transformer.md

@@ -0,0 +1,47 @@
+ArrayMapTransformer
+=========================
+
+Applies transformers to each element of an array.
+
+Task reference
+--------------
+
+* **Service**: `CleverAge\ProcessBundle\Transformer\Array\ArrayMapTransformer`
+* **Transformer code**: `array_map`
+
+Accepted inputs
+---------------
+
+`array`
+
+Possible outputs
+----------------
+
+`string`
+
+Options
+-------
+
+| Code           | Type    | Required | Default | Description                                                                  |
+|----------------|---------|:--------:|---------|------------------------------------------------------------------------------|
+| `transformers` | `array` |  **X**   |         | List of transformers, see [TransformerTrait](../traits/transformer_trait.md) |
+| `skip_null`    | `bool`  |          | `false` | If true continue without applying other transformers on null values          |
+
+
+Examples
+--------
+
+```yaml
+# Transformer mapping level
+array_map:
+  code:
+    - '[id]'
+    - '[firstname]'
+    - '[lastname]'
+  transformers:
+    array_map:
+      transformers:
+        cast:
+          type: 'string'
+        uppercase: ~
+```

docs/reference/transformers/implode_transformer.md

@@ -32,7 +32,12 @@ Examples
 --------
 
 ```yaml
-# Transformer options level
-implode:
-  separator: '-'
+# Transformer mapping level
+sprintf_multiple:
+  code:
+    - '[firstname]'
+    - '[lastname]'
+  transformers:
+    implode:
+      separator: '-'
 ```

docs/reference/transformers/multi_replace_transformer.md

@@ -0,0 +1,44 @@
+MultiReplaceTransformer
+=========================
+
+Quickly replace a list of values in a string.
+
+This transformer uses the php internal function: https://www.php.net/manual/en/function.str-replace.php
+
+Task reference
+--------------
+
+* **Service**: `CleverAge\ProcessBundle\Transformer\MultiReplaceTransformer`
+* **Transformer code**: `multi_replace`
+
+Accepted inputs
+---------------
+
+Any value that can be cast to string.
+
+Possible outputs
+----------------
+
+`string`
+
+Options
+-------
+
+| Code              | Type    | Required | Default | Description                       |
+|-------------------|---------|:--------:|---------|-----------------------------------|
+| `replace_mapping` | `array` |  **X**   |         | $search as key, $replace as value |
+
+Examples
+--------
+
+```yaml
+# Transformer mapping level
+multi_replace:
+  code:
+    - '[firstname]'
+  transformers:
+    multi_replace:
+    replace_mapping:
+      ' ': '!'
+      'name': ''
+```

docs/reference/transformers/slugify_transformer.md

@@ -34,6 +34,10 @@ Examples
 --------
 
 ```yaml
-# Transformer options level
-slugify: ~
+# Transformer mapping level
+slug:
+  code:
+    - '[firstname]'
+  transformers:
+    slugify: ~
 ```

docs/reference/transformers/sprintf_transformer.md

@@ -0,0 +1,48 @@
+SprintfTransformer
+=========================
+
+Return a formatted string.
+
+This transformer uses the php internal function: https://www.php.net/manual/en/function.vsprintf.php
+
+Task reference
+--------------
+
+* **Service**: `CleverAge\ProcessBundle\Transformer\String\SprintfTransformer`
+* **Transformer code**: `sprintf`
+
+Accepted inputs
+---------------
+
+Any value that can be cast to `string` | `int` | `float` or `array`
+
+Possible outputs
+----------------
+
+`string`
+
+Options
+-------
+
+| Code     | Type     | Required | Default | Description                                                                                                          |
+|----------|----------|:--------:|---------|----------------------------------------------------------------------------------------------------------------------|
+| `format` | `string` |  **X**   | `%s`    | The format string is composed of zero or more directives. Escape % with another %% due to ParameterBag restrictions. |
+
+Examples
+--------
+
+```yaml
+# Transformer mapping level
+sprintf_one:
+  code: '[firstname]'
+  transformers:
+    sprintf:
+      format: 'one/%%d'
+sprintf_multiple:
+  code:
+    - '[firstname]'
+    - '[lastname]'
+  transformers:
+    sprintf:
+      format: 'multiple/%%s/%%s'
+```