|
1
|
|
|
<?php |
|
2
|
|
|
declare(strict_types = 1); |
|
3
|
|
|
|
|
4
|
|
|
namespace AmmitPhp\Ammit\UI\Resolver; |
|
5
|
|
|
|
|
6
|
|
|
use AmmitPhp\Ammit\UI\Resolver\Validator\PragmaticRawValueValidator; |
|
7
|
|
|
use AmmitPhp\Ammit\UI\Resolver\Validator\PragmaticRequestAttributeValueValidator; |
|
8
|
|
|
use AmmitPhp\Ammit\UI\Resolver\Exception\CommandMappingException; |
|
9
|
|
|
use AmmitPhp\Ammit\UI\Resolver\Exception\UIValidationCollectionException; |
|
10
|
|
|
use AmmitPhp\Ammit\UI\Resolver\Validator\PragmaticRequestQueryStringValueValidator; |
|
11
|
|
|
use Psr\Http\Message\ServerRequestInterface; |
|
12
|
|
|
|
|
13
|
|
|
/** |
|
14
|
|
|
* Helper easing Command Resolver (mapping + UI Validation) implementation |
|
15
|
|
|
* @internal Contains Domain Validation assertions (but class won't be removed in next version) |
|
16
|
|
|
* Prefer using AbstractPureCommandResolver |
|
17
|
|
|
* Domain Validation should be done in Domain |
|
18
|
|
|
* Should be used for prototyping project knowing you are accumulating technical debt |
|
19
|
|
|
*/ |
|
20
|
|
View Code Duplication |
abstract class AbstractPragmaticCommandResolver |
|
|
|
|
|
|
21
|
|
|
{ |
|
22
|
|
|
/** @var UIValidationEngine */ |
|
23
|
|
|
protected $validationEngine; |
|
24
|
|
|
|
|
25
|
|
|
/** @var PragmaticRawValueValidator */ |
|
26
|
|
|
protected $rawValueValidator; |
|
27
|
|
|
|
|
28
|
|
|
/** @var PragmaticRequestAttributeValueValidator */ |
|
29
|
|
|
protected $attributeValueValidator; |
|
30
|
|
|
|
|
31
|
|
|
/** @var PragmaticRequestQueryStringValueValidator */ |
|
32
|
|
|
protected $queryStringValueValidator; |
|
33
|
|
|
|
|
34
|
|
|
public function __construct(UIValidationEngine $validationEngine = null, PragmaticRawValueValidator $rawValueValidator = null, PragmaticRequestAttributeValueValidator $attributeValueValidator = null, PragmaticRequestQueryStringValueValidator $queryStringValueValidator = null) |
|
35
|
|
|
{ |
|
36
|
1 |
|
if (null === $validationEngine) { |
|
37
|
1 |
|
$validationEngine = UIValidationEngine::initialize(); |
|
38
|
|
|
} |
|
39
|
|
|
|
|
40
|
1 |
|
if (null === $rawValueValidator) { |
|
41
|
1 |
|
$rawValueValidator = new PragmaticRawValueValidator($validationEngine); |
|
42
|
|
|
} |
|
43
|
|
|
|
|
44
|
1 |
|
if (null === $attributeValueValidator) { |
|
45
|
1 |
|
$attributeValueValidator = new PragmaticRequestAttributeValueValidator( |
|
46
|
|
|
$rawValueValidator |
|
47
|
|
|
); |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
1 |
|
if (null === $queryStringValueValidator) { |
|
51
|
1 |
|
$queryStringValueValidator = new PragmaticRequestQueryStringValueValidator( |
|
52
|
|
|
$rawValueValidator |
|
53
|
|
|
); |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
1 |
|
$this->validationEngine = $validationEngine; |
|
57
|
1 |
|
$this->rawValueValidator = $rawValueValidator; |
|
58
|
1 |
|
$this->attributeValueValidator = $attributeValueValidator; |
|
59
|
1 |
|
$this->queryStringValueValidator = $queryStringValueValidator; |
|
60
|
1 |
|
} |
|
61
|
|
|
|
|
62
|
|
|
/** |
|
63
|
|
|
* @api |
|
64
|
|
|
* Create a Command from a Request |
|
65
|
|
|
* Perform the UI Validation (simple validation) |
|
66
|
|
|
* Complex Validation will be done in the Domain |
|
67
|
|
|
* @param ServerRequestInterface $request PSR7 Request |
|
68
|
|
|
* |
|
69
|
|
|
* @return object Immutable Command (DTO) |
|
70
|
|
|
* @throws UIValidationCollectionException If any Validation fail |
|
71
|
|
|
*/ |
|
72
|
|
|
abstract public function resolve(ServerRequestInterface $request); |
|
73
|
|
|
|
|
74
|
|
|
/** |
|
75
|
|
|
* @api |
|
76
|
|
|
* Map a Command attributes from a Request into an array |
|
77
|
|
|
* Perform the UI Validation (simple validation) |
|
78
|
|
|
* |
|
79
|
|
|
* @return mixed[] Attributes used to create the Command |
|
80
|
|
|
* @throws CommandMappingException If any mapping validation failed |
|
81
|
|
|
* @throws UIValidationCollectionException If any UI validation failed |
|
82
|
|
|
*/ |
|
83
|
|
|
protected function resolveRequestAsArray(ServerRequestInterface $request): array |
|
84
|
|
|
{ |
|
85
|
1 |
|
$values = $this->validateThenMapAttributes( |
|
86
|
|
|
$request |
|
87
|
|
|
); |
|
88
|
|
|
|
|
89
|
1 |
|
$this->validationEngine->guardAgainstAnyUIValidationException(); |
|
90
|
|
|
|
|
91
|
1 |
|
return $values; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* @api |
|
96
|
|
|
* Resolve implementation |
|
97
|
|
|
* @param ServerRequestInterface $request PSR-7 Request |
|
98
|
|
|
* |
|
99
|
|
|
* @return mixed[] |
|
100
|
|
|
*/ |
|
101
|
|
|
abstract protected function validateThenMapAttributes(ServerRequestInterface $request): array; |
|
102
|
|
|
} |
|
103
|
|
|
|
ammit-php /
ammit
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.