#13 add DoctrineCleanerTask documentation

docs/index.md

@@ -26,7 +26,7 @@ CleverAge\DoctrineProcessBundle\CleverAgeDoctrineProcessBundle::class => ['all'
   - [DatabaseUpdaterTask](reference/tasks/database_updater_task.md)
   - [ClearEntityManagerTask](reference/tasks/doctrine_clear_task.md))
   - [DoctrineBatchWriterTask](reference/tasks/doctrine_batchwriter_task.md)
-  - [DoctrineCleanerTask]
+  - [DoctrineCleanerTask](reference/tasks/doctrine_cleaner_task.md)
   - [DoctrineDetacherTask]
   - [DoctrineReaderTask]
   - [DoctrineRefresherTask]

docs/reference/tasks/doctrine_cleaner_task.md

@@ -0,0 +1,42 @@
+DoctrineCleanerTask
+====================
+
+Clear the entity manager of an entity.
+
+Task reference
+--------------
+
+* **Service**: `CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineCleanerTask`
+
+Accepted inputs
+---------------
+
+A doctrine 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: [clean]
+
+  clean:
+    service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineCleanerTask'
+```

docs/reference/tasks/doctrine_clear_task.md

@@ -21,7 +21,11 @@ None
 Options
 -------
 
-None
+| Code             | Type               | Required | Default | Description                                 |
+|------------------|--------------------|:--------:|---------|---------------------------------------------|
+| `entity_manager` | `string` or `null` |          | `null`  | Use another entity manager than the default |
+
+
 
 Example
 -------

src/Task/EntityManager/DoctrineCleanerTask.php

@@ -26,7 +26,7 @@ public function execute(ProcessState $state): void
     {
         $entity = $state->getInput();
         if (null === $entity) {
-            throw new \RuntimeException('DoctrineWriterTask does not allow null input');
+            throw new \RuntimeException('DoctrineCleanerTask does not allow null input');
         }
         /** @var object $entity */
         $class = ClassUtils::getClass($entity);