1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Apie\CorePlugin; |
4
|
|
|
|
5
|
|
|
use Apie\Core\Interfaces\ApiResourceFactoryInterface; |
6
|
|
|
use Apie\Core\Interfaces\FormatRetrieverInterface; |
7
|
|
|
use Apie\Core\Interfaces\ResourceSerializerInterface; |
8
|
|
|
use Apie\Core\PluginInterfaces\AnnotationReaderProviderInterface; |
9
|
|
|
use Apie\Core\PluginInterfaces\ApieAwareInterface; |
10
|
|
|
use Apie\Core\PluginInterfaces\ApieAwareTrait; |
11
|
|
|
use Apie\Core\PluginInterfaces\ApiResourceFactoryProviderInterface; |
12
|
|
|
use Apie\Core\PluginInterfaces\CacheItemPoolProviderInterface; |
13
|
|
|
use Apie\Core\PluginInterfaces\EncoderProviderInterface; |
14
|
|
|
use Apie\Core\PluginInterfaces\NormalizerProviderInterface; |
15
|
|
|
use Apie\Core\PluginInterfaces\ObjectAccessProviderInterface; |
16
|
|
|
use Apie\Core\PluginInterfaces\ResourceLifeCycleInterface; |
17
|
|
|
use Apie\Core\PluginInterfaces\SerializerProviderInterface; |
18
|
|
|
use Apie\Core\PluginInterfaces\SymfonyComponentProviderInterface; |
19
|
|
|
use Apie\CorePlugin\Encodings\FormatRetriever; |
20
|
|
|
use Apie\CorePlugin\Mapping\BaseGroupLoader; |
21
|
|
|
use Apie\CorePlugin\ObjectAccess\ExceptionObjectAccess; |
22
|
|
|
use Apie\CorePlugin\ResourceFactories\FallbackFactory; |
23
|
|
|
use Apie\CorePlugin\ResourceSerializers\SymfonySerializerAdapter; |
24
|
|
|
use Apie\ObjectAccessNormalizer\Normalizers\ApieObjectAccessNormalizer; |
25
|
|
|
use Apie\ObjectAccessNormalizer\Normalizers\MethodCallDenormalizer; |
26
|
|
|
use Apie\ObjectAccessNormalizer\ObjectAccess\ObjectAccessInterface; |
27
|
|
|
use Apie\ObjectAccessNormalizer\ObjectAccess\SelfObjectAccess; |
28
|
|
|
use Apie\ObjectAccessNormalizer\ObjectAccess\SelfObjectAccessInterface; |
29
|
|
|
use Doctrine\Common\Annotations\AnnotationReader; |
30
|
|
|
use Doctrine\Common\Annotations\AnnotationRegistry; |
31
|
|
|
use Doctrine\Common\Annotations\CachedReader; |
32
|
|
|
use Doctrine\Common\Annotations\Reader; |
33
|
|
|
use Doctrine\Common\Cache\PhpFileCache; |
34
|
|
|
use Psr\Cache\CacheItemPoolInterface; |
35
|
|
|
use Symfony\Component\Cache\Adapter\ArrayAdapter; |
|
|
|
|
36
|
|
|
use Symfony\Component\Serializer\Encoder\JsonDecode; |
37
|
|
|
use Symfony\Component\Serializer\Encoder\JsonEncode; |
38
|
|
|
use Symfony\Component\Serializer\Encoder\JsonEncoder; |
39
|
|
|
use Symfony\Component\Serializer\Encoder\XmlEncoder; |
40
|
|
|
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory; |
41
|
|
|
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface; |
42
|
|
|
use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader; |
43
|
|
|
use Symfony\Component\Serializer\Mapping\Loader\LoaderChain; |
44
|
|
|
use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter; |
45
|
|
|
use Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter; |
46
|
|
|
use Symfony\Component\Serializer\NameConverter\NameConverterInterface; |
47
|
|
|
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer; |
48
|
|
|
use Symfony\Component\Serializer\Normalizer\JsonSerializableNormalizer; |
49
|
|
|
use Symfony\Component\Serializer\Serializer; |
50
|
|
|
use Throwable; |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* Plugin with most default functionality. |
54
|
|
|
*/ |
55
|
|
|
class CorePlugin implements SerializerProviderInterface, |
56
|
|
|
ApieAwareInterface, |
57
|
|
|
NormalizerProviderInterface, |
58
|
|
|
EncoderProviderInterface, |
59
|
|
|
SymfonyComponentProviderInterface, |
60
|
|
|
CacheItemPoolProviderInterface, |
61
|
|
|
AnnotationReaderProviderInterface, |
62
|
|
|
ApiResourceFactoryProviderInterface, |
63
|
|
|
ObjectAccessProviderInterface |
64
|
|
|
{ |
65
|
|
|
use ApieAwareTrait; |
66
|
|
|
|
67
|
|
|
private $classMetadataFactory; |
68
|
|
|
|
69
|
|
|
private $propertyConverter; |
70
|
|
|
|
71
|
|
|
private $annotationReader; |
72
|
|
|
|
73
|
|
|
private $arrayAdapter; |
74
|
|
|
|
75
|
|
|
private $apiResourceFactory; |
76
|
|
|
|
77
|
|
|
/** |
78
|
|
|
* {@inheritDoc} |
79
|
|
|
*/ |
80
|
|
|
public function getResourceSerializer(): ResourceSerializerInterface |
81
|
|
|
{ |
82
|
|
|
$normalizers = $this->getApie()->getNormalizers(); |
83
|
|
|
$encoders = $this->getApie()->getEncoders(); |
84
|
|
|
$serializer = new Serializer($normalizers, $encoders); |
85
|
|
|
$lifecycles = $this->apie->getPluginsWithInterface(ResourceLifeCycleInterface::class); |
86
|
|
|
return new SymfonySerializerAdapter($serializer, $this->getApie()->getFormatRetriever(), $lifecycles); |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
/** |
90
|
|
|
* {@inheritDoc} |
91
|
|
|
*/ |
92
|
|
|
public function getNormalizers(): array |
93
|
|
|
{ |
94
|
|
|
$apieObjectAccessNormalizer = new ApieObjectAccessNormalizer( |
95
|
|
|
$this->getApie()->getObjectAccess(), |
96
|
|
|
$this->getApie()->getPropertyConverter(), |
97
|
|
|
$this->getApie()->getClassMetadataFactory() |
98
|
|
|
); |
99
|
|
|
|
100
|
|
|
return [ |
101
|
|
|
new JsonSerializableNormalizer(), |
102
|
|
|
new ArrayDenormalizer(), |
103
|
|
|
new MethodCallDenormalizer($this->getApie()->getObjectAccess(), $apieObjectAccessNormalizer, $this->getApie()->getPropertyConverter()), |
104
|
|
|
$apieObjectAccessNormalizer, |
105
|
|
|
]; |
106
|
|
|
|
107
|
|
|
} |
108
|
|
|
|
109
|
|
|
/** |
110
|
|
|
* {@inheritDoc} |
111
|
|
|
*/ |
112
|
|
|
public function getClassMetadataFactory(): ClassMetadataFactoryInterface |
113
|
|
|
{ |
114
|
|
|
if (!$this->classMetadataFactory) { |
115
|
|
|
$this->classMetadataFactory = new ClassMetadataFactory( |
116
|
|
|
new LoaderChain([ |
117
|
|
|
new AnnotationLoader($this->getApie()->getAnnotationReader()), |
118
|
|
|
new BaseGroupLoader(['read', 'write', 'get', 'post', 'put']), |
119
|
|
|
]) |
120
|
|
|
); |
121
|
|
|
} |
122
|
|
|
return $this->classMetadataFactory; |
123
|
|
|
} |
124
|
|
|
|
125
|
|
|
/** |
126
|
|
|
* {@inheritDoc} |
127
|
|
|
*/ |
128
|
|
|
public function getPropertyConverter(): NameConverterInterface |
129
|
|
|
{ |
130
|
|
|
if (!$this->propertyConverter) { |
131
|
|
|
$classMetadataFactory = $this->getApie()->getClassMetadataFactory(); |
132
|
|
|
$this->propertyConverter = new MetadataAwareNameConverter( |
133
|
|
|
$classMetadataFactory, |
134
|
|
|
new CamelCaseToSnakeCaseNameConverter() |
135
|
|
|
); |
136
|
|
|
} |
137
|
|
|
return $this->propertyConverter; |
138
|
|
|
} |
139
|
|
|
|
140
|
|
|
/** |
141
|
|
|
* {@inheritDoc} |
142
|
|
|
*/ |
143
|
|
|
public function getCacheItemPool(): CacheItemPoolInterface |
144
|
|
|
{ |
145
|
|
|
if (!$this->arrayAdapter) { |
146
|
|
|
$this->arrayAdapter = new ArrayAdapter(0, true); |
147
|
|
|
} |
148
|
|
|
return $this->arrayAdapter; |
149
|
|
|
} |
150
|
|
|
|
151
|
|
|
/** |
152
|
|
|
* {@inheritDoc} |
153
|
|
|
*/ |
154
|
|
|
public function getAnnotationReader(): Reader |
155
|
|
|
{ |
156
|
|
|
if (!$this->annotationReader) { |
157
|
|
|
/** @scrutinizer ignore-deprecated */AnnotationRegistry::registerLoader('class_exists'); |
158
|
|
|
if (class_exists(PhpFileCache::class) && $this->getApie()->getCacheFolder()) { |
159
|
|
|
$this->annotationReader = new CachedReader( |
160
|
|
|
new AnnotationReader(), |
161
|
|
|
new PhpFileCache($this->getApie()->getCacheFolder() . DIRECTORY_SEPARATOR . '/doctrine-cache'), |
162
|
|
|
$this->getApie()->isDebug() |
163
|
|
|
); |
164
|
|
|
} else { |
165
|
|
|
$this->annotationReader = new AnnotationReader(); |
166
|
|
|
} |
167
|
|
|
} |
168
|
|
|
return $this->annotationReader; |
169
|
|
|
} |
170
|
|
|
|
171
|
|
|
/** |
172
|
|
|
* {@inheritDoc} |
173
|
|
|
*/ |
174
|
|
|
public function getEncoders(): array |
175
|
|
|
{ |
176
|
|
|
return [ |
177
|
|
|
new XmlEncoder([XmlEncoder::ROOT_NODE_NAME => 'item']), |
178
|
|
|
new JsonEncoder( |
179
|
|
|
new JsonEncode([JsonEncode::OPTIONS => JSON_UNESCAPED_SLASHES]), |
180
|
|
|
new JsonDecode([JsonDecode::ASSOCIATIVE => false]) |
181
|
|
|
) |
182
|
|
|
]; |
183
|
|
|
} |
184
|
|
|
|
185
|
|
|
/** |
186
|
|
|
* {@inheritDoc} |
187
|
|
|
*/ |
188
|
|
|
public function getFormatRetriever(): FormatRetrieverInterface |
189
|
|
|
{ |
190
|
|
|
return new FormatRetriever([ |
191
|
|
|
'application/json' => 'json', |
192
|
|
|
'application/xml' => 'xml', |
193
|
|
|
]); |
194
|
|
|
} |
195
|
|
|
|
196
|
|
|
/** |
197
|
|
|
* {@inheritDoc} |
198
|
|
|
*/ |
199
|
|
|
public function getApiResourceFactory(): ApiResourceFactoryInterface |
200
|
|
|
{ |
201
|
|
|
if (!$this->apiResourceFactory) { |
202
|
|
|
$this->apiResourceFactory = new FallbackFactory( |
203
|
|
|
$this->getApie()->getObjectAccess(), |
204
|
|
|
$this->getApie()->getIdentifierExtractor() |
205
|
|
|
); |
206
|
|
|
} |
207
|
|
|
return $this->apiResourceFactory; |
208
|
|
|
} |
209
|
|
|
|
210
|
|
|
/** |
211
|
|
|
* @return ObjectAccessInterface[] |
212
|
|
|
*/ |
213
|
|
|
public function getObjectAccesses(): array |
214
|
|
|
{ |
215
|
|
|
return [ |
216
|
|
|
SelfObjectAccessInterface::class => new SelfObjectAccess(), |
217
|
|
|
Throwable::class => new ExceptionObjectAccess($this->getApie()->isDebug()), |
218
|
|
|
]; |
219
|
|
|
} |
220
|
|
|
} |
221
|
|
|
|
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"]
, you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths