Skip to content

Commit 751f49a

Browse files
author
Xavier Marchegay
committedDec 16, 2024
#13 add DoctrineReaderTask documentation
1 parent 3520d2a commit 751f49a

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed
 

‎docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ CleverAge\DoctrineProcessBundle\CleverAgeDoctrineProcessBundle::class => ['all'
2828
- [DoctrineBatchWriterTask](reference/tasks/doctrine_batchwriter_task.md)
2929
- [DoctrineCleanerTask](reference/tasks/doctrine_cleaner_task.md)
3030
- [DoctrineDetacherTask](reference/tasks/doctrine_detacher_task.md)
31-
- [DoctrineReaderTask]
31+
- [DoctrineReaderTask](reference/tasks/doctrine_reader_task.md)
3232
- [DoctrineRefresherTask](reference/tasks/doctrine_refresher_task.md)
3333
- [DoctrineRemoverTask](reference/tasks/doctrine_remover_task.md)
3434
- [DoctrineWriterTask](reference/tasks/doctrine_writer_task.md)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
DoctrineReaderTask
2+
==================
3+
4+
Reads Doctrine entity from a repository
5+
6+
Task reference
7+
--------------
8+
9+
* **Service**: `CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineReaderTask`
10+
11+
Accepted inputs
12+
---------------
13+
14+
None.
15+
16+
Possible outputs
17+
----------------
18+
19+
Outputs the result set of the entities.
20+
21+
Options
22+
-------
23+
24+
25+
| Code | Type | Required | Default | Description |
26+
|-------------------|--------------------|:--------:|-----------|------------------------------------------------|
27+
| `class_name` | `string` | **X** | `null` | Name of the class (e.g. : 'App\Entity\Author') |
28+
| `criteria` | `array` | | `[]` | Criteria of the query |
29+
| `order_by` | `array` | | `[]` | Order by of the query |
30+
| `limit` | `int` or `null` | | `null` | Result max count |
31+
| `offset` | `int` or `null` | | `null` | Result first item offset |
32+
| `empty_log_level` | `string` or `null` | | `warning` | Log level if the result set is empty |
33+
34+
35+
Example
36+
-------
37+
38+
```yaml
39+
entry:
40+
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineReaderTask'
41+
options:
42+
class_name: 'App\Entity\Author'
43+
criteria:
44+
lastname: 'King'
45+
order_by:
46+
lastname: 'asc'
47+
limit: 5
48+
offset: 3
49+
```

0 commit comments

Comments
 (0)