-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathCounterTask.php
More file actions
86 lines (80 loc) · 2.35 KB
/
Copy pathCounterTask.php
File metadata and controls
86 lines (80 loc) · 2.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<?php declare(strict_types=1);
/*
* This file is part of the CleverAge/ProcessBundle package.
*
* Copyright (C) 2017-2021 Clever-Age
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace CleverAge\ProcessBundle\Task;
use CleverAge\ProcessBundle\Model\AbstractConfigurableTask;
use CleverAge\ProcessBundle\Model\FlushableTaskInterface;
use CleverAge\ProcessBundle\Model\ProcessState;
use Symfony\Component\OptionsResolver\OptionsResolver;
/**
* Outputs periodically the number of time this task is called.
*
* Count the number of times the task is processed and continue every N iteration (skip the rest of the time)
* Flush at the end with the actual count.
*
* It can be useful for batch like workflow.
* See also {@see IterableBatchTask}.
*
* ##### Task reference
*
* * **Service**: `CleverAge\ProcessBundle\Task\CounterTask`
* * **Flushable task**
* * **Input**: _ignored_
* * **Output**: `int`, the number of time this task is called
*
* ##### Options
*
* * `flush_every` (`int`, _required_): the period at which the task will produce outputs
*
* @author Vincent Chalnot <vchalnot@clever-age.com>
*/
class CounterTask extends AbstractConfigurableTask implements FlushableTaskInterface
{
/** @var int */
protected $counter = 0;
/**
* @param ProcessState $state
*/
public function execute(ProcessState $state): void
{
$this->counter++;
$modulo = $this->getOption($state, 'flush_every');
if (0 === $this->counter % $modulo) {
$state->setOutput($this->counter);
} else {
$state->setSkipped(true);
}
}
/**
* Condition is inversed during flush
*
* @param ProcessState $state
*/
public function flush(ProcessState $state): void
{
$modulo = $this->getOption($state, 'flush_every');
if (0 === $this->counter % $modulo) {
$state->setSkipped(true);
} else {
$state->setOutput($this->counter);
}
}
/**
* @param OptionsResolver $resolver
*/
protected function configureOptions(OptionsResolver $resolver): void
{
$resolver->setRequired(
[
'flush_every',
]
);
$resolver->setAllowedTypes('flush_every', ['int']);
}
}