forked from doctrine-extensions/DoctrineExtensions
-
Notifications
You must be signed in to change notification settings - Fork 52
/
ExtensionMetadataFactory.php
173 lines (161 loc) · 5.96 KB
/
ExtensionMetadataFactory.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
<?php
namespace Gedmo\Mapping;
use Doctrine\Common\Persistence\Mapping\Driver\MappingDriver;
use Doctrine\Common\Persistence\ObjectManager;
use Gedmo\Mapping\Driver\File as FileDriver;
use Gedmo\Mapping\Driver\AnnotationDriverInterface;
use Doctrine\ORM\Tools\DisconnectedClassMetadataFactory;
/**
* The extension metadata factory is responsible for extension driver
* initialization and fully reading the extension metadata
*
* @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
* @package Gedmo.Mapping
* @subpackage ExtensionMetadataFactory
* @link http://www.gediminasm.org
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
final class ExtensionMetadataFactory
{
/**
* Extension driver
* @var Gedmo\Mapping\Driver
*/
private $driver;
/**
* Object manager, entity or document
* @var object
*/
private $objectManager;
/**
* Extension namespace
*
* @var string
*/
private $extensionNamespace;
/**
* Custom annotation reader
*
* @var object
*/
private $annotationReader;
/**
* Initializes extension driver
*
* @param ObjectManager $objectManager
* @param string $extensionNamespace
* @param object $annotationReader
*/
public function __construct(ObjectManager $objectManager, $extensionNamespace, $annotationReader)
{
$this->objectManager = $objectManager;
$this->annotationReader = $annotationReader;
$this->extensionNamespace = $extensionNamespace;
$omDriver = $objectManager->getConfiguration()->getMetadataDriverImpl();
$this->driver = $this->getDriver($omDriver);
}
/**
* Reads extension metadata
*
* @param object $meta
* @return array - the metatada configuration
*/
public function getExtensionMetadata($meta)
{
if ($meta->isMappedSuperclass) {
return; // ignore mappedSuperclasses for now
}
$config = array();
$cmf = $this->objectManager->getMetadataFactory();
$useObjectName = $meta->name;
// collect metadata from inherited classes
if (null !== $meta->reflClass) {
foreach (array_reverse(class_parents($meta->name)) as $parentClass) {
// read only inherited mapped classes
if ($cmf->hasMetadataFor($parentClass)) {
$class = $this->objectManager->getClassMetadata($parentClass);
$this->driver->readExtendedMetadata($class, $config);
$isBaseInheritanceLevel = !$class->isInheritanceTypeNone()
&& !$class->parentClasses
&& $config
;
if ($isBaseInheritanceLevel) {
$useObjectName = $class->name;
}
}
}
$this->driver->readExtendedMetadata($meta, $config);
}
if ($config) {
$config['useObjectClass'] = $useObjectName;
}
// cache the metadata (even if it's empty)
// caching empty metadata will prevent re-parsing non-existent annotations
$cacheId = self::getCacheId($meta->name, $this->extensionNamespace);
if ($cacheDriver = $cmf->getCacheDriver()) {
$cacheDriver->save($cacheId, $config, null);
}
return $config;
}
/**
* Get the cache id
*
* @param string $className
* @param string $extensionNamespace
* @return string
*/
public static function getCacheId($className, $extensionNamespace)
{
return $className . '\\$' . strtoupper(str_replace('\\', '_', $extensionNamespace)) . '_CLASSMETADATA';
}
/**
* Get the extended driver instance which will
* read the metadata required by extension
*
* @param object $omDriver
* @throws DriverException if driver was not found in extension
* @return Gedmo\Mapping\Driver
*/
private function getDriver($omDriver)
{
$driver = null;
$className = get_class($omDriver);
$driverName = substr($className, strrpos($className, '\\') + 1);
if ($driverName == 'DriverChain') {
$driver = new Driver\Chain();
foreach ($omDriver->getDrivers() as $namespace => $nestedOmDriver) {
$driver->addDriver($this->getDriver($nestedOmDriver), $namespace);
}
} else {
$driverName = substr($driverName, 0, strpos($driverName, 'Driver'));
if (substr($driverName, 0, 10) === 'Simplified') {
// support for simplified file drivers
$driverName = substr($driverName, 10);
}
// create driver instance
$driverClassName = $this->extensionNamespace . '\Mapping\Driver\\' . $driverName;
if (!class_exists($driverClassName)) {
$driverClassName = $this->extensionNamespace . '\Mapping\Driver\Annotation';
if (!class_exists($driverClassName)) {
throw new \Gedmo\Exception\RuntimeException("Failed to fallback to annotation driver: ({$driverClassName}), extension driver was not found.");
}
}
$driver = new $driverClassName();
$driver->setOriginalDriver($omDriver);
if ($driver instanceof FileDriver) {
if ($omDriver instanceof MappingDriver) {
$driver->setPaths($omDriver->getLocator()->getPaths());
$driver->setExtension($omDriver->getLocator()->getFileExtension());
} else {
// BC for Doctrine 2.2
$driver->setPaths($omDriver->getPaths());
$driver->setExtension($omDriver->getFileExtension());
}
}
if ($driver instanceof AnnotationDriverInterface) {
$driver->setAnnotationReader($this->annotationReader);
}
}
return $driver;
}
}