-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathAbstractConfigurableTask.php
More file actions
80 lines (71 loc) · 2.09 KB
/
Copy pathAbstractConfigurableTask.php
File metadata and controls
80 lines (71 loc) · 2.09 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
<?php declare(strict_types=1);
/*
* This file is part of the CleverAge/ProcessBundle package.
*
* Copyright (c) 2017-2023 Clever-Age
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace CleverAge\ProcessBundle\Model;
use Symfony\Component\OptionsResolver\Exception\ExceptionInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
/**
* Allow the task to configure it's options, set default basic options for errors handling
*
* @author Valentin Clavreul <vclavreul@clever-age.com>
* @author Vincent Chalnot <vchalnot@clever-age.com>
*/
abstract class AbstractConfigurableTask implements InitializableTaskInterface
{
/** @var array */
protected $options;
/**
* Only validate the options at initialization, ensuring that the task will not fail at runtime
*
* @param ProcessState $state
*
* @throws ExceptionInterface
*/
public function initialize(ProcessState $state)
{
$this->getOptions($state);
}
/**
* @param ProcessState $state
*
* @throws ExceptionInterface
*
* @return array
*/
protected function getOptions(ProcessState $state)
{
if (null === $this->options) {
$resolver = new OptionsResolver();
$this->configureOptions($resolver);
$this->options = $resolver->resolve($state->getContextualizedOptions());
}
return $this->options;
}
/**
* @param ProcessState $state
* @param string $code
*
* @throws \InvalidArgumentException
* @throws ExceptionInterface
*
* @return mixed
*/
protected function getOption(ProcessState $state, $code)
{
$options = $this->getOptions($state);
if (!array_key_exists($code, $options)) {
throw new \InvalidArgumentException("Missing option {$code}");
}
return $options[$code];
}
/**
* @param OptionsResolver $resolver
*/
abstract protected function configureOptions(OptionsResolver $resolver);
}