-
Notifications
You must be signed in to change notification settings - Fork 1
/
Documentation.php
165 lines (146 loc) · 4.02 KB
/
Documentation.php
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<?php
declare(strict_types=1);
namespace Adlarge\FixturesDocumentationBundle\Model;
use Adlarge\FixturesDocumentationBundle\Exception\DuplicateFixtureException;
use Symfony\Component\PropertyAccess\PropertyAccess;
use TypeError;
use function array_key_exists;
class Documentation
{
/**
* List of sections in the doc.
*
* @var Section[]
*/
private $sections = [];
/**
* @var array
*/
private $configEntities;
/**
* Documentation constructor.
*
* @param string $jsonString
* @throws DuplicateFixtureException
*/
public function __construct(array $configEntities, string $jsonString = null)
{
$this->configEntities = $configEntities;
if ($jsonString) {
$this->init($jsonString);
}
}
/**
* Create the documentation from jsonFile.
*
* @param string $jsonString
* @throws DuplicateFixtureException
*/
protected function init(string $jsonString): void
{
$doc = json_decode($jsonString, true);
foreach ($doc as $sectionTitle => $section) {
foreach ($section['fixtures'] as $item) {
$this->addFixture($sectionTitle, $item);
}
}
}
/**
* @return Section[]
*/
public function getSections(): array
{
return $this->sections;
}
/**
* Add a fixture to the documentation.
*
* @param string $sectionTitle
* @param array $fixture
*
* @return Documentation
*
* @throws DuplicateFixtureException
*/
public function addFixture(string $sectionTitle, array $fixture): self
{
if (count($fixture) !== count($fixture, COUNT_RECURSIVE)) {
throw new TypeError('A fixture can\'t be a multidimensional array.');
}
$section = $this->addSection($sectionTitle);
$section->addFixture($fixture);
return $this;
}
/**
* Add a fixture to the documentation when passing directly the entity.
* Use configEntites and their property to create the array of value
* to pass to addFixture method
*
* @param object $entity
*
* @return Documentation
*
* @throws DuplicateFixtureException
*/
public function addFixtureEntity(object $entity): self
{
$className = (new \ReflectionClass($entity))->getShortName();
if (array_key_exists($className, $this->configEntities)) {
$propertyAccessor = PropertyAccess::createPropertyAccessor();
/** @var array $properties */
$properties = $this->configEntities[$className];
$fixture = [];
foreach ($properties as $property) {
$value = $propertyAccessor->getValue($entity, $property);
if (is_scalar($value)) {
$fixture[$property] = $value;
}
}
$this->addFixture($className, $fixture);
}
return $this;
}
/**
* Reset the documentation by removing all sections.
*
* @return Documentation
*/
public function reset(): self
{
$this->sections = [];
return $this;
}
/**
* Convert the documentation to json.
*
* @return string
*/
public function toJson(): string
{
$doc = [];
foreach ($this->getSections() as $section) {
foreach ($section->getFixtures() as $fixture) {
$doc[$section->getTitle()]['fixtures'][] = $fixture;
}
}
return json_encode($doc);
}
/**
* Add a section to the documentation
*
* @param string $sectionTitle
*
* @return Section
*/
private function addSection(string $sectionTitle): Section
{
foreach ($this->sections as $section) {
if ($section->getTitle() === $sectionTitle) {
return $section;
}
}
$section = new Section($sectionTitle);
$this->sections[] = $section;
return $section;
}
}