mailpoet
/
vendor-prefixed
/
doctrine
/
persistence
/
src
/
Persistence
/
Mapping
/
AbstractClassMetadataFactory.php
Driver
9 months ago
AbstractClassMetadataFactory.php
8 months ago
ClassMetadata.php
9 months ago
ClassMetadataFactory.php
9 months ago
MappingException.php
9 months ago
ProxyClassNameResolver.php
9 months ago
ReflectionService.php
9 months ago
RuntimeReflectionService.php
9 months ago
StaticReflectionService.php
9 months ago
index.php
3 years ago
AbstractClassMetadataFactory.php
232 lines
| 1 | <?php |
| 2 | declare (strict_types=1); |
| 3 | namespace MailPoetVendor\Doctrine\Persistence\Mapping; |
| 4 | if (!defined('ABSPATH')) exit; |
| 5 | use MailPoetVendor\Doctrine\Persistence\Mapping\Driver\MappingDriver; |
| 6 | use MailPoetVendor\Doctrine\Persistence\Proxy; |
| 7 | use MailPoetVendor\Psr\Cache\CacheItemPoolInterface; |
| 8 | use ReflectionClass; |
| 9 | use ReflectionException; |
| 10 | use function array_combine; |
| 11 | use function array_keys; |
| 12 | use function array_map; |
| 13 | use function array_reverse; |
| 14 | use function array_unshift; |
| 15 | use function assert; |
| 16 | use function class_exists; |
| 17 | use function ltrim; |
| 18 | use function str_replace; |
| 19 | use function strpos; |
| 20 | use function strrpos; |
| 21 | use function substr; |
| 22 | abstract class AbstractClassMetadataFactory implements ClassMetadataFactory |
| 23 | { |
| 24 | protected $cacheSalt = '__CLASSMETADATA__'; |
| 25 | private $cache; |
| 26 | private $loadedMetadata = []; |
| 27 | protected $initialized = \false; |
| 28 | private $reflectionService = null; |
| 29 | private $proxyClassNameResolver = null; |
| 30 | public function setCache(CacheItemPoolInterface $cache) : void |
| 31 | { |
| 32 | $this->cache = $cache; |
| 33 | } |
| 34 | protected final function getCache() : ?CacheItemPoolInterface |
| 35 | { |
| 36 | return $this->cache; |
| 37 | } |
| 38 | public function getLoadedMetadata() |
| 39 | { |
| 40 | return $this->loadedMetadata; |
| 41 | } |
| 42 | public function getAllMetadata() |
| 43 | { |
| 44 | if (!$this->initialized) { |
| 45 | $this->initialize(); |
| 46 | } |
| 47 | $driver = $this->getDriver(); |
| 48 | $metadata = []; |
| 49 | foreach ($driver->getAllClassNames() as $className) { |
| 50 | $metadata[] = $this->getMetadataFor($className); |
| 51 | } |
| 52 | return $metadata; |
| 53 | } |
| 54 | public function setProxyClassNameResolver(ProxyClassNameResolver $resolver) : void |
| 55 | { |
| 56 | $this->proxyClassNameResolver = $resolver; |
| 57 | } |
| 58 | protected abstract function initialize(); |
| 59 | protected abstract function getDriver(); |
| 60 | protected abstract function wakeupReflection(ClassMetadata $class, ReflectionService $reflService); |
| 61 | protected abstract function initializeReflection(ClassMetadata $class, ReflectionService $reflService); |
| 62 | protected abstract function isEntity(ClassMetadata $class); |
| 63 | private function normalizeClassName(string $className) : string |
| 64 | { |
| 65 | return ltrim($className, '\\'); |
| 66 | } |
| 67 | public function getMetadataFor(string $className) |
| 68 | { |
| 69 | $className = $this->normalizeClassName($className); |
| 70 | if (isset($this->loadedMetadata[$className])) { |
| 71 | return $this->loadedMetadata[$className]; |
| 72 | } |
| 73 | if (class_exists($className, \false) && (new ReflectionClass($className))->isAnonymous()) { |
| 74 | throw MappingException::classIsAnonymous($className); |
| 75 | } |
| 76 | if (!class_exists($className, \false) && strpos($className, ':') !== \false) { |
| 77 | throw MappingException::nonExistingClass($className); |
| 78 | } |
| 79 | $realClassName = $this->getRealClass($className); |
| 80 | if (isset($this->loadedMetadata[$realClassName])) { |
| 81 | // We do not have the alias name in the map, include it |
| 82 | return $this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName]; |
| 83 | } |
| 84 | try { |
| 85 | if ($this->cache !== null) { |
| 86 | $cached = $this->cache->getItem($this->getCacheKey($realClassName))->get(); |
| 87 | if ($cached instanceof ClassMetadata) { |
| 88 | $this->loadedMetadata[$realClassName] = $cached; |
| 89 | $this->wakeupReflection($cached, $this->getReflectionService()); |
| 90 | } else { |
| 91 | $loadedMetadata = $this->loadMetadata($realClassName); |
| 92 | $classNames = array_combine(array_map([$this, 'getCacheKey'], $loadedMetadata), $loadedMetadata); |
| 93 | foreach ($this->cache->getItems(array_keys($classNames)) as $item) { |
| 94 | if (!isset($classNames[$item->getKey()])) { |
| 95 | continue; |
| 96 | } |
| 97 | $item->set($this->loadedMetadata[$classNames[$item->getKey()]]); |
| 98 | $this->cache->saveDeferred($item); |
| 99 | } |
| 100 | $this->cache->commit(); |
| 101 | } |
| 102 | } else { |
| 103 | $this->loadMetadata($realClassName); |
| 104 | } |
| 105 | } catch (MappingException $loadingException) { |
| 106 | $fallbackMetadataResponse = $this->onNotFoundMetadata($realClassName); |
| 107 | if ($fallbackMetadataResponse === null) { |
| 108 | throw $loadingException; |
| 109 | } |
| 110 | $this->loadedMetadata[$realClassName] = $fallbackMetadataResponse; |
| 111 | } |
| 112 | if ($className !== $realClassName) { |
| 113 | // We do not have the alias name in the map, include it |
| 114 | $this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName]; |
| 115 | } |
| 116 | return $this->loadedMetadata[$className]; |
| 117 | } |
| 118 | public function hasMetadataFor(string $className) |
| 119 | { |
| 120 | $className = $this->normalizeClassName($className); |
| 121 | return isset($this->loadedMetadata[$className]); |
| 122 | } |
| 123 | public function setMetadataFor(string $className, ClassMetadata $class) |
| 124 | { |
| 125 | $this->loadedMetadata[$this->normalizeClassName($className)] = $class; |
| 126 | } |
| 127 | protected function getParentClasses(string $name) |
| 128 | { |
| 129 | // Collect parent classes, ignoring transient (not-mapped) classes. |
| 130 | $parentClasses = []; |
| 131 | foreach (array_reverse($this->getReflectionService()->getParentClasses($name)) as $parentClass) { |
| 132 | if ($this->getDriver()->isTransient($parentClass)) { |
| 133 | continue; |
| 134 | } |
| 135 | $parentClasses[] = $parentClass; |
| 136 | } |
| 137 | return $parentClasses; |
| 138 | } |
| 139 | protected function loadMetadata(string $name) |
| 140 | { |
| 141 | if (!$this->initialized) { |
| 142 | $this->initialize(); |
| 143 | } |
| 144 | $loaded = []; |
| 145 | $parentClasses = $this->getParentClasses($name); |
| 146 | $parentClasses[] = $name; |
| 147 | // Move down the hierarchy of parent classes, starting from the topmost ?class |
| 148 | $parent = null; |
| 149 | $rootEntityFound = \false; |
| 150 | $visited = []; |
| 151 | $reflService = $this->getReflectionService(); |
| 152 | foreach ($parentClasses as $className) { |
| 153 | if (isset($this->loadedMetadata[$className])) { |
| 154 | $parent = $this->loadedMetadata[$className]; |
| 155 | if ($this->isEntity($parent)) { |
| 156 | $rootEntityFound = \true; |
| 157 | array_unshift($visited, $className); |
| 158 | } |
| 159 | continue; |
| 160 | } |
| 161 | $class = $this->newClassMetadataInstance($className); |
| 162 | $this->initializeReflection($class, $reflService); |
| 163 | $this->doLoadMetadata($class, $parent, $rootEntityFound, $visited); |
| 164 | $this->loadedMetadata[$className] = $class; |
| 165 | $parent = $class; |
| 166 | if ($this->isEntity($class)) { |
| 167 | $rootEntityFound = \true; |
| 168 | array_unshift($visited, $className); |
| 169 | } |
| 170 | $this->wakeupReflection($class, $reflService); |
| 171 | $loaded[] = $className; |
| 172 | } |
| 173 | return $loaded; |
| 174 | } |
| 175 | protected function onNotFoundMetadata(string $className) |
| 176 | { |
| 177 | return null; |
| 178 | } |
| 179 | protected abstract function doLoadMetadata(ClassMetadata $class, ?ClassMetadata $parent, bool $rootEntityFound, array $nonSuperclassParents); |
| 180 | protected abstract function newClassMetadataInstance(string $className); |
| 181 | public function isTransient(string $className) |
| 182 | { |
| 183 | if (!$this->initialized) { |
| 184 | $this->initialize(); |
| 185 | } |
| 186 | if (class_exists($className, \false) && (new ReflectionClass($className))->isAnonymous()) { |
| 187 | return \false; |
| 188 | } |
| 189 | if (!class_exists($className, \false) && strpos($className, ':') !== \false) { |
| 190 | throw MappingException::nonExistingClass($className); |
| 191 | } |
| 192 | return $this->getDriver()->isTransient($className); |
| 193 | } |
| 194 | public function setReflectionService(ReflectionService $reflectionService) |
| 195 | { |
| 196 | $this->reflectionService = $reflectionService; |
| 197 | } |
| 198 | public function getReflectionService() |
| 199 | { |
| 200 | if ($this->reflectionService === null) { |
| 201 | $this->reflectionService = new RuntimeReflectionService(); |
| 202 | } |
| 203 | return $this->reflectionService; |
| 204 | } |
| 205 | protected function getCacheKey(string $realClassName) : string |
| 206 | { |
| 207 | return str_replace('\\', '__', $realClassName) . $this->cacheSalt; |
| 208 | } |
| 209 | private function getRealClass(string $class) : string |
| 210 | { |
| 211 | if ($this->proxyClassNameResolver === null) { |
| 212 | $this->createDefaultProxyClassNameResolver(); |
| 213 | } |
| 214 | assert($this->proxyClassNameResolver !== null); |
| 215 | return $this->proxyClassNameResolver->resolveClassName($class); |
| 216 | } |
| 217 | private function createDefaultProxyClassNameResolver() : void |
| 218 | { |
| 219 | $this->proxyClassNameResolver = new class implements ProxyClassNameResolver |
| 220 | { |
| 221 | public function resolveClassName(string $className) : string |
| 222 | { |
| 223 | $pos = strrpos($className, '\\' . Proxy::MARKER . '\\'); |
| 224 | if ($pos === \false) { |
| 225 | return $className; |
| 226 | } |
| 227 | return substr($className, $pos + Proxy::MARKER_LENGTH + 2); |
| 228 | } |
| 229 | }; |
| 230 | } |
| 231 | } |
| 232 |