#4 Add/Update doc

Author: njoubert-cleverage

docs/index.md

@@ -21,5 +21,7 @@ CleverAge\CacheProcessBundle\CleverAgeCacheProcessBundle::class => ['all' => tru
 
 ## Reference
 
+- [Adapter](reference/adapter.md)
 - Tasks
-  - TODO
+  - [GetTask](reference/tasks/get_task.md)
+  - [SetTask](reference/tasks/set_task.md)

docs/reference/adapter.md

@@ -0,0 +1,48 @@
+Adapter
+===============
+
+Create cache adapter.
+
+Reference
+--------------
+
+* **Adapter Service Interface**: `CleverAge\CacheProcessBundle\Adapter\AdapterInterface`
+
+Options
+-------
+
+| Code      | Type     | Required | Default | Description                                                |
+|-----------|----------|:--------:|---------|------------------------------------------------------------|
+| `code`    | `string` |  **X**   |         | Service identifier, used by Task adapter option            |
+| `adapter` | `string` |  **X**   |         | `Symfony\Component\Cache\Adapter\AdapterInterface` service |
+
+Examples
+--------
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace App\Adapter;
+
+use CleverAge\CacheProcessBundle\Adapter\Adapter;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+
+class MemoryAdapter extends Adapter
+{
+    public function __construct()
+    {
+        $cache = new ArrayAdapter();
+        parent::__construct($cache, 'memory');
+    }
+}
+```
+
+```yaml
+services:
+  app.cleverage_cache_process.adapter.memory:
+    class: App\Adapter\MemoryAdapter
+    tags:
+      - { name: cleverage.cache.adapter }
+```

docs/reference/tasks/get_task.md

@@ -0,0 +1,44 @@
+GetTask
+===============
+
+Get data from cache adapter.
+
+Adapter reference
+--------------
+
+* [Documentation](../adapter.md)
+
+Task reference
+--------------
+
+* **Task Service**: `CleverAge\CacheProcessBundle\Task\GetTask`
+
+Accepted inputs
+---------------
+
+`array`: inputs are merged with task defined options.
+
+Possible outputs
+----------------
+
+`mixed` or `null`: the content of the cache key.
+
+Options
+-------
+
+| Code      | Type     | Required | Default  | Description                                                                |
+|-----------|----------|:--------:|----------|----------------------------------------------------------------------------|
+| `adapter` | `string` |  **X**   |          | `CleverAge\CacheProcessBundle\Adapter\AdapterInterface` service identifier |
+| `key`     | `string` |  **X**   |          | index where retrieving data                                                |
+
+Examples
+--------
+
+```yaml
+# Task configuration level
+code:
+  service: '@CleverAge\CacheProcessBundle\Task\GetTask'
+  options:
+    adapter: 'memory'
+    key: 'key2'
+```

docs/reference/tasks/set_task.md

@@ -0,0 +1,90 @@
+SetTask
+===============
+
+Set data on cache adapter.
+
+Adapter reference
+--------------
+
+* [Documentation](../adapter.md)
+
+Task reference
+--------------
+
+* **Task Service**: `CleverAge\CacheProcessBundle\Task\SetTask`
+
+Accepted inputs
+---------------
+
+`array`: inputs are merged with task defined options.
+
+Possible outputs
+----------------
+
+none
+
+Options
+-------
+
+| Code      | Type     | Required | Default  | Description                                                                |
+|-----------|----------|:--------:|----------|----------------------------------------------------------------------------|
+| `adapter` | `string` |  **X**   |          | `CleverAge\CacheProcessBundle\Adapter\AdapterInterface` service identifier |
+| `key`     | `string` |  **X**   |          | index where storing data                                                   |
+| `value`   | `mixed`  |  **X**   |          | data to store                                                              |
+
+Examples
+--------
+
+```yaml
+# Task configuration level
+code:
+  set:
+    service: '@CleverAge\CacheProcessBundle\Task\SetTask'
+    options:
+      adapter: 'memory'
+      key: 'key1'
+      value:
+        - column1: value1-1
+          column2: value2-1
+          column3: value3-1
+```
+
+```yaml
+# Task configuration level
+code:
+  data:
+    service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
+    outputs: [ format ]
+    options:
+      output:
+        - key: 'key1'
+          column1: value1-1
+          column2: value2-1
+          column3: value3-1
+        - key: 'key2'
+          column1: value1-2
+          column2: value2-2
+          column3: value3-2
+        - key: 'key3'
+          column1: ''
+          column2: null
+          column3: value3-3
+  format:
+    service: '@CleverAge\ProcessBundle\Task\TransformerTask'
+    options:
+      transformers:
+        mapping:
+          mapping:
+            key:
+              code: '[key]'
+            value:
+              code: '.'
+    outputs: [ set ]
+
+  set:
+    service: '@CleverAge\CacheProcessBundle\Task\SetTask'
+    options:
+      adapter: 'memory'
+      key: '' # overrided by input'
+      value: '' # overrided by input
+```