|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Psi\Component\Description; |
|
6
|
|
|
|
|
7
|
|
|
use Psi\Component\Description\Schema\Schema; |
|
8
|
|
|
|
|
9
|
|
|
/** |
|
10
|
|
|
* This class is the main point of entry for this component. |
|
11
|
|
|
* |
|
12
|
|
|
* It provides descriptions for objects. Descriptions are populated by |
|
13
|
|
|
* "enhancers" as given in the constructor. The order of the enhancers is important |
|
14
|
|
|
*/ |
|
15
|
|
|
class DescriptionFactory |
|
16
|
|
|
{ |
|
17
|
|
|
/** |
|
18
|
|
|
* @var DescriptionEnhancerInterface[] |
|
19
|
|
|
*/ |
|
20
|
|
|
private $enhancers = []; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* @var SubjectResolverInterface[] |
|
24
|
|
|
*/ |
|
25
|
|
|
private $resolvers = []; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* @var Schema |
|
29
|
|
|
*/ |
|
30
|
|
|
private $schema; |
|
31
|
|
|
|
|
32
|
|
|
public function __construct(array $enhancers, Schema $schema = null, array $resolvers = []) |
|
33
|
|
|
{ |
|
34
|
|
|
// type safety ... |
|
35
|
|
|
array_walk($enhancers, function (EnhancerInterface $enhancer) { |
|
|
|
|
|
|
36
|
|
|
}); |
|
37
|
|
|
array_walk($resolvers, function (SubjectResolverInterface $enhancer) { |
|
|
|
|
|
|
38
|
|
|
}); |
|
39
|
|
|
|
|
40
|
|
|
$this->enhancers = $enhancers; |
|
41
|
|
|
$this->resolvers = $resolvers; |
|
42
|
|
|
$this->schema = $schema; |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* Return a description of the given subject. |
|
47
|
|
|
*/ |
|
48
|
|
|
public function describe(Subject $subject): DescriptionInterface |
|
49
|
|
|
{ |
|
50
|
|
|
$description = $this->createDescription(); |
|
51
|
|
|
|
|
52
|
|
|
foreach ($this->resolvers as $resolver) { |
|
53
|
|
|
$subject = $resolver->resolve($subject); |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
foreach ($this->enhancers as $enhancer) { |
|
57
|
|
|
if (false === $enhancer->supports($subject)) { |
|
58
|
|
|
continue; |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
$enhancer->enhanceFromClass($description, $subject->getClass()); |
|
62
|
|
|
|
|
63
|
|
|
if ($subject->hasObject()) { |
|
64
|
|
|
$enhancer->enhanceFromObject($description, $subject); |
|
65
|
|
|
} |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
|
|
return $description; |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
private function createDescription(): DescriptionInterface |
|
72
|
|
|
{ |
|
73
|
|
|
$description = new Description(); |
|
74
|
|
|
|
|
75
|
|
|
if ($this->schema) { |
|
76
|
|
|
$description = new ValidatedDescription($description, $this->schema); |
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
return $description; |
|
80
|
|
|
} |
|
81
|
|
|
} |
|
82
|
|
|
|
psiphp /
description
Loading history...
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.