Repository navigation
Expand file tree
/
Copy pathCounterTask.php
More file actions
88 lines (76 loc) · 2.83 KB
/
Copy pathCounterTask.php
File metadata and controls
88 lines (76 loc) · 2.83 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
87
88
<?php
declare(strict_types=1);
/*
* This file is part of the CleverAge/ProcessBundle package.
*
* Copyright (c) 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\Exception\InvalidOptionsException;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;
/**
* 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.
*
* @final since 5.4
*/
class CounterTask extends AbstractConfigurableTask implements FlushableTaskInterface
{
protected int $counter = 0;
/**
* Count already outputted by a flush, as flush() may be called several times.
*/
protected ?int $flushedCounter = null;
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.
*/
public function flush(ProcessState $state): void
{
$modulo = $this->getOption($state, 'flush_every');
if (0 === $this->counter % $modulo || $this->counter === $this->flushedCounter) {
$state->setSkipped(true);
return;
}
$this->flushedCounter = $this->counter;
$state->setOutput($this->counter);
}
protected function configureOptions(OptionsResolver $resolver): void
{
$resolver->setRequired(['flush_every']);
$resolver->setAllowedTypes('flush_every', ['int']);
$resolver->setNormalizer('flush_every', static function (Options $options, int $value): int {
// Modulo by zero
if (0 === $value) {
throw new InvalidOptionsException('The option "flush_every" of the counter task must be a positive integer (the count is output every "flush_every" executions), 0 given.');
}
// Works as its absolute value (sign of the modulo)
if ($value < 0) {
trigger_deprecation(
'cleverage/process-bundle',
'5.10',
'A negative "flush_every" option of the counter task (%d) is deprecated, it works as %d: use a positive integer. It will be rejected in v6.0.',
$value,
-$value,
);
}
return $value;
});
}
}