forked from doctrine/phpcr-odm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ClassMetadataFactory.php
294 lines (265 loc) · 9.75 KB
/
ClassMetadataFactory.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
<?php
/*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the MIT license. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\ODM\PHPCR\Mapping;
use Doctrine\ODM\PHPCR\DocumentManager;
use Doctrine\ODM\PHPCR\Mapping\ClassMetadata;
use Doctrine\Common\Persistence\Mapping\ClassMetadata as ClassMetadataInterface;
use Doctrine\Common\Persistence\Mapping\ReflectionService;
use Doctrine\Common\Persistence\Mapping\AbstractClassMetadataFactory;
use Doctrine\Common\Persistence\Event\LoadClassMetadataEventArgs;
use Doctrine\ODM\PHPCR\Event;
/**
* The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
* metadata mapping information of a class which describes how a class should be mapped
* to a document database.
* @license http://www.opensource.org/licenses/MIT-license.php MIT license
* @link www.doctrine-project.com
* @since 1.0
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Lukas Kahwe Smith <smith@pooteeweet.org>
*/
class ClassMetadataFactory extends AbstractClassMetadataFactory
{
/**
* {@inheritdoc}
*/
protected $cacheSalt = '\$PHPCRODMCLASSMETADATA';
/**
* @var DocumentManager
*/
private $dm;
/**
* The used metadata driver.
*
* @var \Doctrine\Common\Persistence\Mapping\Driver\MappingDriver
*/
private $driver;
/**
* @var \Doctrine\Common\EventManager
*/
private $evm;
/**
* Creates a new factory instance that uses the given DocumentManager instance.
*
* @param DocumentManager $dm The DocumentManager instance
*/
public function __construct(DocumentManager $dm)
{
$this->dm = $dm;
$conf = $this->dm->getConfiguration();
$this->setCacheDriver($conf->getMetadataCacheImpl());
$this->driver = $conf->getMetadataDriverImpl();
$this->evm = $this->dm->getEventManager();
}
/**
* {@inheritdoc}
*
* @throws MappingException
*/
public function getMetadataFor($className)
{
$metadata = parent::getMetadataFor($className);
if ($metadata) {
return $metadata;
}
throw MappingException::classNotMapped($className);
}
/**
* {@inheritdoc}
*
* @throws MappingException
*/
public function loadMetadata($className)
{
if (class_exists($className)) {
return parent::loadMetadata($className);
}
throw MappingException::classNotFound($className);
}
/**
* {@inheritdoc}
*/
protected function newClassMetadataInstance($className)
{
return new ClassMetadata($className);
}
/**
* {@inheritdoc}
*/
protected function getFqcnFromAlias($namespaceAlias, $simpleClassName)
{
return $this->dm->getConfiguration()->getDocumentNamespace($namespaceAlias) . '\\' . $simpleClassName;
}
/**
* {@inheritdoc}
*/
protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents)
{
if ($parent) {
$this->addInheritedDocumentOptions($class, $parent);
$this->addInheritedFields($class, $parent);
}
if ($this->getDriver()) {
$this->getDriver()->loadMetadataForClass($class->getName(), $class);
}
if ($this->evm->hasListeners(Event::loadClassMetadata)) {
$eventArgs = new LoadClassMetadataEventArgs($class, $this->dm);
$this->evm->dispatchEvent(Event::loadClassMetadata, $eventArgs);
}
$this->validateRuntimeMetadata($class, $parent);
$class->setParentClasses($this->getParentClasses($class->name));
}
/**
* Set the document level options of the parent class to the subclass.
*
* @param ClassMetadata $subClass
* @param ClassMetadata $parentClass
*/
private function addInheritedDocumentOptions(ClassMetadata $subClass, ClassMetadata $parentClass)
{
$subClass->setCustomRepositoryClassName($parentClass->customRepositoryClassName);
$subClass->setTranslator($parentClass->translator);
$subClass->setVersioned($parentClass->versionable);
$subClass->setReferenceable($parentClass->referenceable);
$subClass->setNodeType($parentClass->getNodeType());
$subClass->setMixins($parentClass->getMixins());
}
/**
* Adds inherited fields to the subclass mapping.
*
* @param ClassMetadata $subClass
* @param ClassMetadata $parentClass
*/
private function addInheritedFields(ClassMetadata $subClass, ClassMetadata $parentClass)
{
foreach ($parentClass->fieldMappings as $fieldName) {
$subClass->mapField($parentClass->mappings[$fieldName], $parentClass);
}
foreach ($parentClass->referenceMappings as $fieldName) {
$mapping = $parentClass->mappings[$fieldName];
if ($mapping['type'] == ClassMetadata::MANY_TO_ONE) {
$subClass->mapManyToOne($mapping, $parentClass);
} else {
$subClass->mapManyToMany($mapping, $parentClass);
}
}
foreach ($parentClass->childMappings as $fieldName) {
$mapping = $parentClass->mappings[$fieldName];
$subClass->mapChild($mapping, $parentClass);
}
foreach ($parentClass->childrenMappings as $fieldName) {
$subClass->mapChildren($parentClass->mappings[$fieldName], $parentClass);
}
foreach ($parentClass->referrersMappings as $fieldName) {
$subClass->mapReferrers($parentClass->mappings[$fieldName], $parentClass);
}
if ($parentClass->identifier) {
$subClass->mapId($parentClass->mappings[$parentClass->identifier], $parentClass);
}
if ($parentClass->node) {
$subClass->mapNode($parentClass->mappings[$parentClass->node], $parentClass);
}
if ($parentClass->nodename) {
$subClass->mapNodename($parentClass->mappings[$parentClass->nodename], $parentClass);
}
if ($parentClass->parentMapping) {
$subClass->mapParentDocument($parentClass->mappings[$parentClass->parentMapping], $parentClass);
}
if ($parentClass->localeMapping) {
$subClass->mapLocale($parentClass->mappings[$parentClass->localeMapping], $parentClass);
}
if ($parentClass->depthMapping) {
$subClass->mapDepth($parentClass->mappings[$parentClass->depthMapping], $parentClass);
}
if ($parentClass->versionNameField) {
$subClass->mapVersionName($parentClass->mappings[$parentClass->versionNameField], $parentClass);
}
if ($parentClass->versionCreatedField) {
$subClass->mapVersionCreated($parentClass->mappings[$parentClass->versionCreatedField], $parentClass);
}
if ($parentClass->lifecycleCallbacks) {
$subClass->mapLifecycleCallbacks($parentClass->lifecycleCallbacks);
}
$subClass->setReferenceable($parentClass->referenceable);
// Versionable defaults to false - only set on child class if it is non-false
if ($parentClass->versionable) {
$subClass->setVersioned($parentClass->versionable);
}
$subClass->setTranslator($parentClass->translator);
$subClass->setNodeType($parentClass->nodeType);
$subClass->setCustomRepositoryClassName($parentClass->customRepositoryClassName);
}
/**
* Validate runtime metadata is correctly defined.
*
* @param ClassMetadata $class
* @param $parent
* @throws MappingException
*/
protected function validateRuntimeMetadata($class, $parent)
{
if (!$class->reflClass) {
// only validate if there is a reflection class instance
return;
}
$class->validateIdentifier();
$class->validateReferences();
$class->validateLifecycleCallbacks($this->getReflectionService());
$class->validateTranslatables();
// verify inheritance
// TODO
}
/**
* {@inheritdoc}
*/
protected function getDriver()
{
return $this->driver;
}
/**
* {@inheritdoc}
*/
protected function initialize()
{
$this->initialized = true;
}
/**
* {@inheritdoc}
*/
protected function initializeReflection(ClassMetadataInterface $class, ReflectionService $reflService)
{
/* @var $class ClassMetadata */
$class->initializeReflection($reflService);
}
/**
* {@inheritdoc}
*/
protected function wakeupReflection(ClassMetadataInterface $class, ReflectionService $reflService)
{
/* @var $class ClassMetadata */
$class->wakeupReflection($reflService);
}
/**
* {@inheritDoc}
*/
protected function isEntity(ClassMetadataInterface $class)
{
return isset($class->isMappedSuperclass) && $class->isMappedSuperclass === false;
}
}