#13 add DoctrineRefresherTask, DoctrineDetacherTask and DoctrineRemoverTask documentation

Author: Xavier Marchegay

docs/index.md

@@ -27,8 +27,8 @@ CleverAge\DoctrineProcessBundle\CleverAgeDoctrineProcessBundle::class => ['all'
   - [ClearEntityManagerTask](reference/tasks/doctrine_clear_task.md))
   - [DoctrineBatchWriterTask](reference/tasks/doctrine_batchwriter_task.md)
   - [DoctrineCleanerTask](reference/tasks/doctrine_cleaner_task.md)
-  - [DoctrineDetacherTask]
+  - [DoctrineDetacherTask](reference/tasks/doctrine_detacher_task.md)
   - [DoctrineReaderTask]
-  - [DoctrineRefresherTask]
-  - [DoctrineRemoverTask]
+  - [DoctrineRefresherTask](reference/tasks/doctrine_refresher_task.md)
+  - [DoctrineRemoverTask](reference/tasks/doctrine_remover_task.md)
   - [DoctrineWriterTask](reference/tasks/doctrine_writer_task.md)

docs/reference/tasks/doctrine_detacher_task.md

@@ -0,0 +1,41 @@
+DoctrineDetacherTask
+====================
+
+Detach a Doctrine entity from the entity manager
+
+Task reference
+--------------
+
+* **Service**: `CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineDetacherTask`
+
+Accepted inputs
+---------------
+
+Any doctrine managed entity.
+
+Possible outputs
+----------------
+
+None
+
+Options
+-------
+
+None
+
+Example
+-------
+
+```yaml
+entry:
+  service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineReaderTask'
+  options:
+    class_name: 'App\Entity\Author'
+    criteria:
+      lastname: 'King'
+    order_by:
+      lastname: 'asc'
+  outputs: [detach]
+detach:
+  service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineDetacherTask'
+```

docs/reference/tasks/doctrine_refresher_task.md

@@ -0,0 +1,48 @@
+DoctrineRefresherTask
+=====================
+
+Refreshes a Doctrine entity from the entity manager
+
+Task reference
+--------------
+
+* **Service**: `CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineRefresherTask`
+
+Accepted inputs
+---------------
+
+Any doctrine managed entity.
+
+Possible outputs
+----------------
+
+The refreshed entity
+
+Options
+-------
+
+None
+
+Example
+-------
+
+```yaml
+entry:
+  service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineReaderTask'
+  options:
+    class_name: 'App\Entity\Author'
+    criteria:
+      lastname: 'King'
+    order_by:
+      lastname: 'asc'
+  outputs: [modify]
+modify:
+  service: '@CleverAge\ProcessBundle\Task\PropertySetterTask'
+  options:
+      values:
+        firstname: Gérard
+  outputs: [refresh]
+refresh:
+    service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineRefresherTask'
+    outputs: [dump_refreshed]
+```

docs/reference/tasks/doctrine_remover_task.md

@@ -0,0 +1,42 @@
+DoctrineRemoverTask
+===================
+
+Removes a Doctrine entity from the entity manager then flushes
+
+Task reference
+--------------
+
+* **Service**: `CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineRemoverTask`
+
+Accepted inputs
+---------------
+
+Any doctrine managed entity.
+
+Possible outputs
+----------------
+
+None
+
+Options
+-------
+
+None
+
+Example
+-------
+
+```yaml
+entry:
+  service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineReaderTask'
+  options:
+    class_name: 'App\Entity\Book'
+    criteria:
+      title: 'Dracula'
+  outputs: [dump]
+  dump:
+    service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
+    outputs: [remover]
+  remover:
+    service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineRemoverTask'
+```

docs/reference/tasks/doctrine_writer_task.md

@@ -21,7 +21,31 @@ Re-output given entity.
 Options
 -------
 
-| Code | Type | Required | Default | Description |
-| ---- | ---- | :------: | ------- | ----------- |
-| `entity_manager` | `string` or `null` | | `null` | Use another entity manager than the default |
+None
 
+Example
+-------
+
+```yaml
+entry:
+  service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
+  options:
+    output:
+      firstname: Isaac
+      lastname: Asimov
+  outputs: [denormalize]
+  denormalize:
+    service: '@CleverAge\ProcessBundle\Task\Serialization\DenormalizerTask'
+    options:
+      class: App\Entity\Author
+    outputs: [save]
+  save:
+    service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineWriterTask'
+    outputs: [fetch]
+  fetch:
+    service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineReaderTask'
+    options:
+      class_name: 'App\Entity\Author'
+      criteria:
+        lastname: 'Asimov'
+```

src/Task/EntityManager/DoctrineRefresherTask.php

@@ -18,7 +18,7 @@
 use Doctrine\ORM\EntityManagerInterface;
 
 /**
- * Detach Doctrine entities from unit of work.
+ * Refreshes a Doctrine entity from the database.
  */
 class DoctrineRefresherTask extends AbstractDoctrineTask
 {