Skip to content

Commit debeec0

Browse files
njoubert-cleveragenjoubert-cleverage
committed
#145 Add/Update docs
1 parent dafe5b3 commit debeec0

18 files changed

+410
-270
lines changed

‎docs/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
- [CsvReaderTask](reference/tasks/csv_reader_task.md)
4545
- [CsvWriterTask](reference/tasks/csv_writer_task.md)
4646
- [CSVSplitterTask]
47-
- [InputCsvReaderTask]
47+
- [InputCsvReaderTask](reference/tasks/input_csv_reader_task.md)
4848
- File/JsonStream
4949
- [JsonStreamReaderTask]
5050
- File/XML
@@ -79,7 +79,7 @@
7979
- [ProcessLauncherTask]
8080
- Reporting
8181
- [AdvancedStatCounterTask]
82-
- [LoggerTask]
82+
- [LoggerTask](reference/tasks/logger_task.md)
8383
- [StatCounterTask]
8484
- Transformers
8585
- Basic and debug
@@ -120,8 +120,8 @@
120120
- String
121121
- [ExplodeTransformer]
122122
- [HashTransformer]
123-
- [ImplodeTransformer]
124-
- [SlugifyTransformer]
123+
- [ImplodeTransformer](reference/transformers/implode_transformer.md)
124+
- [SlugifyTransformer](reference/transformers/slugify_transformer.md)
125125
- [SprintfTransformer]
126126
- [TrimTransformer](reference/transformers/trim_transformer.md)
127127
- XML

‎docs/reference/tasks/constant_iterable_output_task.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,12 @@ Example
2929
-------
3030

3131
```yaml
32-
clever_age_process:
33-
configurations:
34-
project_prefix.constant_iterable_output_example:
35-
tasks:
36-
constant_iterable_output_example:
37-
service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
38-
options:
39-
output:
40-
id: 123
41-
firstname: Test1
42-
lastname: Test2
43-
outputs: [debug]
44-
debug:
45-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
46-
```
32+
# Task configuration level
33+
code:
34+
service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
35+
options:
36+
output:
37+
id: 123
38+
firstname: Test1
39+
lastname: Test2
40+
```

‎docs/reference/tasks/constant_output_task.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,12 @@ Example
2929
-------
3030

3131
```yaml
32-
clever_age_process:
33-
configurations:
34-
project_prefix.constant_output_example:
35-
tasks:
36-
constant_output_example:
37-
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
38-
options:
39-
output:
40-
id: 123
41-
firstname: Test1
42-
lastname: Test2
43-
outputs: [debug]
44-
debug:
45-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
46-
```
32+
# Task configuration level
33+
code:
34+
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
35+
options:
36+
output:
37+
id: 123
38+
firstname: Test1
39+
lastname: Test2
40+
```

‎docs/reference/tasks/counter_task.md

+7-24
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Task reference
1313
Accepted inputs
1414
---------------
1515

16-
`any`
16+
`any`, must implement IterableTaskInterface
1717

1818
Possible outputs
1919
----------------
@@ -31,26 +31,9 @@ Example
3131
-------
3232

3333
```yaml
34-
clever_age_process:
35-
configurations:
36-
project_prefix.counter_example:
37-
tasks:
38-
counter_example:
39-
service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
40-
options:
41-
output:
42-
test1: test1
43-
test2: test2
44-
test3: test3
45-
test4: test4
46-
test5: test5
47-
test6: test6
48-
outputs: [counter]
49-
counter:
50-
service: '@CleverAge\ProcessBundle\Task\CounterTask'
51-
options:
52-
flush_every: 2
53-
outputs: [ debug ]
54-
debug:
55-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
56-
```
34+
# Task configuration level
35+
code:
36+
service: '@CleverAge\ProcessBundle\Task\CounterTask'
37+
options:
38+
flush_every: 2
39+
```

‎docs/reference/tasks/csv_reader_task.md

+23-9
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,26 @@ Underlying method is [fgetcsv](https://secure.php.net/manual/en/function.fgetcsv
2323
Options
2424
-------
2525

26-
| Code | Type | Required | Default | Description |
27-
| ---- | ---- | :------: | ------- | ----------- |
28-
| `file_path` | `string` | **X** | | Path of the file to read from (relative to symfony root or absolute) |
29-
| `delimiter` | `string` | | `;` | CSV delimiter |
30-
| `enclosure` | `string` | | `"` | CSV enclosure character |
31-
| `escape` | `string` | | `\\` | CSV escape character |
32-
| `headers` | `array` or `null` | | `null` | Static list of CSV headers, without the option, it will be dynamically read from first input |
33-
| `mode` | `string` | | `rb` | File open mode (see [fopen mode parameter](https://secure.php.net/manual/en/function.fopen.php)) |
34-
| `log_empty_lines` | `bool` | | `false` | Log when the output is empty |
26+
| Code | Type | Required | Default | Description |
27+
|-------------------|-------------------|:---------:|----------|--------------------------------------------------------------------------------------------------|
28+
| `file_path` | `string` | **X** | | Path of the file to read from (relative to symfony root or absolute) |
29+
| `delimiter` | `string` | | `;` | CSV delimiter |
30+
| `enclosure` | `string` | | `"` | CSV enclosure character |
31+
| `escape` | `string` | | `\\` | CSV escape character |
32+
| `headers` | `array` or `null` | | `null` | Static list of CSV headers, without the option, it will be dynamically read from first input |
33+
| `mode` | `string` | | `rb` | File open mode (see [fopen mode parameter](https://secure.php.net/manual/en/function.fopen.php)) |
34+
| `log_empty_lines` | `bool` | | `false` | Log when the output is empty |
35+
36+
Example
37+
-------
38+
39+
```yaml
40+
# Task configuration level
41+
code:
42+
service: '@CleverAge\ProcessBundle\Task\File\Csv\CsvReaderTask'
43+
options:
44+
file_path: 'path/to/file.csv'
45+
delimiter: '{{ delimiter }}' ## delimiter is contextualized you must add -c delimiter:";" on console execute
46+
```
47+
48+

‎docs/reference/tasks/debug_task.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,21 @@ Possible outputs
2020

2121
`any`: re-output given input
2222

23+
Options
24+
-------
25+
26+
None
27+
2328
Example
2429
----------------
2530

2631
```yaml
27-
clever_age_process:
28-
configurations:
29-
project_prefix.debug_example:
30-
tasks:
31-
debug_example:
32-
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
33-
options:
34-
output:
35-
id: 123
36-
firstname: Test1
37-
lastname: Test2
38-
outputs: [debug]
39-
debug:
40-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
41-
```
32+
# Task configuration level
33+
code:
34+
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
35+
options:
36+
output:
37+
id: 123
38+
firstname: Test1
39+
lastname: Test2
40+
```

‎docs/reference/tasks/die_task.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,16 @@ Possible outputs
1919

2020
None
2121

22+
Options
23+
-------
24+
25+
None
26+
2227
Example
2328
----------------
2429

2530
```yaml
26-
clever_age_process:
27-
configurations:
28-
project_prefix.die_example:
29-
tasks:
30-
die_example:
31-
service: '@CleverAge\ProcessBundle\Task\Debug\DieTask'
32-
```
31+
# Task configuration level
32+
code:
33+
service: '@CleverAge\ProcessBundle\Task\Debug\DieTask'
34+
```

‎docs/reference/tasks/dummy_task.md

+24-26
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,31 @@ Possible outputs
1818

1919
`any`: re-output given input
2020

21+
Options
22+
-------
23+
24+
None
25+
2126
Example
2227
-------
2328

2429
```yaml
25-
clever_age_process:
26-
configurations:
27-
project_prefix.dummy_example:
28-
tasks:
29-
dummy_example:
30-
service: '@CleverAge\ProcessBundle\Task\DummyTask'
31-
outputs: [output1, output2]
32-
output1:
33-
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
34-
options:
35-
output:
36-
id: 123
37-
firstname: Test1
38-
lastname: Test2
39-
outputs: [debug]
40-
output2:
41-
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
42-
options:
43-
output:
44-
id: 456
45-
firstname: Test3
46-
lastname: Test4
47-
outputs: [ debug ]
48-
debug:
49-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
50-
```
30+
# Task configuration level
31+
dummy:
32+
service: '@CleverAge\ProcessBundle\Task\DummyTask'
33+
outputs: [output1, output2]
34+
output1:
35+
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
36+
options:
37+
output:
38+
id: 123
39+
firstname: Test1
40+
lastname: Test2
41+
output2:
42+
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
43+
options:
44+
output:
45+
id: 456
46+
firstname: Test3
47+
lastname: Test4
48+
```

‎docs/reference/tasks/error_forwarder_task.md

+9-16
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,16 @@ Possible outputs
2020

2121
`any`: directly error_output given `output` option
2222

23+
Options
24+
-------
25+
26+
None
27+
2328
Example
2429
-------
2530

2631
```yaml
27-
clever_age_process:
28-
configurations:
29-
project_prefix.error_forwarder_example:
30-
tasks:
31-
error_forwarder_example:
32-
service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
33-
options:
34-
output:
35-
error1: Error 1
36-
error2: Error 2
37-
error3: Error 3
38-
outputs: [error_forwarder]
39-
error_forwarder:
40-
service: '@CleverAge\ProcessBundle\Task\Debug\ErrorForwarderTask'
41-
42-
```
32+
# Task configuration level
33+
code:
34+
service: '@CleverAge\ProcessBundle\Task\Debug\ErrorForwarderTask'
35+
```

‎docs/reference/tasks/event_dispatcher_task.md

+6-12
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,9 @@ Example
3131
-------
3232

3333
```yaml
34-
clever_age_process:
35-
configurations:
36-
project_prefix.event_dispatcher_example:
37-
tasks:
38-
event_dispatcher_example:
39-
service: '@CleverAge\ProcessBundle\Task\Event\EventDispatcherTask'
40-
options:
41-
event_name: 'myapp.myevent'
42-
outputs: [debug]
43-
debug:
44-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
45-
```
34+
# Task configuration level
35+
code:
36+
service: '@CleverAge\ProcessBundle\Task\Event\EventDispatcherTask'
37+
options:
38+
event_name: 'myapp.myevent'
39+
```

‎docs/reference/tasks/input_csv_reader_task.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
InputCsvReaderTask
2+
=============
3+
4+
Reads a CSV file and iterate on each line, returning an array of key -> values. Skips empty lines.
5+
6+
Task reference
7+
--------------
8+
9+
* **Service**: `CleverAge\ProcessBundle\Task\File\Csv\InputCsvReaderTask`
10+
* **Iterable task**
11+
12+
Accepted inputs
13+
---------------
14+
15+
`string`: file path
16+
17+
Possible outputs
18+
----------------
19+
20+
`array`: foreach line, it will return a php array where key comes from headers and values are strings.
21+
Underlying method is [fgetcsv](https://secure.php.net/manual/en/function.fgetcsv.php).
22+
23+
Options
24+
-------
25+
26+
Same as [CsvReaderTask](reference/tasks/csv_reader_task.md) except following :
27+
28+
| Code | Type | Required | Default | Description |
29+
|-------------|----------|:--------:|---------|----------------------------|
30+
| `file_path` | | | | Removed, use input instead |
31+
| `base_path` | `string` | | `` | |
32+
33+
Example
34+
-------
35+
36+
```yaml
37+
clever_age_process:
38+
configurations:
39+
process.name:
40+
entry_point: entrypoint # for upload_and_run process entry_point is required
41+
tasks:
42+
entrypoint:
43+
service: '@CleverAge\ProcessBundle\Task\File\Csv\InputCsvReaderTask'
44+
options:
45+
delimiter: '{{ delimiter }}' ## delimiter is contextualized you must add -c delimiter:";" on console execute
46+
```

0 commit comments

Comments
 (0)