@@ -18,33 +18,33 @@ |
||
| 18 | 18 | |
| 19 | 19 | interface IOConfigurationOptionInterface extends ConfigurationOptionInterface |
| 20 | 20 | { |
| 21 | - /** |
|
| 22 | - * Feel free to propose your own one |
|
| 23 | - * by opening a pull request :) |
|
| 24 | - */ |
|
| 25 | - public const SAFE_FILE_EXTENSIONS = 'txt|cache|db|pfc'; |
|
| 21 | + /** |
|
| 22 | + * Feel free to propose your own one |
|
| 23 | + * by opening a pull request :) |
|
| 24 | + */ |
|
| 25 | + public const SAFE_FILE_EXTENSIONS = 'txt|cache|db|pfc'; |
|
| 26 | 26 | |
| 27 | - public function getSecurityKey(): string; |
|
| 27 | + public function getSecurityKey(): string; |
|
| 28 | 28 | |
| 29 | - public function setSecurityKey(string $securityKey): static; |
|
| 29 | + public function setSecurityKey(string $securityKey): static; |
|
| 30 | 30 | |
| 31 | - public function isSecureFileManipulation(): bool; |
|
| 31 | + public function isSecureFileManipulation(): bool; |
|
| 32 | 32 | |
| 33 | - public function setSecureFileManipulation(bool $secureFileManipulation): static; |
|
| 33 | + public function setSecureFileManipulation(bool $secureFileManipulation): static; |
|
| 34 | 34 | |
| 35 | - public function getCacheFileExtension(): string; |
|
| 35 | + public function getCacheFileExtension(): string; |
|
| 36 | 36 | |
| 37 | - public function setCacheFileExtension(string $cacheFileExtension): static; |
|
| 37 | + public function setCacheFileExtension(string $cacheFileExtension): static; |
|
| 38 | 38 | |
| 39 | - public function getDefaultChmod(): int; |
|
| 39 | + public function getDefaultChmod(): int; |
|
| 40 | 40 | |
| 41 | - public function setDefaultChmod(int $defaultChmod): static; |
|
| 41 | + public function setDefaultChmod(int $defaultChmod): static; |
|
| 42 | 42 | |
| 43 | - public function isPreventCacheSlams(): bool; |
|
| 43 | + public function isPreventCacheSlams(): bool; |
|
| 44 | 44 | |
| 45 | - public function setPreventCacheSlams(bool $preventCacheSlams): static; |
|
| 45 | + public function setPreventCacheSlams(bool $preventCacheSlams): static; |
|
| 46 | 46 | |
| 47 | - public function getCacheSlamsTimeout(): int; |
|
| 47 | + public function getCacheSlamsTimeout(): int; |
|
| 48 | 48 | |
| 49 | - public function setCacheSlamsTimeout(int $cacheSlamsTimeout): static; |
|
| 49 | + public function setCacheSlamsTimeout(int $cacheSlamsTimeout): static; |
|
| 50 | 50 | } |
@@ -22,62 +22,62 @@ |
||
| 22 | 22 | |
| 23 | 23 | abstract class AbstractConfigurationOption implements LockableConfigurationInterface |
| 24 | 24 | { |
| 25 | - private bool $lockedObject = false; |
|
| 26 | - private ExtendedCacheItemPoolInterface $locker; |
|
| 25 | + private bool $lockedObject = false; |
|
| 26 | + private ExtendedCacheItemPoolInterface $locker; |
|
| 27 | 27 | |
| 28 | - protected function getClassName(): string |
|
| 29 | - { |
|
| 30 | - return $this::class; |
|
| 31 | - } |
|
| 28 | + protected function getClassName(): string |
|
| 29 | + { |
|
| 30 | + return $this::class; |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | - public function lock(ExtendedCacheItemPoolInterface $poolInstance): static |
|
| 34 | - { |
|
| 35 | - $this->lockedObject = true; |
|
| 36 | - $this->locker = $poolInstance; |
|
| 37 | - return $this; |
|
| 38 | - } |
|
| 33 | + public function lock(ExtendedCacheItemPoolInterface $poolInstance): static |
|
| 34 | + { |
|
| 35 | + $this->lockedObject = true; |
|
| 36 | + $this->locker = $poolInstance; |
|
| 37 | + return $this; |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | - public function lockedBy(): ExtendedCacheItemPoolInterface |
|
| 41 | - { |
|
| 42 | - return $this->locker; |
|
| 43 | - } |
|
| 40 | + public function lockedBy(): ExtendedCacheItemPoolInterface |
|
| 41 | + { |
|
| 42 | + return $this->locker; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - public function isLocked(): bool |
|
| 46 | - { |
|
| 47 | - return $this->lockedObject; |
|
| 48 | - } |
|
| 45 | + public function isLocked(): bool |
|
| 46 | + { |
|
| 47 | + return $this->lockedObject; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @throws PhpfastcacheLogicException |
|
| 52 | - * @throws PhpfastcacheInvalidArgumentException |
|
| 53 | - */ |
|
| 54 | - protected function setProperty(string $propertyName, mixed $propertyValue): static |
|
| 55 | - { |
|
| 56 | - $this->enforceLockedProperty($propertyName); |
|
| 57 | - if (property_exists($this, $propertyName)) { |
|
| 58 | - $this->$propertyName = $propertyValue; |
|
| 59 | - return $this; |
|
| 60 | - } |
|
| 61 | - throw new PhpfastcacheInvalidArgumentException("Unknown property $propertyName in {$this->getClassName()} context."); |
|
| 62 | - } |
|
| 50 | + /** |
|
| 51 | + * @throws PhpfastcacheLogicException |
|
| 52 | + * @throws PhpfastcacheInvalidArgumentException |
|
| 53 | + */ |
|
| 54 | + protected function setProperty(string $propertyName, mixed $propertyValue): static |
|
| 55 | + { |
|
| 56 | + $this->enforceLockedProperty($propertyName); |
|
| 57 | + if (property_exists($this, $propertyName)) { |
|
| 58 | + $this->$propertyName = $propertyValue; |
|
| 59 | + return $this; |
|
| 60 | + } |
|
| 61 | + throw new PhpfastcacheInvalidArgumentException("Unknown property $propertyName in {$this->getClassName()} context."); |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @throws PhpfastcacheLogicException |
|
| 66 | - */ |
|
| 67 | - protected function enforceLockedProperty(string $propertyName): void |
|
| 68 | - { |
|
| 69 | - if ($this->lockedObject === true) { |
|
| 70 | - $dbt = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 3); |
|
| 71 | - $cause = $dbt[\array_key_last($dbt)] ?? null; |
|
| 72 | - if ($cause) { |
|
| 73 | - $moreInfo = \sprintf('Caused line %d in %s', $cause['line'], $cause['file']); |
|
| 74 | - } |
|
| 64 | + /** |
|
| 65 | + * @throws PhpfastcacheLogicException |
|
| 66 | + */ |
|
| 67 | + protected function enforceLockedProperty(string $propertyName): void |
|
| 68 | + { |
|
| 69 | + if ($this->lockedObject === true) { |
|
| 70 | + $dbt = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 3); |
|
| 71 | + $cause = $dbt[\array_key_last($dbt)] ?? null; |
|
| 72 | + if ($cause) { |
|
| 73 | + $moreInfo = \sprintf('Caused line %d in %s', $cause['line'], $cause['file']); |
|
| 74 | + } |
|
| 75 | 75 | |
| 76 | - throw new PhpfastcacheLogicException(\sprintf( |
|
| 77 | - 'You can no longer change the configuration "%s" as the cache pool instance is now running. %s', |
|
| 78 | - $propertyName, |
|
| 79 | - $moreInfo ?? '' |
|
| 80 | - )); |
|
| 81 | - } |
|
| 82 | - } |
|
| 76 | + throw new PhpfastcacheLogicException(\sprintf( |
|
| 77 | + 'You can no longer change the configuration "%s" as the cache pool instance is now running. %s', |
|
| 78 | + $propertyName, |
|
| 79 | + $moreInfo ?? '' |
|
| 80 | + )); |
|
| 81 | + } |
|
| 82 | + } |
|
| 83 | 83 | } |
@@ -35,182 +35,182 @@ |
||
| 35 | 35 | |
| 36 | 36 | class Psr16Adapter implements CacheInterface |
| 37 | 37 | { |
| 38 | - /** |
|
| 39 | - * @var ExtendedCacheItemPoolInterface |
|
| 40 | - */ |
|
| 41 | - protected ExtendedCacheItemPoolInterface $internalCacheInstance; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * Psr16Adapter constructor. |
|
| 45 | - * @param string|ExtendedCacheItemPoolInterface $driver |
|
| 46 | - * @param null|ConfigurationOptionInterface $config |
|
| 47 | - * @throws PhpfastcacheDriverCheckException |
|
| 48 | - * @throws PhpfastcacheLogicException |
|
| 49 | - * @throws PhpfastcacheDriverException |
|
| 50 | - * @throws PhpfastcacheDriverNotFoundException |
|
| 51 | - */ |
|
| 52 | - public function __construct(string|ExtendedCacheItemPoolInterface $driver, ConfigurationOptionInterface $config = null) |
|
| 53 | - { |
|
| 54 | - if ($driver instanceof ExtendedCacheItemPoolInterface) { |
|
| 55 | - if ($config !== null) { |
|
| 56 | - throw new PhpfastcacheLogicException("You can't pass a config parameter along with an non-string '\$driver' parameter."); |
|
| 57 | - } |
|
| 58 | - $this->internalCacheInstance = $driver; |
|
| 59 | - } else { |
|
| 60 | - $this->internalCacheInstance = CacheManager::getInstance($driver, $config); |
|
| 61 | - } |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * @param string $key |
|
| 66 | - * @param mixed $default |
|
| 67 | - * @return mixed |
|
| 68 | - * @throws PhpfastcacheSimpleCacheException |
|
| 69 | - */ |
|
| 70 | - public function get(string $key, mixed $default = null): mixed |
|
| 71 | - { |
|
| 72 | - try { |
|
| 73 | - $cacheItem = $this->internalCacheInstance->getItem($key); |
|
| 74 | - if (!$cacheItem->isExpired() && $cacheItem->get() !== null) { |
|
| 75 | - return $cacheItem->get(); |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - return $default; |
|
| 79 | - } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 80 | - throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 81 | - } |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * @param string $key |
|
| 86 | - * @param mixed $value |
|
| 87 | - * @param null|int|DateInterval $ttl |
|
| 88 | - * @return bool |
|
| 89 | - * @throws PhpfastcacheSimpleCacheException |
|
| 90 | - */ |
|
| 91 | - public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool |
|
| 92 | - { |
|
| 93 | - try { |
|
| 94 | - $cacheItem = $this->internalCacheInstance |
|
| 95 | - ->getItem($key) |
|
| 96 | - ->set($value); |
|
| 97 | - if (\is_int($ttl) && $ttl <= 0) { |
|
| 98 | - $cacheItem->expiresAt((new DateTime('@0'))); |
|
| 99 | - } elseif ($ttl !== null) { |
|
| 100 | - $cacheItem->expiresAfter($ttl); |
|
| 101 | - } |
|
| 102 | - return $this->internalCacheInstance->save($cacheItem); |
|
| 103 | - } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 104 | - throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 105 | - } |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * @param string $key |
|
| 110 | - * @return bool |
|
| 111 | - * @throws PhpfastcacheSimpleCacheException |
|
| 112 | - * @throws InvalidArgumentException |
|
| 113 | - */ |
|
| 114 | - public function delete(string $key): bool |
|
| 115 | - { |
|
| 116 | - try { |
|
| 117 | - return $this->internalCacheInstance->deleteItem($key); |
|
| 118 | - } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 119 | - throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 120 | - } |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * @return bool |
|
| 125 | - * @throws PhpfastcacheSimpleCacheException |
|
| 126 | - */ |
|
| 127 | - public function clear(): bool |
|
| 128 | - { |
|
| 129 | - try { |
|
| 130 | - return $this->internalCacheInstance->clear(); |
|
| 131 | - } catch (PhpfastcacheRootException $e) { |
|
| 132 | - throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 133 | - } |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * @param iterable<string> $keys |
|
| 138 | - * @param null $default |
|
| 139 | - * @return ExtendedCacheItemInterface[] |
|
| 140 | - * @throws PhpfastcacheSimpleCacheException |
|
| 141 | - */ |
|
| 142 | - public function getMultiple(iterable $keys, mixed $default = null): iterable |
|
| 143 | - { |
|
| 144 | - if ($keys instanceof Traversable) { |
|
| 145 | - $keys = \iterator_to_array($keys); |
|
| 146 | - } |
|
| 147 | - try { |
|
| 148 | - return \array_map( |
|
| 149 | - static fn (ExtendedCacheItemInterface $item) => $item->isHit() ? $item->get() : $default, |
|
| 150 | - $this->internalCacheInstance->getItems($keys) |
|
| 151 | - ); |
|
| 152 | - } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 153 | - throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 154 | - } |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * @param iterable<string, mixed> $values |
|
| 159 | - * @param null|int|DateInterval $ttl |
|
| 160 | - * @return bool |
|
| 161 | - * @throws PhpfastcacheSimpleCacheException |
|
| 162 | - */ |
|
| 163 | - public function setMultiple(iterable $values, null|int|\DateInterval $ttl = null): bool |
|
| 164 | - { |
|
| 165 | - try { |
|
| 166 | - foreach ($values as $key => $value) { |
|
| 167 | - $cacheItem = $this->internalCacheInstance->getItem($key)->set($value); |
|
| 168 | - |
|
| 169 | - if (\is_int($ttl) && $ttl <= 0) { |
|
| 170 | - $cacheItem->expiresAt((new DateTime('@0'))); |
|
| 171 | - } elseif ($ttl !== null) { |
|
| 172 | - $cacheItem->expiresAfter($ttl); |
|
| 173 | - } |
|
| 174 | - $this->internalCacheInstance->saveDeferred($cacheItem); |
|
| 175 | - unset($cacheItem); |
|
| 176 | - } |
|
| 177 | - return $this->internalCacheInstance->commit(); |
|
| 178 | - } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 179 | - throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 180 | - } |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - /** |
|
| 184 | - * @param iterable<string> $keys |
|
| 185 | - * @return bool |
|
| 186 | - * @throws PhpfastcacheSimpleCacheException |
|
| 187 | - * @throws InvalidArgumentException |
|
| 188 | - */ |
|
| 189 | - public function deleteMultiple(iterable $keys): bool |
|
| 190 | - { |
|
| 191 | - try { |
|
| 192 | - if (\is_array($keys)) { |
|
| 193 | - return $this->internalCacheInstance->deleteItems($keys); |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - return $this->internalCacheInstance->deleteItems(\iterator_to_array($keys)); |
|
| 197 | - } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 198 | - throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 199 | - } |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * @param string $key |
|
| 204 | - * @return bool |
|
| 205 | - * @throws PhpfastcacheSimpleCacheException |
|
| 206 | - */ |
|
| 207 | - public function has(string $key): bool |
|
| 208 | - { |
|
| 209 | - try { |
|
| 210 | - $cacheItem = $this->internalCacheInstance->getItem($key); |
|
| 211 | - return $cacheItem->isHit() && !$cacheItem->isExpired(); |
|
| 212 | - } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 213 | - throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 214 | - } |
|
| 215 | - } |
|
| 38 | + /** |
|
| 39 | + * @var ExtendedCacheItemPoolInterface |
|
| 40 | + */ |
|
| 41 | + protected ExtendedCacheItemPoolInterface $internalCacheInstance; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * Psr16Adapter constructor. |
|
| 45 | + * @param string|ExtendedCacheItemPoolInterface $driver |
|
| 46 | + * @param null|ConfigurationOptionInterface $config |
|
| 47 | + * @throws PhpfastcacheDriverCheckException |
|
| 48 | + * @throws PhpfastcacheLogicException |
|
| 49 | + * @throws PhpfastcacheDriverException |
|
| 50 | + * @throws PhpfastcacheDriverNotFoundException |
|
| 51 | + */ |
|
| 52 | + public function __construct(string|ExtendedCacheItemPoolInterface $driver, ConfigurationOptionInterface $config = null) |
|
| 53 | + { |
|
| 54 | + if ($driver instanceof ExtendedCacheItemPoolInterface) { |
|
| 55 | + if ($config !== null) { |
|
| 56 | + throw new PhpfastcacheLogicException("You can't pass a config parameter along with an non-string '\$driver' parameter."); |
|
| 57 | + } |
|
| 58 | + $this->internalCacheInstance = $driver; |
|
| 59 | + } else { |
|
| 60 | + $this->internalCacheInstance = CacheManager::getInstance($driver, $config); |
|
| 61 | + } |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * @param string $key |
|
| 66 | + * @param mixed $default |
|
| 67 | + * @return mixed |
|
| 68 | + * @throws PhpfastcacheSimpleCacheException |
|
| 69 | + */ |
|
| 70 | + public function get(string $key, mixed $default = null): mixed |
|
| 71 | + { |
|
| 72 | + try { |
|
| 73 | + $cacheItem = $this->internalCacheInstance->getItem($key); |
|
| 74 | + if (!$cacheItem->isExpired() && $cacheItem->get() !== null) { |
|
| 75 | + return $cacheItem->get(); |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + return $default; |
|
| 79 | + } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 80 | + throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 81 | + } |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * @param string $key |
|
| 86 | + * @param mixed $value |
|
| 87 | + * @param null|int|DateInterval $ttl |
|
| 88 | + * @return bool |
|
| 89 | + * @throws PhpfastcacheSimpleCacheException |
|
| 90 | + */ |
|
| 91 | + public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool |
|
| 92 | + { |
|
| 93 | + try { |
|
| 94 | + $cacheItem = $this->internalCacheInstance |
|
| 95 | + ->getItem($key) |
|
| 96 | + ->set($value); |
|
| 97 | + if (\is_int($ttl) && $ttl <= 0) { |
|
| 98 | + $cacheItem->expiresAt((new DateTime('@0'))); |
|
| 99 | + } elseif ($ttl !== null) { |
|
| 100 | + $cacheItem->expiresAfter($ttl); |
|
| 101 | + } |
|
| 102 | + return $this->internalCacheInstance->save($cacheItem); |
|
| 103 | + } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 104 | + throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 105 | + } |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * @param string $key |
|
| 110 | + * @return bool |
|
| 111 | + * @throws PhpfastcacheSimpleCacheException |
|
| 112 | + * @throws InvalidArgumentException |
|
| 113 | + */ |
|
| 114 | + public function delete(string $key): bool |
|
| 115 | + { |
|
| 116 | + try { |
|
| 117 | + return $this->internalCacheInstance->deleteItem($key); |
|
| 118 | + } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 119 | + throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 120 | + } |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * @return bool |
|
| 125 | + * @throws PhpfastcacheSimpleCacheException |
|
| 126 | + */ |
|
| 127 | + public function clear(): bool |
|
| 128 | + { |
|
| 129 | + try { |
|
| 130 | + return $this->internalCacheInstance->clear(); |
|
| 131 | + } catch (PhpfastcacheRootException $e) { |
|
| 132 | + throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 133 | + } |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * @param iterable<string> $keys |
|
| 138 | + * @param null $default |
|
| 139 | + * @return ExtendedCacheItemInterface[] |
|
| 140 | + * @throws PhpfastcacheSimpleCacheException |
|
| 141 | + */ |
|
| 142 | + public function getMultiple(iterable $keys, mixed $default = null): iterable |
|
| 143 | + { |
|
| 144 | + if ($keys instanceof Traversable) { |
|
| 145 | + $keys = \iterator_to_array($keys); |
|
| 146 | + } |
|
| 147 | + try { |
|
| 148 | + return \array_map( |
|
| 149 | + static fn (ExtendedCacheItemInterface $item) => $item->isHit() ? $item->get() : $default, |
|
| 150 | + $this->internalCacheInstance->getItems($keys) |
|
| 151 | + ); |
|
| 152 | + } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 153 | + throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 154 | + } |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * @param iterable<string, mixed> $values |
|
| 159 | + * @param null|int|DateInterval $ttl |
|
| 160 | + * @return bool |
|
| 161 | + * @throws PhpfastcacheSimpleCacheException |
|
| 162 | + */ |
|
| 163 | + public function setMultiple(iterable $values, null|int|\DateInterval $ttl = null): bool |
|
| 164 | + { |
|
| 165 | + try { |
|
| 166 | + foreach ($values as $key => $value) { |
|
| 167 | + $cacheItem = $this->internalCacheInstance->getItem($key)->set($value); |
|
| 168 | + |
|
| 169 | + if (\is_int($ttl) && $ttl <= 0) { |
|
| 170 | + $cacheItem->expiresAt((new DateTime('@0'))); |
|
| 171 | + } elseif ($ttl !== null) { |
|
| 172 | + $cacheItem->expiresAfter($ttl); |
|
| 173 | + } |
|
| 174 | + $this->internalCacheInstance->saveDeferred($cacheItem); |
|
| 175 | + unset($cacheItem); |
|
| 176 | + } |
|
| 177 | + return $this->internalCacheInstance->commit(); |
|
| 178 | + } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 179 | + throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 180 | + } |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + /** |
|
| 184 | + * @param iterable<string> $keys |
|
| 185 | + * @return bool |
|
| 186 | + * @throws PhpfastcacheSimpleCacheException |
|
| 187 | + * @throws InvalidArgumentException |
|
| 188 | + */ |
|
| 189 | + public function deleteMultiple(iterable $keys): bool |
|
| 190 | + { |
|
| 191 | + try { |
|
| 192 | + if (\is_array($keys)) { |
|
| 193 | + return $this->internalCacheInstance->deleteItems($keys); |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + return $this->internalCacheInstance->deleteItems(\iterator_to_array($keys)); |
|
| 197 | + } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 198 | + throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 199 | + } |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * @param string $key |
|
| 204 | + * @return bool |
|
| 205 | + * @throws PhpfastcacheSimpleCacheException |
|
| 206 | + */ |
|
| 207 | + public function has(string $key): bool |
|
| 208 | + { |
|
| 209 | + try { |
|
| 210 | + $cacheItem = $this->internalCacheInstance->getItem($key); |
|
| 211 | + return $cacheItem->isHit() && !$cacheItem->isExpired(); |
|
| 212 | + } catch (PhpfastcacheInvalidArgumentException $e) { |
|
| 213 | + throw new PhpfastcacheSimpleCacheException($e->getMessage(), 0, $e); |
|
| 214 | + } |
|
| 215 | + } |
|
| 216 | 216 | } |
@@ -24,21 +24,21 @@ |
||
| 24 | 24 | */ |
| 25 | 25 | class CacheConditionalHelper extends CacheContract |
| 26 | 26 | { |
| 27 | - /** |
|
| 28 | - * CacheConditionalHelper constructor. |
|
| 29 | - * @param CacheItemPoolInterface $cacheInstance |
|
| 30 | - */ |
|
| 31 | - public function __construct(CacheItemPoolInterface $cacheInstance) |
|
| 32 | - { |
|
| 33 | - \trigger_error( |
|
| 34 | - \sprintf( |
|
| 35 | - 'Class "%s" is deprecated, use "%s" class instead. See the documentation about this change here: %s', |
|
| 36 | - self::class, |
|
| 37 | - parent::class, |
|
| 38 | - 'https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV9%CB%96%5D-Cache-contract' |
|
| 39 | - ), |
|
| 40 | - E_USER_DEPRECATED |
|
| 41 | - ); |
|
| 42 | - parent::__construct($cacheInstance); |
|
| 43 | - } |
|
| 27 | + /** |
|
| 28 | + * CacheConditionalHelper constructor. |
|
| 29 | + * @param CacheItemPoolInterface $cacheInstance |
|
| 30 | + */ |
|
| 31 | + public function __construct(CacheItemPoolInterface $cacheInstance) |
|
| 32 | + { |
|
| 33 | + \trigger_error( |
|
| 34 | + \sprintf( |
|
| 35 | + 'Class "%s" is deprecated, use "%s" class instead. See the documentation about this change here: %s', |
|
| 36 | + self::class, |
|
| 37 | + parent::class, |
|
| 38 | + 'https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV9%CB%96%5D-Cache-contract' |
|
| 39 | + ), |
|
| 40 | + E_USER_DEPRECATED |
|
| 41 | + ); |
|
| 42 | + parent::__construct($cacheInstance); |
|
| 43 | + } |
|
| 44 | 44 | } |
@@ -35,8 +35,8 @@ |
||
| 35 | 35 | |
| 36 | 36 | trait UninstanciableObjectTrait |
| 37 | 37 | { |
| 38 | - final protected function __construct() |
|
| 39 | - { |
|
| 40 | - // The target class is not meant to be instantiated |
|
| 41 | - } |
|
| 38 | + final protected function __construct() |
|
| 39 | + { |
|
| 40 | + // The target class is not meant to be instantiated |
|
| 41 | + } |
|
| 42 | 42 | } |
@@ -6,41 +6,41 @@ |
||
| 6 | 6 | |
| 7 | 7 | class ComposerStaticInit6c951d886d53bc9c3b700a1be3508206 |
| 8 | 8 | { |
| 9 | - public static $prefixLengthsPsr4 = array ( |
|
| 10 | - 'P' => |
|
| 11 | - array ( |
|
| 12 | - 'Psr\\SimpleCache\\' => 16, |
|
| 13 | - 'Psr\\Cache\\' => 10, |
|
| 14 | - 'Phpfastcache\\' => 13, |
|
| 15 | - ), |
|
| 16 | - ); |
|
| 9 | + public static $prefixLengthsPsr4 = array ( |
|
| 10 | + 'P' => |
|
| 11 | + array ( |
|
| 12 | + 'Psr\\SimpleCache\\' => 16, |
|
| 13 | + 'Psr\\Cache\\' => 10, |
|
| 14 | + 'Phpfastcache\\' => 13, |
|
| 15 | + ), |
|
| 16 | + ); |
|
| 17 | 17 | |
| 18 | - public static $prefixDirsPsr4 = array ( |
|
| 19 | - 'Psr\\SimpleCache\\' => |
|
| 20 | - array ( |
|
| 21 | - 0 => __DIR__ . '/..' . '/psr/simple-cache/src', |
|
| 22 | - ), |
|
| 23 | - 'Psr\\Cache\\' => |
|
| 24 | - array ( |
|
| 25 | - 0 => __DIR__ . '/..' . '/psr/cache/src', |
|
| 26 | - ), |
|
| 27 | - 'Phpfastcache\\' => |
|
| 28 | - array ( |
|
| 29 | - 0 => __DIR__ . '/..' . '/phpfastcache/phpfastcache/lib/Phpfastcache', |
|
| 30 | - ), |
|
| 31 | - ); |
|
| 18 | + public static $prefixDirsPsr4 = array ( |
|
| 19 | + 'Psr\\SimpleCache\\' => |
|
| 20 | + array ( |
|
| 21 | + 0 => __DIR__ . '/..' . '/psr/simple-cache/src', |
|
| 22 | + ), |
|
| 23 | + 'Psr\\Cache\\' => |
|
| 24 | + array ( |
|
| 25 | + 0 => __DIR__ . '/..' . '/psr/cache/src', |
|
| 26 | + ), |
|
| 27 | + 'Phpfastcache\\' => |
|
| 28 | + array ( |
|
| 29 | + 0 => __DIR__ . '/..' . '/phpfastcache/phpfastcache/lib/Phpfastcache', |
|
| 30 | + ), |
|
| 31 | + ); |
|
| 32 | 32 | |
| 33 | - public static $classMap = array ( |
|
| 34 | - 'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php', |
|
| 35 | - ); |
|
| 33 | + public static $classMap = array ( |
|
| 34 | + 'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php', |
|
| 35 | + ); |
|
| 36 | 36 | |
| 37 | - public static function getInitializer(ClassLoader $loader) |
|
| 38 | - { |
|
| 39 | - return \Closure::bind(function () use ($loader) { |
|
| 40 | - $loader->prefixLengthsPsr4 = ComposerStaticInit6c951d886d53bc9c3b700a1be3508206::$prefixLengthsPsr4; |
|
| 41 | - $loader->prefixDirsPsr4 = ComposerStaticInit6c951d886d53bc9c3b700a1be3508206::$prefixDirsPsr4; |
|
| 42 | - $loader->classMap = ComposerStaticInit6c951d886d53bc9c3b700a1be3508206::$classMap; |
|
| 37 | + public static function getInitializer(ClassLoader $loader) |
|
| 38 | + { |
|
| 39 | + return \Closure::bind(function () use ($loader) { |
|
| 40 | + $loader->prefixLengthsPsr4 = ComposerStaticInit6c951d886d53bc9c3b700a1be3508206::$prefixLengthsPsr4; |
|
| 41 | + $loader->prefixDirsPsr4 = ComposerStaticInit6c951d886d53bc9c3b700a1be3508206::$prefixDirsPsr4; |
|
| 42 | + $loader->classMap = ComposerStaticInit6c951d886d53bc9c3b700a1be3508206::$classMap; |
|
| 43 | 43 | |
| 44 | - }, null, ClassLoader::class); |
|
| 45 | - } |
|
| 44 | + }, null, ClassLoader::class); |
|
| 45 | + } |
|
| 46 | 46 | } |
@@ -42,519 +42,519 @@ discard block |
||
| 42 | 42 | */ |
| 43 | 43 | class ClassLoader |
| 44 | 44 | { |
| 45 | - /** @var ?string */ |
|
| 46 | - private $vendorDir; |
|
| 47 | - |
|
| 48 | - // PSR-4 |
|
| 49 | - /** |
|
| 50 | - * @var array[] |
|
| 51 | - * @psalm-var array<string, array<string, int>> |
|
| 52 | - */ |
|
| 53 | - private $prefixLengthsPsr4 = array(); |
|
| 54 | - /** |
|
| 55 | - * @var array[] |
|
| 56 | - * @psalm-var array<string, array<int, string>> |
|
| 57 | - */ |
|
| 58 | - private $prefixDirsPsr4 = array(); |
|
| 59 | - /** |
|
| 60 | - * @var array[] |
|
| 61 | - * @psalm-var array<string, string> |
|
| 62 | - */ |
|
| 63 | - private $fallbackDirsPsr4 = array(); |
|
| 64 | - |
|
| 65 | - // PSR-0 |
|
| 66 | - /** |
|
| 67 | - * @var array[] |
|
| 68 | - * @psalm-var array<string, array<string, string[]>> |
|
| 69 | - */ |
|
| 70 | - private $prefixesPsr0 = array(); |
|
| 71 | - /** |
|
| 72 | - * @var array[] |
|
| 73 | - * @psalm-var array<string, string> |
|
| 74 | - */ |
|
| 75 | - private $fallbackDirsPsr0 = array(); |
|
| 76 | - |
|
| 77 | - /** @var bool */ |
|
| 78 | - private $useIncludePath = false; |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * @var string[] |
|
| 82 | - * @psalm-var array<string, string> |
|
| 83 | - */ |
|
| 84 | - private $classMap = array(); |
|
| 85 | - |
|
| 86 | - /** @var bool */ |
|
| 87 | - private $classMapAuthoritative = false; |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * @var bool[] |
|
| 91 | - * @psalm-var array<string, bool> |
|
| 92 | - */ |
|
| 93 | - private $missingClasses = array(); |
|
| 94 | - |
|
| 95 | - /** @var ?string */ |
|
| 96 | - private $apcuPrefix; |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * @var self[] |
|
| 100 | - */ |
|
| 101 | - private static $registeredLoaders = array(); |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * @param ?string $vendorDir |
|
| 105 | - */ |
|
| 106 | - public function __construct($vendorDir = null) |
|
| 107 | - { |
|
| 108 | - $this->vendorDir = $vendorDir; |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * @return string[] |
|
| 113 | - */ |
|
| 114 | - public function getPrefixes() |
|
| 115 | - { |
|
| 116 | - if (!empty($this->prefixesPsr0)) { |
|
| 117 | - return call_user_func_array('array_merge', array_values($this->prefixesPsr0)); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - return array(); |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * @return array[] |
|
| 125 | - * @psalm-return array<string, array<int, string>> |
|
| 126 | - */ |
|
| 127 | - public function getPrefixesPsr4() |
|
| 128 | - { |
|
| 129 | - return $this->prefixDirsPsr4; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * @return array[] |
|
| 134 | - * @psalm-return array<string, string> |
|
| 135 | - */ |
|
| 136 | - public function getFallbackDirs() |
|
| 137 | - { |
|
| 138 | - return $this->fallbackDirsPsr0; |
|
| 139 | - } |
|
| 140 | - |
|
| 141 | - /** |
|
| 142 | - * @return array[] |
|
| 143 | - * @psalm-return array<string, string> |
|
| 144 | - */ |
|
| 145 | - public function getFallbackDirsPsr4() |
|
| 146 | - { |
|
| 147 | - return $this->fallbackDirsPsr4; |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * @return string[] Array of classname => path |
|
| 152 | - * @psalm-return array<string, string> |
|
| 153 | - */ |
|
| 154 | - public function getClassMap() |
|
| 155 | - { |
|
| 156 | - return $this->classMap; |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * @param string[] $classMap Class to filename map |
|
| 161 | - * @psalm-param array<string, string> $classMap |
|
| 162 | - * |
|
| 163 | - * @return void |
|
| 164 | - */ |
|
| 165 | - public function addClassMap(array $classMap) |
|
| 166 | - { |
|
| 167 | - if ($this->classMap) { |
|
| 168 | - $this->classMap = array_merge($this->classMap, $classMap); |
|
| 169 | - } else { |
|
| 170 | - $this->classMap = $classMap; |
|
| 171 | - } |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - /** |
|
| 175 | - * Registers a set of PSR-0 directories for a given prefix, either |
|
| 176 | - * appending or prepending to the ones previously set for this prefix. |
|
| 177 | - * |
|
| 178 | - * @param string $prefix The prefix |
|
| 179 | - * @param string[]|string $paths The PSR-0 root directories |
|
| 180 | - * @param bool $prepend Whether to prepend the directories |
|
| 181 | - * |
|
| 182 | - * @return void |
|
| 183 | - */ |
|
| 184 | - public function add($prefix, $paths, $prepend = false) |
|
| 185 | - { |
|
| 186 | - if (!$prefix) { |
|
| 187 | - if ($prepend) { |
|
| 188 | - $this->fallbackDirsPsr0 = array_merge( |
|
| 189 | - (array) $paths, |
|
| 190 | - $this->fallbackDirsPsr0 |
|
| 191 | - ); |
|
| 192 | - } else { |
|
| 193 | - $this->fallbackDirsPsr0 = array_merge( |
|
| 194 | - $this->fallbackDirsPsr0, |
|
| 195 | - (array) $paths |
|
| 196 | - ); |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - return; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - $first = $prefix[0]; |
|
| 203 | - if (!isset($this->prefixesPsr0[$first][$prefix])) { |
|
| 204 | - $this->prefixesPsr0[$first][$prefix] = (array) $paths; |
|
| 205 | - |
|
| 206 | - return; |
|
| 207 | - } |
|
| 208 | - if ($prepend) { |
|
| 209 | - $this->prefixesPsr0[$first][$prefix] = array_merge( |
|
| 210 | - (array) $paths, |
|
| 211 | - $this->prefixesPsr0[$first][$prefix] |
|
| 212 | - ); |
|
| 213 | - } else { |
|
| 214 | - $this->prefixesPsr0[$first][$prefix] = array_merge( |
|
| 215 | - $this->prefixesPsr0[$first][$prefix], |
|
| 216 | - (array) $paths |
|
| 217 | - ); |
|
| 218 | - } |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * Registers a set of PSR-4 directories for a given namespace, either |
|
| 223 | - * appending or prepending to the ones previously set for this namespace. |
|
| 224 | - * |
|
| 225 | - * @param string $prefix The prefix/namespace, with trailing '\\' |
|
| 226 | - * @param string[]|string $paths The PSR-4 base directories |
|
| 227 | - * @param bool $prepend Whether to prepend the directories |
|
| 228 | - * |
|
| 229 | - * @throws \InvalidArgumentException |
|
| 230 | - * |
|
| 231 | - * @return void |
|
| 232 | - */ |
|
| 233 | - public function addPsr4($prefix, $paths, $prepend = false) |
|
| 234 | - { |
|
| 235 | - if (!$prefix) { |
|
| 236 | - // Register directories for the root namespace. |
|
| 237 | - if ($prepend) { |
|
| 238 | - $this->fallbackDirsPsr4 = array_merge( |
|
| 239 | - (array) $paths, |
|
| 240 | - $this->fallbackDirsPsr4 |
|
| 241 | - ); |
|
| 242 | - } else { |
|
| 243 | - $this->fallbackDirsPsr4 = array_merge( |
|
| 244 | - $this->fallbackDirsPsr4, |
|
| 245 | - (array) $paths |
|
| 246 | - ); |
|
| 247 | - } |
|
| 248 | - } elseif (!isset($this->prefixDirsPsr4[$prefix])) { |
|
| 249 | - // Register directories for a new namespace. |
|
| 250 | - $length = strlen($prefix); |
|
| 251 | - if ('\\' !== $prefix[$length - 1]) { |
|
| 252 | - throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); |
|
| 253 | - } |
|
| 254 | - $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; |
|
| 255 | - $this->prefixDirsPsr4[$prefix] = (array) $paths; |
|
| 256 | - } elseif ($prepend) { |
|
| 257 | - // Prepend directories for an already registered namespace. |
|
| 258 | - $this->prefixDirsPsr4[$prefix] = array_merge( |
|
| 259 | - (array) $paths, |
|
| 260 | - $this->prefixDirsPsr4[$prefix] |
|
| 261 | - ); |
|
| 262 | - } else { |
|
| 263 | - // Append directories for an already registered namespace. |
|
| 264 | - $this->prefixDirsPsr4[$prefix] = array_merge( |
|
| 265 | - $this->prefixDirsPsr4[$prefix], |
|
| 266 | - (array) $paths |
|
| 267 | - ); |
|
| 268 | - } |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - /** |
|
| 272 | - * Registers a set of PSR-0 directories for a given prefix, |
|
| 273 | - * replacing any others previously set for this prefix. |
|
| 274 | - * |
|
| 275 | - * @param string $prefix The prefix |
|
| 276 | - * @param string[]|string $paths The PSR-0 base directories |
|
| 277 | - * |
|
| 278 | - * @return void |
|
| 279 | - */ |
|
| 280 | - public function set($prefix, $paths) |
|
| 281 | - { |
|
| 282 | - if (!$prefix) { |
|
| 283 | - $this->fallbackDirsPsr0 = (array) $paths; |
|
| 284 | - } else { |
|
| 285 | - $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths; |
|
| 286 | - } |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - /** |
|
| 290 | - * Registers a set of PSR-4 directories for a given namespace, |
|
| 291 | - * replacing any others previously set for this namespace. |
|
| 292 | - * |
|
| 293 | - * @param string $prefix The prefix/namespace, with trailing '\\' |
|
| 294 | - * @param string[]|string $paths The PSR-4 base directories |
|
| 295 | - * |
|
| 296 | - * @throws \InvalidArgumentException |
|
| 297 | - * |
|
| 298 | - * @return void |
|
| 299 | - */ |
|
| 300 | - public function setPsr4($prefix, $paths) |
|
| 301 | - { |
|
| 302 | - if (!$prefix) { |
|
| 303 | - $this->fallbackDirsPsr4 = (array) $paths; |
|
| 304 | - } else { |
|
| 305 | - $length = strlen($prefix); |
|
| 306 | - if ('\\' !== $prefix[$length - 1]) { |
|
| 307 | - throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); |
|
| 308 | - } |
|
| 309 | - $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; |
|
| 310 | - $this->prefixDirsPsr4[$prefix] = (array) $paths; |
|
| 311 | - } |
|
| 312 | - } |
|
| 313 | - |
|
| 314 | - /** |
|
| 315 | - * Turns on searching the include path for class files. |
|
| 316 | - * |
|
| 317 | - * @param bool $useIncludePath |
|
| 318 | - * |
|
| 319 | - * @return void |
|
| 320 | - */ |
|
| 321 | - public function setUseIncludePath($useIncludePath) |
|
| 322 | - { |
|
| 323 | - $this->useIncludePath = $useIncludePath; |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - /** |
|
| 327 | - * Can be used to check if the autoloader uses the include path to check |
|
| 328 | - * for classes. |
|
| 329 | - * |
|
| 330 | - * @return bool |
|
| 331 | - */ |
|
| 332 | - public function getUseIncludePath() |
|
| 333 | - { |
|
| 334 | - return $this->useIncludePath; |
|
| 335 | - } |
|
| 336 | - |
|
| 337 | - /** |
|
| 338 | - * Turns off searching the prefix and fallback directories for classes |
|
| 339 | - * that have not been registered with the class map. |
|
| 340 | - * |
|
| 341 | - * @param bool $classMapAuthoritative |
|
| 342 | - * |
|
| 343 | - * @return void |
|
| 344 | - */ |
|
| 345 | - public function setClassMapAuthoritative($classMapAuthoritative) |
|
| 346 | - { |
|
| 347 | - $this->classMapAuthoritative = $classMapAuthoritative; |
|
| 348 | - } |
|
| 349 | - |
|
| 350 | - /** |
|
| 351 | - * Should class lookup fail if not found in the current class map? |
|
| 352 | - * |
|
| 353 | - * @return bool |
|
| 354 | - */ |
|
| 355 | - public function isClassMapAuthoritative() |
|
| 356 | - { |
|
| 357 | - return $this->classMapAuthoritative; |
|
| 358 | - } |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * APCu prefix to use to cache found/not-found classes, if the extension is enabled. |
|
| 362 | - * |
|
| 363 | - * @param string|null $apcuPrefix |
|
| 364 | - * |
|
| 365 | - * @return void |
|
| 366 | - */ |
|
| 367 | - public function setApcuPrefix($apcuPrefix) |
|
| 368 | - { |
|
| 369 | - $this->apcuPrefix = function_exists('apcu_fetch') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN) ? $apcuPrefix : null; |
|
| 370 | - } |
|
| 371 | - |
|
| 372 | - /** |
|
| 373 | - * The APCu prefix in use, or null if APCu caching is not enabled. |
|
| 374 | - * |
|
| 375 | - * @return string|null |
|
| 376 | - */ |
|
| 377 | - public function getApcuPrefix() |
|
| 378 | - { |
|
| 379 | - return $this->apcuPrefix; |
|
| 380 | - } |
|
| 381 | - |
|
| 382 | - /** |
|
| 383 | - * Registers this instance as an autoloader. |
|
| 384 | - * |
|
| 385 | - * @param bool $prepend Whether to prepend the autoloader or not |
|
| 386 | - * |
|
| 387 | - * @return void |
|
| 388 | - */ |
|
| 389 | - public function register($prepend = false) |
|
| 390 | - { |
|
| 391 | - spl_autoload_register(array($this, 'loadClass'), true, $prepend); |
|
| 392 | - |
|
| 393 | - if (null === $this->vendorDir) { |
|
| 394 | - return; |
|
| 395 | - } |
|
| 396 | - |
|
| 397 | - if ($prepend) { |
|
| 398 | - self::$registeredLoaders = array($this->vendorDir => $this) + self::$registeredLoaders; |
|
| 399 | - } else { |
|
| 400 | - unset(self::$registeredLoaders[$this->vendorDir]); |
|
| 401 | - self::$registeredLoaders[$this->vendorDir] = $this; |
|
| 402 | - } |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - /** |
|
| 406 | - * Unregisters this instance as an autoloader. |
|
| 407 | - * |
|
| 408 | - * @return void |
|
| 409 | - */ |
|
| 410 | - public function unregister() |
|
| 411 | - { |
|
| 412 | - spl_autoload_unregister(array($this, 'loadClass')); |
|
| 413 | - |
|
| 414 | - if (null !== $this->vendorDir) { |
|
| 415 | - unset(self::$registeredLoaders[$this->vendorDir]); |
|
| 416 | - } |
|
| 417 | - } |
|
| 418 | - |
|
| 419 | - /** |
|
| 420 | - * Loads the given class or interface. |
|
| 421 | - * |
|
| 422 | - * @param string $class The name of the class |
|
| 423 | - * @return true|null True if loaded, null otherwise |
|
| 424 | - */ |
|
| 425 | - public function loadClass($class) |
|
| 426 | - { |
|
| 427 | - if ($file = $this->findFile($class)) { |
|
| 428 | - includeFile($file); |
|
| 429 | - |
|
| 430 | - return true; |
|
| 431 | - } |
|
| 432 | - |
|
| 433 | - return null; |
|
| 434 | - } |
|
| 435 | - |
|
| 436 | - /** |
|
| 437 | - * Finds the path to the file where the class is defined. |
|
| 438 | - * |
|
| 439 | - * @param string $class The name of the class |
|
| 440 | - * |
|
| 441 | - * @return string|false The path if found, false otherwise |
|
| 442 | - */ |
|
| 443 | - public function findFile($class) |
|
| 444 | - { |
|
| 445 | - // class map lookup |
|
| 446 | - if (isset($this->classMap[$class])) { |
|
| 447 | - return $this->classMap[$class]; |
|
| 448 | - } |
|
| 449 | - if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) { |
|
| 450 | - return false; |
|
| 451 | - } |
|
| 452 | - if (null !== $this->apcuPrefix) { |
|
| 453 | - $file = apcu_fetch($this->apcuPrefix.$class, $hit); |
|
| 454 | - if ($hit) { |
|
| 455 | - return $file; |
|
| 456 | - } |
|
| 457 | - } |
|
| 458 | - |
|
| 459 | - $file = $this->findFileWithExtension($class, '.php'); |
|
| 460 | - |
|
| 461 | - // Search for Hack files if we are running on HHVM |
|
| 462 | - if (false === $file && defined('HHVM_VERSION')) { |
|
| 463 | - $file = $this->findFileWithExtension($class, '.hh'); |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - if (null !== $this->apcuPrefix) { |
|
| 467 | - apcu_add($this->apcuPrefix.$class, $file); |
|
| 468 | - } |
|
| 469 | - |
|
| 470 | - if (false === $file) { |
|
| 471 | - // Remember that this class does not exist. |
|
| 472 | - $this->missingClasses[$class] = true; |
|
| 473 | - } |
|
| 474 | - |
|
| 475 | - return $file; |
|
| 476 | - } |
|
| 477 | - |
|
| 478 | - /** |
|
| 479 | - * Returns the currently registered loaders indexed by their corresponding vendor directories. |
|
| 480 | - * |
|
| 481 | - * @return self[] |
|
| 482 | - */ |
|
| 483 | - public static function getRegisteredLoaders() |
|
| 484 | - { |
|
| 485 | - return self::$registeredLoaders; |
|
| 486 | - } |
|
| 487 | - |
|
| 488 | - /** |
|
| 489 | - * @param string $class |
|
| 490 | - * @param string $ext |
|
| 491 | - * @return string|false |
|
| 492 | - */ |
|
| 493 | - private function findFileWithExtension($class, $ext) |
|
| 494 | - { |
|
| 495 | - // PSR-4 lookup |
|
| 496 | - $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext; |
|
| 497 | - |
|
| 498 | - $first = $class[0]; |
|
| 499 | - if (isset($this->prefixLengthsPsr4[$first])) { |
|
| 500 | - $subPath = $class; |
|
| 501 | - while (false !== $lastPos = strrpos($subPath, '\\')) { |
|
| 502 | - $subPath = substr($subPath, 0, $lastPos); |
|
| 503 | - $search = $subPath . '\\'; |
|
| 504 | - if (isset($this->prefixDirsPsr4[$search])) { |
|
| 505 | - $pathEnd = DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $lastPos + 1); |
|
| 506 | - foreach ($this->prefixDirsPsr4[$search] as $dir) { |
|
| 507 | - if (file_exists($file = $dir . $pathEnd)) { |
|
| 508 | - return $file; |
|
| 509 | - } |
|
| 510 | - } |
|
| 511 | - } |
|
| 512 | - } |
|
| 513 | - } |
|
| 514 | - |
|
| 515 | - // PSR-4 fallback dirs |
|
| 516 | - foreach ($this->fallbackDirsPsr4 as $dir) { |
|
| 517 | - if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) { |
|
| 518 | - return $file; |
|
| 519 | - } |
|
| 520 | - } |
|
| 521 | - |
|
| 522 | - // PSR-0 lookup |
|
| 523 | - if (false !== $pos = strrpos($class, '\\')) { |
|
| 524 | - // namespaced class name |
|
| 525 | - $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1) |
|
| 526 | - . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR); |
|
| 527 | - } else { |
|
| 528 | - // PEAR-like class name |
|
| 529 | - $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext; |
|
| 530 | - } |
|
| 531 | - |
|
| 532 | - if (isset($this->prefixesPsr0[$first])) { |
|
| 533 | - foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) { |
|
| 534 | - if (0 === strpos($class, $prefix)) { |
|
| 535 | - foreach ($dirs as $dir) { |
|
| 536 | - if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { |
|
| 537 | - return $file; |
|
| 538 | - } |
|
| 539 | - } |
|
| 540 | - } |
|
| 541 | - } |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - // PSR-0 fallback dirs |
|
| 545 | - foreach ($this->fallbackDirsPsr0 as $dir) { |
|
| 546 | - if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { |
|
| 547 | - return $file; |
|
| 548 | - } |
|
| 549 | - } |
|
| 550 | - |
|
| 551 | - // PSR-0 include paths. |
|
| 552 | - if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) { |
|
| 553 | - return $file; |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - return false; |
|
| 557 | - } |
|
| 45 | + /** @var ?string */ |
|
| 46 | + private $vendorDir; |
|
| 47 | + |
|
| 48 | + // PSR-4 |
|
| 49 | + /** |
|
| 50 | + * @var array[] |
|
| 51 | + * @psalm-var array<string, array<string, int>> |
|
| 52 | + */ |
|
| 53 | + private $prefixLengthsPsr4 = array(); |
|
| 54 | + /** |
|
| 55 | + * @var array[] |
|
| 56 | + * @psalm-var array<string, array<int, string>> |
|
| 57 | + */ |
|
| 58 | + private $prefixDirsPsr4 = array(); |
|
| 59 | + /** |
|
| 60 | + * @var array[] |
|
| 61 | + * @psalm-var array<string, string> |
|
| 62 | + */ |
|
| 63 | + private $fallbackDirsPsr4 = array(); |
|
| 64 | + |
|
| 65 | + // PSR-0 |
|
| 66 | + /** |
|
| 67 | + * @var array[] |
|
| 68 | + * @psalm-var array<string, array<string, string[]>> |
|
| 69 | + */ |
|
| 70 | + private $prefixesPsr0 = array(); |
|
| 71 | + /** |
|
| 72 | + * @var array[] |
|
| 73 | + * @psalm-var array<string, string> |
|
| 74 | + */ |
|
| 75 | + private $fallbackDirsPsr0 = array(); |
|
| 76 | + |
|
| 77 | + /** @var bool */ |
|
| 78 | + private $useIncludePath = false; |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * @var string[] |
|
| 82 | + * @psalm-var array<string, string> |
|
| 83 | + */ |
|
| 84 | + private $classMap = array(); |
|
| 85 | + |
|
| 86 | + /** @var bool */ |
|
| 87 | + private $classMapAuthoritative = false; |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * @var bool[] |
|
| 91 | + * @psalm-var array<string, bool> |
|
| 92 | + */ |
|
| 93 | + private $missingClasses = array(); |
|
| 94 | + |
|
| 95 | + /** @var ?string */ |
|
| 96 | + private $apcuPrefix; |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * @var self[] |
|
| 100 | + */ |
|
| 101 | + private static $registeredLoaders = array(); |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * @param ?string $vendorDir |
|
| 105 | + */ |
|
| 106 | + public function __construct($vendorDir = null) |
|
| 107 | + { |
|
| 108 | + $this->vendorDir = $vendorDir; |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * @return string[] |
|
| 113 | + */ |
|
| 114 | + public function getPrefixes() |
|
| 115 | + { |
|
| 116 | + if (!empty($this->prefixesPsr0)) { |
|
| 117 | + return call_user_func_array('array_merge', array_values($this->prefixesPsr0)); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + return array(); |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * @return array[] |
|
| 125 | + * @psalm-return array<string, array<int, string>> |
|
| 126 | + */ |
|
| 127 | + public function getPrefixesPsr4() |
|
| 128 | + { |
|
| 129 | + return $this->prefixDirsPsr4; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * @return array[] |
|
| 134 | + * @psalm-return array<string, string> |
|
| 135 | + */ |
|
| 136 | + public function getFallbackDirs() |
|
| 137 | + { |
|
| 138 | + return $this->fallbackDirsPsr0; |
|
| 139 | + } |
|
| 140 | + |
|
| 141 | + /** |
|
| 142 | + * @return array[] |
|
| 143 | + * @psalm-return array<string, string> |
|
| 144 | + */ |
|
| 145 | + public function getFallbackDirsPsr4() |
|
| 146 | + { |
|
| 147 | + return $this->fallbackDirsPsr4; |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * @return string[] Array of classname => path |
|
| 152 | + * @psalm-return array<string, string> |
|
| 153 | + */ |
|
| 154 | + public function getClassMap() |
|
| 155 | + { |
|
| 156 | + return $this->classMap; |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * @param string[] $classMap Class to filename map |
|
| 161 | + * @psalm-param array<string, string> $classMap |
|
| 162 | + * |
|
| 163 | + * @return void |
|
| 164 | + */ |
|
| 165 | + public function addClassMap(array $classMap) |
|
| 166 | + { |
|
| 167 | + if ($this->classMap) { |
|
| 168 | + $this->classMap = array_merge($this->classMap, $classMap); |
|
| 169 | + } else { |
|
| 170 | + $this->classMap = $classMap; |
|
| 171 | + } |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + /** |
|
| 175 | + * Registers a set of PSR-0 directories for a given prefix, either |
|
| 176 | + * appending or prepending to the ones previously set for this prefix. |
|
| 177 | + * |
|
| 178 | + * @param string $prefix The prefix |
|
| 179 | + * @param string[]|string $paths The PSR-0 root directories |
|
| 180 | + * @param bool $prepend Whether to prepend the directories |
|
| 181 | + * |
|
| 182 | + * @return void |
|
| 183 | + */ |
|
| 184 | + public function add($prefix, $paths, $prepend = false) |
|
| 185 | + { |
|
| 186 | + if (!$prefix) { |
|
| 187 | + if ($prepend) { |
|
| 188 | + $this->fallbackDirsPsr0 = array_merge( |
|
| 189 | + (array) $paths, |
|
| 190 | + $this->fallbackDirsPsr0 |
|
| 191 | + ); |
|
| 192 | + } else { |
|
| 193 | + $this->fallbackDirsPsr0 = array_merge( |
|
| 194 | + $this->fallbackDirsPsr0, |
|
| 195 | + (array) $paths |
|
| 196 | + ); |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + return; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + $first = $prefix[0]; |
|
| 203 | + if (!isset($this->prefixesPsr0[$first][$prefix])) { |
|
| 204 | + $this->prefixesPsr0[$first][$prefix] = (array) $paths; |
|
| 205 | + |
|
| 206 | + return; |
|
| 207 | + } |
|
| 208 | + if ($prepend) { |
|
| 209 | + $this->prefixesPsr0[$first][$prefix] = array_merge( |
|
| 210 | + (array) $paths, |
|
| 211 | + $this->prefixesPsr0[$first][$prefix] |
|
| 212 | + ); |
|
| 213 | + } else { |
|
| 214 | + $this->prefixesPsr0[$first][$prefix] = array_merge( |
|
| 215 | + $this->prefixesPsr0[$first][$prefix], |
|
| 216 | + (array) $paths |
|
| 217 | + ); |
|
| 218 | + } |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * Registers a set of PSR-4 directories for a given namespace, either |
|
| 223 | + * appending or prepending to the ones previously set for this namespace. |
|
| 224 | + * |
|
| 225 | + * @param string $prefix The prefix/namespace, with trailing '\\' |
|
| 226 | + * @param string[]|string $paths The PSR-4 base directories |
|
| 227 | + * @param bool $prepend Whether to prepend the directories |
|
| 228 | + * |
|
| 229 | + * @throws \InvalidArgumentException |
|
| 230 | + * |
|
| 231 | + * @return void |
|
| 232 | + */ |
|
| 233 | + public function addPsr4($prefix, $paths, $prepend = false) |
|
| 234 | + { |
|
| 235 | + if (!$prefix) { |
|
| 236 | + // Register directories for the root namespace. |
|
| 237 | + if ($prepend) { |
|
| 238 | + $this->fallbackDirsPsr4 = array_merge( |
|
| 239 | + (array) $paths, |
|
| 240 | + $this->fallbackDirsPsr4 |
|
| 241 | + ); |
|
| 242 | + } else { |
|
| 243 | + $this->fallbackDirsPsr4 = array_merge( |
|
| 244 | + $this->fallbackDirsPsr4, |
|
| 245 | + (array) $paths |
|
| 246 | + ); |
|
| 247 | + } |
|
| 248 | + } elseif (!isset($this->prefixDirsPsr4[$prefix])) { |
|
| 249 | + // Register directories for a new namespace. |
|
| 250 | + $length = strlen($prefix); |
|
| 251 | + if ('\\' !== $prefix[$length - 1]) { |
|
| 252 | + throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); |
|
| 253 | + } |
|
| 254 | + $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; |
|
| 255 | + $this->prefixDirsPsr4[$prefix] = (array) $paths; |
|
| 256 | + } elseif ($prepend) { |
|
| 257 | + // Prepend directories for an already registered namespace. |
|
| 258 | + $this->prefixDirsPsr4[$prefix] = array_merge( |
|
| 259 | + (array) $paths, |
|
| 260 | + $this->prefixDirsPsr4[$prefix] |
|
| 261 | + ); |
|
| 262 | + } else { |
|
| 263 | + // Append directories for an already registered namespace. |
|
| 264 | + $this->prefixDirsPsr4[$prefix] = array_merge( |
|
| 265 | + $this->prefixDirsPsr4[$prefix], |
|
| 266 | + (array) $paths |
|
| 267 | + ); |
|
| 268 | + } |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + /** |
|
| 272 | + * Registers a set of PSR-0 directories for a given prefix, |
|
| 273 | + * replacing any others previously set for this prefix. |
|
| 274 | + * |
|
| 275 | + * @param string $prefix The prefix |
|
| 276 | + * @param string[]|string $paths The PSR-0 base directories |
|
| 277 | + * |
|
| 278 | + * @return void |
|
| 279 | + */ |
|
| 280 | + public function set($prefix, $paths) |
|
| 281 | + { |
|
| 282 | + if (!$prefix) { |
|
| 283 | + $this->fallbackDirsPsr0 = (array) $paths; |
|
| 284 | + } else { |
|
| 285 | + $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths; |
|
| 286 | + } |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + /** |
|
| 290 | + * Registers a set of PSR-4 directories for a given namespace, |
|
| 291 | + * replacing any others previously set for this namespace. |
|
| 292 | + * |
|
| 293 | + * @param string $prefix The prefix/namespace, with trailing '\\' |
|
| 294 | + * @param string[]|string $paths The PSR-4 base directories |
|
| 295 | + * |
|
| 296 | + * @throws \InvalidArgumentException |
|
| 297 | + * |
|
| 298 | + * @return void |
|
| 299 | + */ |
|
| 300 | + public function setPsr4($prefix, $paths) |
|
| 301 | + { |
|
| 302 | + if (!$prefix) { |
|
| 303 | + $this->fallbackDirsPsr4 = (array) $paths; |
|
| 304 | + } else { |
|
| 305 | + $length = strlen($prefix); |
|
| 306 | + if ('\\' !== $prefix[$length - 1]) { |
|
| 307 | + throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); |
|
| 308 | + } |
|
| 309 | + $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; |
|
| 310 | + $this->prefixDirsPsr4[$prefix] = (array) $paths; |
|
| 311 | + } |
|
| 312 | + } |
|
| 313 | + |
|
| 314 | + /** |
|
| 315 | + * Turns on searching the include path for class files. |
|
| 316 | + * |
|
| 317 | + * @param bool $useIncludePath |
|
| 318 | + * |
|
| 319 | + * @return void |
|
| 320 | + */ |
|
| 321 | + public function setUseIncludePath($useIncludePath) |
|
| 322 | + { |
|
| 323 | + $this->useIncludePath = $useIncludePath; |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + /** |
|
| 327 | + * Can be used to check if the autoloader uses the include path to check |
|
| 328 | + * for classes. |
|
| 329 | + * |
|
| 330 | + * @return bool |
|
| 331 | + */ |
|
| 332 | + public function getUseIncludePath() |
|
| 333 | + { |
|
| 334 | + return $this->useIncludePath; |
|
| 335 | + } |
|
| 336 | + |
|
| 337 | + /** |
|
| 338 | + * Turns off searching the prefix and fallback directories for classes |
|
| 339 | + * that have not been registered with the class map. |
|
| 340 | + * |
|
| 341 | + * @param bool $classMapAuthoritative |
|
| 342 | + * |
|
| 343 | + * @return void |
|
| 344 | + */ |
|
| 345 | + public function setClassMapAuthoritative($classMapAuthoritative) |
|
| 346 | + { |
|
| 347 | + $this->classMapAuthoritative = $classMapAuthoritative; |
|
| 348 | + } |
|
| 349 | + |
|
| 350 | + /** |
|
| 351 | + * Should class lookup fail if not found in the current class map? |
|
| 352 | + * |
|
| 353 | + * @return bool |
|
| 354 | + */ |
|
| 355 | + public function isClassMapAuthoritative() |
|
| 356 | + { |
|
| 357 | + return $this->classMapAuthoritative; |
|
| 358 | + } |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * APCu prefix to use to cache found/not-found classes, if the extension is enabled. |
|
| 362 | + * |
|
| 363 | + * @param string|null $apcuPrefix |
|
| 364 | + * |
|
| 365 | + * @return void |
|
| 366 | + */ |
|
| 367 | + public function setApcuPrefix($apcuPrefix) |
|
| 368 | + { |
|
| 369 | + $this->apcuPrefix = function_exists('apcu_fetch') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN) ? $apcuPrefix : null; |
|
| 370 | + } |
|
| 371 | + |
|
| 372 | + /** |
|
| 373 | + * The APCu prefix in use, or null if APCu caching is not enabled. |
|
| 374 | + * |
|
| 375 | + * @return string|null |
|
| 376 | + */ |
|
| 377 | + public function getApcuPrefix() |
|
| 378 | + { |
|
| 379 | + return $this->apcuPrefix; |
|
| 380 | + } |
|
| 381 | + |
|
| 382 | + /** |
|
| 383 | + * Registers this instance as an autoloader. |
|
| 384 | + * |
|
| 385 | + * @param bool $prepend Whether to prepend the autoloader or not |
|
| 386 | + * |
|
| 387 | + * @return void |
|
| 388 | + */ |
|
| 389 | + public function register($prepend = false) |
|
| 390 | + { |
|
| 391 | + spl_autoload_register(array($this, 'loadClass'), true, $prepend); |
|
| 392 | + |
|
| 393 | + if (null === $this->vendorDir) { |
|
| 394 | + return; |
|
| 395 | + } |
|
| 396 | + |
|
| 397 | + if ($prepend) { |
|
| 398 | + self::$registeredLoaders = array($this->vendorDir => $this) + self::$registeredLoaders; |
|
| 399 | + } else { |
|
| 400 | + unset(self::$registeredLoaders[$this->vendorDir]); |
|
| 401 | + self::$registeredLoaders[$this->vendorDir] = $this; |
|
| 402 | + } |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + /** |
|
| 406 | + * Unregisters this instance as an autoloader. |
|
| 407 | + * |
|
| 408 | + * @return void |
|
| 409 | + */ |
|
| 410 | + public function unregister() |
|
| 411 | + { |
|
| 412 | + spl_autoload_unregister(array($this, 'loadClass')); |
|
| 413 | + |
|
| 414 | + if (null !== $this->vendorDir) { |
|
| 415 | + unset(self::$registeredLoaders[$this->vendorDir]); |
|
| 416 | + } |
|
| 417 | + } |
|
| 418 | + |
|
| 419 | + /** |
|
| 420 | + * Loads the given class or interface. |
|
| 421 | + * |
|
| 422 | + * @param string $class The name of the class |
|
| 423 | + * @return true|null True if loaded, null otherwise |
|
| 424 | + */ |
|
| 425 | + public function loadClass($class) |
|
| 426 | + { |
|
| 427 | + if ($file = $this->findFile($class)) { |
|
| 428 | + includeFile($file); |
|
| 429 | + |
|
| 430 | + return true; |
|
| 431 | + } |
|
| 432 | + |
|
| 433 | + return null; |
|
| 434 | + } |
|
| 435 | + |
|
| 436 | + /** |
|
| 437 | + * Finds the path to the file where the class is defined. |
|
| 438 | + * |
|
| 439 | + * @param string $class The name of the class |
|
| 440 | + * |
|
| 441 | + * @return string|false The path if found, false otherwise |
|
| 442 | + */ |
|
| 443 | + public function findFile($class) |
|
| 444 | + { |
|
| 445 | + // class map lookup |
|
| 446 | + if (isset($this->classMap[$class])) { |
|
| 447 | + return $this->classMap[$class]; |
|
| 448 | + } |
|
| 449 | + if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) { |
|
| 450 | + return false; |
|
| 451 | + } |
|
| 452 | + if (null !== $this->apcuPrefix) { |
|
| 453 | + $file = apcu_fetch($this->apcuPrefix.$class, $hit); |
|
| 454 | + if ($hit) { |
|
| 455 | + return $file; |
|
| 456 | + } |
|
| 457 | + } |
|
| 458 | + |
|
| 459 | + $file = $this->findFileWithExtension($class, '.php'); |
|
| 460 | + |
|
| 461 | + // Search for Hack files if we are running on HHVM |
|
| 462 | + if (false === $file && defined('HHVM_VERSION')) { |
|
| 463 | + $file = $this->findFileWithExtension($class, '.hh'); |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + if (null !== $this->apcuPrefix) { |
|
| 467 | + apcu_add($this->apcuPrefix.$class, $file); |
|
| 468 | + } |
|
| 469 | + |
|
| 470 | + if (false === $file) { |
|
| 471 | + // Remember that this class does not exist. |
|
| 472 | + $this->missingClasses[$class] = true; |
|
| 473 | + } |
|
| 474 | + |
|
| 475 | + return $file; |
|
| 476 | + } |
|
| 477 | + |
|
| 478 | + /** |
|
| 479 | + * Returns the currently registered loaders indexed by their corresponding vendor directories. |
|
| 480 | + * |
|
| 481 | + * @return self[] |
|
| 482 | + */ |
|
| 483 | + public static function getRegisteredLoaders() |
|
| 484 | + { |
|
| 485 | + return self::$registeredLoaders; |
|
| 486 | + } |
|
| 487 | + |
|
| 488 | + /** |
|
| 489 | + * @param string $class |
|
| 490 | + * @param string $ext |
|
| 491 | + * @return string|false |
|
| 492 | + */ |
|
| 493 | + private function findFileWithExtension($class, $ext) |
|
| 494 | + { |
|
| 495 | + // PSR-4 lookup |
|
| 496 | + $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext; |
|
| 497 | + |
|
| 498 | + $first = $class[0]; |
|
| 499 | + if (isset($this->prefixLengthsPsr4[$first])) { |
|
| 500 | + $subPath = $class; |
|
| 501 | + while (false !== $lastPos = strrpos($subPath, '\\')) { |
|
| 502 | + $subPath = substr($subPath, 0, $lastPos); |
|
| 503 | + $search = $subPath . '\\'; |
|
| 504 | + if (isset($this->prefixDirsPsr4[$search])) { |
|
| 505 | + $pathEnd = DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $lastPos + 1); |
|
| 506 | + foreach ($this->prefixDirsPsr4[$search] as $dir) { |
|
| 507 | + if (file_exists($file = $dir . $pathEnd)) { |
|
| 508 | + return $file; |
|
| 509 | + } |
|
| 510 | + } |
|
| 511 | + } |
|
| 512 | + } |
|
| 513 | + } |
|
| 514 | + |
|
| 515 | + // PSR-4 fallback dirs |
|
| 516 | + foreach ($this->fallbackDirsPsr4 as $dir) { |
|
| 517 | + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) { |
|
| 518 | + return $file; |
|
| 519 | + } |
|
| 520 | + } |
|
| 521 | + |
|
| 522 | + // PSR-0 lookup |
|
| 523 | + if (false !== $pos = strrpos($class, '\\')) { |
|
| 524 | + // namespaced class name |
|
| 525 | + $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1) |
|
| 526 | + . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR); |
|
| 527 | + } else { |
|
| 528 | + // PEAR-like class name |
|
| 529 | + $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext; |
|
| 530 | + } |
|
| 531 | + |
|
| 532 | + if (isset($this->prefixesPsr0[$first])) { |
|
| 533 | + foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) { |
|
| 534 | + if (0 === strpos($class, $prefix)) { |
|
| 535 | + foreach ($dirs as $dir) { |
|
| 536 | + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { |
|
| 537 | + return $file; |
|
| 538 | + } |
|
| 539 | + } |
|
| 540 | + } |
|
| 541 | + } |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + // PSR-0 fallback dirs |
|
| 545 | + foreach ($this->fallbackDirsPsr0 as $dir) { |
|
| 546 | + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { |
|
| 547 | + return $file; |
|
| 548 | + } |
|
| 549 | + } |
|
| 550 | + |
|
| 551 | + // PSR-0 include paths. |
|
| 552 | + if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) { |
|
| 553 | + return $file; |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + return false; |
|
| 557 | + } |
|
| 558 | 558 | } |
| 559 | 559 | |
| 560 | 560 | /** |
@@ -568,5 +568,5 @@ discard block |
||
| 568 | 568 | */ |
| 569 | 569 | function includeFile($file) |
| 570 | 570 | { |
| 571 | - include $file; |
|
| 571 | + include $file; |
|
| 572 | 572 | } |
@@ -6,5 +6,5 @@ |
||
| 6 | 6 | $baseDir = dirname($vendorDir); |
| 7 | 7 | |
| 8 | 8 | return array( |
| 9 | - 'Composer\\InstalledVersions' => $vendorDir . '/composer/InstalledVersions.php', |
|
| 9 | + 'Composer\\InstalledVersions' => $vendorDir . '/composer/InstalledVersions.php', |
|
| 10 | 10 | ); |
@@ -24,327 +24,327 @@ |
||
| 24 | 24 | */ |
| 25 | 25 | class InstalledVersions |
| 26 | 26 | { |
| 27 | - /** |
|
| 28 | - * @var mixed[]|null |
|
| 29 | - * @psalm-var array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>}|array{}|null |
|
| 30 | - */ |
|
| 31 | - private static $installed; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @var bool|null |
|
| 35 | - */ |
|
| 36 | - private static $canGetVendors; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * @var array[] |
|
| 40 | - * @psalm-var array<string, array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>}> |
|
| 41 | - */ |
|
| 42 | - private static $installedByVendor = array(); |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * Returns a list of all package names which are present, either by being installed, replaced or provided |
|
| 46 | - * |
|
| 47 | - * @return string[] |
|
| 48 | - * @psalm-return list<string> |
|
| 49 | - */ |
|
| 50 | - public static function getInstalledPackages() |
|
| 51 | - { |
|
| 52 | - $packages = array(); |
|
| 53 | - foreach (self::getInstalled() as $installed) { |
|
| 54 | - $packages[] = array_keys($installed['versions']); |
|
| 55 | - } |
|
| 56 | - |
|
| 57 | - if (1 === \count($packages)) { |
|
| 58 | - return $packages[0]; |
|
| 59 | - } |
|
| 60 | - |
|
| 61 | - return array_keys(array_flip(\call_user_func_array('array_merge', $packages))); |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * Returns a list of all package names with a specific type e.g. 'library' |
|
| 66 | - * |
|
| 67 | - * @param string $type |
|
| 68 | - * @return string[] |
|
| 69 | - * @psalm-return list<string> |
|
| 70 | - */ |
|
| 71 | - public static function getInstalledPackagesByType($type) |
|
| 72 | - { |
|
| 73 | - $packagesByType = array(); |
|
| 74 | - |
|
| 75 | - foreach (self::getInstalled() as $installed) { |
|
| 76 | - foreach ($installed['versions'] as $name => $package) { |
|
| 77 | - if (isset($package['type']) && $package['type'] === $type) { |
|
| 78 | - $packagesByType[] = $name; |
|
| 79 | - } |
|
| 80 | - } |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - return $packagesByType; |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * Checks whether the given package is installed |
|
| 88 | - * |
|
| 89 | - * This also returns true if the package name is provided or replaced by another package |
|
| 90 | - * |
|
| 91 | - * @param string $packageName |
|
| 92 | - * @param bool $includeDevRequirements |
|
| 93 | - * @return bool |
|
| 94 | - */ |
|
| 95 | - public static function isInstalled($packageName, $includeDevRequirements = true) |
|
| 96 | - { |
|
| 97 | - foreach (self::getInstalled() as $installed) { |
|
| 98 | - if (isset($installed['versions'][$packageName])) { |
|
| 99 | - return $includeDevRequirements || empty($installed['versions'][$packageName]['dev_requirement']); |
|
| 100 | - } |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - return false; |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Checks whether the given package satisfies a version constraint |
|
| 108 | - * |
|
| 109 | - * e.g. If you want to know whether version 2.3+ of package foo/bar is installed, you would call: |
|
| 110 | - * |
|
| 111 | - * Composer\InstalledVersions::satisfies(new VersionParser, 'foo/bar', '^2.3') |
|
| 112 | - * |
|
| 113 | - * @param VersionParser $parser Install composer/semver to have access to this class and functionality |
|
| 114 | - * @param string $packageName |
|
| 115 | - * @param string|null $constraint A version constraint to check for, if you pass one you have to make sure composer/semver is required by your package |
|
| 116 | - * @return bool |
|
| 117 | - */ |
|
| 118 | - public static function satisfies(VersionParser $parser, $packageName, $constraint) |
|
| 119 | - { |
|
| 120 | - $constraint = $parser->parseConstraints($constraint); |
|
| 121 | - $provided = $parser->parseConstraints(self::getVersionRanges($packageName)); |
|
| 122 | - |
|
| 123 | - return $provided->matches($constraint); |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * Returns a version constraint representing all the range(s) which are installed for a given package |
|
| 128 | - * |
|
| 129 | - * It is easier to use this via isInstalled() with the $constraint argument if you need to check |
|
| 130 | - * whether a given version of a package is installed, and not just whether it exists |
|
| 131 | - * |
|
| 132 | - * @param string $packageName |
|
| 133 | - * @return string Version constraint usable with composer/semver |
|
| 134 | - */ |
|
| 135 | - public static function getVersionRanges($packageName) |
|
| 136 | - { |
|
| 137 | - foreach (self::getInstalled() as $installed) { |
|
| 138 | - if (!isset($installed['versions'][$packageName])) { |
|
| 139 | - continue; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - $ranges = array(); |
|
| 143 | - if (isset($installed['versions'][$packageName]['pretty_version'])) { |
|
| 144 | - $ranges[] = $installed['versions'][$packageName]['pretty_version']; |
|
| 145 | - } |
|
| 146 | - if (array_key_exists('aliases', $installed['versions'][$packageName])) { |
|
| 147 | - $ranges = array_merge($ranges, $installed['versions'][$packageName]['aliases']); |
|
| 148 | - } |
|
| 149 | - if (array_key_exists('replaced', $installed['versions'][$packageName])) { |
|
| 150 | - $ranges = array_merge($ranges, $installed['versions'][$packageName]['replaced']); |
|
| 151 | - } |
|
| 152 | - if (array_key_exists('provided', $installed['versions'][$packageName])) { |
|
| 153 | - $ranges = array_merge($ranges, $installed['versions'][$packageName]['provided']); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - return implode(' || ', $ranges); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * @param string $packageName |
|
| 164 | - * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present |
|
| 165 | - */ |
|
| 166 | - public static function getVersion($packageName) |
|
| 167 | - { |
|
| 168 | - foreach (self::getInstalled() as $installed) { |
|
| 169 | - if (!isset($installed['versions'][$packageName])) { |
|
| 170 | - continue; |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - if (!isset($installed['versions'][$packageName]['version'])) { |
|
| 174 | - return null; |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - return $installed['versions'][$packageName]['version']; |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - /** |
|
| 184 | - * @param string $packageName |
|
| 185 | - * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present |
|
| 186 | - */ |
|
| 187 | - public static function getPrettyVersion($packageName) |
|
| 188 | - { |
|
| 189 | - foreach (self::getInstalled() as $installed) { |
|
| 190 | - if (!isset($installed['versions'][$packageName])) { |
|
| 191 | - continue; |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - if (!isset($installed['versions'][$packageName]['pretty_version'])) { |
|
| 195 | - return null; |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - return $installed['versions'][$packageName]['pretty_version']; |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * @param string $packageName |
|
| 206 | - * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as reference |
|
| 207 | - */ |
|
| 208 | - public static function getReference($packageName) |
|
| 209 | - { |
|
| 210 | - foreach (self::getInstalled() as $installed) { |
|
| 211 | - if (!isset($installed['versions'][$packageName])) { |
|
| 212 | - continue; |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - if (!isset($installed['versions'][$packageName]['reference'])) { |
|
| 216 | - return null; |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - return $installed['versions'][$packageName]['reference']; |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * @param string $packageName |
|
| 227 | - * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as install path. Packages of type metapackages also have a null install path. |
|
| 228 | - */ |
|
| 229 | - public static function getInstallPath($packageName) |
|
| 230 | - { |
|
| 231 | - foreach (self::getInstalled() as $installed) { |
|
| 232 | - if (!isset($installed['versions'][$packageName])) { |
|
| 233 | - continue; |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - return isset($installed['versions'][$packageName]['install_path']) ? $installed['versions'][$packageName]['install_path'] : null; |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 240 | - } |
|
| 241 | - |
|
| 242 | - /** |
|
| 243 | - * @return array |
|
| 244 | - * @psalm-return array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string} |
|
| 245 | - */ |
|
| 246 | - public static function getRootPackage() |
|
| 247 | - { |
|
| 248 | - $installed = self::getInstalled(); |
|
| 249 | - |
|
| 250 | - return $installed[0]['root']; |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - /** |
|
| 254 | - * Returns the raw installed.php data for custom implementations |
|
| 255 | - * |
|
| 256 | - * @deprecated Use getAllRawData() instead which returns all datasets for all autoloaders present in the process. getRawData only returns the first dataset loaded, which may not be what you expect. |
|
| 257 | - * @return array[] |
|
| 258 | - * @psalm-return array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>} |
|
| 259 | - */ |
|
| 260 | - public static function getRawData() |
|
| 261 | - { |
|
| 262 | - @trigger_error('getRawData only returns the first dataset loaded, which may not be what you expect. Use getAllRawData() instead which returns all datasets for all autoloaders present in the process.', E_USER_DEPRECATED); |
|
| 263 | - |
|
| 264 | - if (null === self::$installed) { |
|
| 265 | - // only require the installed.php file if this file is loaded from its dumped location, |
|
| 266 | - // and not from its source location in the composer/composer package, see https://github.com/composer/composer/issues/9937 |
|
| 267 | - if (substr(__DIR__, -8, 1) !== 'C') { |
|
| 268 | - self::$installed = include __DIR__ . '/installed.php'; |
|
| 269 | - } else { |
|
| 270 | - self::$installed = array(); |
|
| 271 | - } |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - return self::$installed; |
|
| 275 | - } |
|
| 276 | - |
|
| 277 | - /** |
|
| 278 | - * Returns the raw data of all installed.php which are currently loaded for custom implementations |
|
| 279 | - * |
|
| 280 | - * @return array[] |
|
| 281 | - * @psalm-return list<array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>}> |
|
| 282 | - */ |
|
| 283 | - public static function getAllRawData() |
|
| 284 | - { |
|
| 285 | - return self::getInstalled(); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Lets you reload the static array from another file |
|
| 290 | - * |
|
| 291 | - * This is only useful for complex integrations in which a project needs to use |
|
| 292 | - * this class but then also needs to execute another project's autoloader in process, |
|
| 293 | - * and wants to ensure both projects have access to their version of installed.php. |
|
| 294 | - * |
|
| 295 | - * A typical case would be PHPUnit, where it would need to make sure it reads all |
|
| 296 | - * the data it needs from this class, then call reload() with |
|
| 297 | - * `require $CWD/vendor/composer/installed.php` (or similar) as input to make sure |
|
| 298 | - * the project in which it runs can then also use this class safely, without |
|
| 299 | - * interference between PHPUnit's dependencies and the project's dependencies. |
|
| 300 | - * |
|
| 301 | - * @param array[] $data A vendor/composer/installed.php data set |
|
| 302 | - * @return void |
|
| 303 | - * |
|
| 304 | - * @psalm-param array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>} $data |
|
| 305 | - */ |
|
| 306 | - public static function reload($data) |
|
| 307 | - { |
|
| 308 | - self::$installed = $data; |
|
| 309 | - self::$installedByVendor = array(); |
|
| 310 | - } |
|
| 311 | - |
|
| 312 | - /** |
|
| 313 | - * @return array[] |
|
| 314 | - * @psalm-return list<array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>}> |
|
| 315 | - */ |
|
| 316 | - private static function getInstalled() |
|
| 317 | - { |
|
| 318 | - if (null === self::$canGetVendors) { |
|
| 319 | - self::$canGetVendors = method_exists('Composer\Autoload\ClassLoader', 'getRegisteredLoaders'); |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - $installed = array(); |
|
| 323 | - |
|
| 324 | - if (self::$canGetVendors) { |
|
| 325 | - foreach (ClassLoader::getRegisteredLoaders() as $vendorDir => $loader) { |
|
| 326 | - if (isset(self::$installedByVendor[$vendorDir])) { |
|
| 327 | - $installed[] = self::$installedByVendor[$vendorDir]; |
|
| 328 | - } elseif (is_file($vendorDir.'/composer/installed.php')) { |
|
| 329 | - $installed[] = self::$installedByVendor[$vendorDir] = require $vendorDir.'/composer/installed.php'; |
|
| 330 | - if (null === self::$installed && strtr($vendorDir.'/composer', '\\', '/') === strtr(__DIR__, '\\', '/')) { |
|
| 331 | - self::$installed = $installed[count($installed) - 1]; |
|
| 332 | - } |
|
| 333 | - } |
|
| 334 | - } |
|
| 335 | - } |
|
| 336 | - |
|
| 337 | - if (null === self::$installed) { |
|
| 338 | - // only require the installed.php file if this file is loaded from its dumped location, |
|
| 339 | - // and not from its source location in the composer/composer package, see https://github.com/composer/composer/issues/9937 |
|
| 340 | - if (substr(__DIR__, -8, 1) !== 'C') { |
|
| 341 | - self::$installed = require __DIR__ . '/installed.php'; |
|
| 342 | - } else { |
|
| 343 | - self::$installed = array(); |
|
| 344 | - } |
|
| 345 | - } |
|
| 346 | - $installed[] = self::$installed; |
|
| 347 | - |
|
| 348 | - return $installed; |
|
| 349 | - } |
|
| 27 | + /** |
|
| 28 | + * @var mixed[]|null |
|
| 29 | + * @psalm-var array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>}|array{}|null |
|
| 30 | + */ |
|
| 31 | + private static $installed; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @var bool|null |
|
| 35 | + */ |
|
| 36 | + private static $canGetVendors; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * @var array[] |
|
| 40 | + * @psalm-var array<string, array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>}> |
|
| 41 | + */ |
|
| 42 | + private static $installedByVendor = array(); |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * Returns a list of all package names which are present, either by being installed, replaced or provided |
|
| 46 | + * |
|
| 47 | + * @return string[] |
|
| 48 | + * @psalm-return list<string> |
|
| 49 | + */ |
|
| 50 | + public static function getInstalledPackages() |
|
| 51 | + { |
|
| 52 | + $packages = array(); |
|
| 53 | + foreach (self::getInstalled() as $installed) { |
|
| 54 | + $packages[] = array_keys($installed['versions']); |
|
| 55 | + } |
|
| 56 | + |
|
| 57 | + if (1 === \count($packages)) { |
|
| 58 | + return $packages[0]; |
|
| 59 | + } |
|
| 60 | + |
|
| 61 | + return array_keys(array_flip(\call_user_func_array('array_merge', $packages))); |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * Returns a list of all package names with a specific type e.g. 'library' |
|
| 66 | + * |
|
| 67 | + * @param string $type |
|
| 68 | + * @return string[] |
|
| 69 | + * @psalm-return list<string> |
|
| 70 | + */ |
|
| 71 | + public static function getInstalledPackagesByType($type) |
|
| 72 | + { |
|
| 73 | + $packagesByType = array(); |
|
| 74 | + |
|
| 75 | + foreach (self::getInstalled() as $installed) { |
|
| 76 | + foreach ($installed['versions'] as $name => $package) { |
|
| 77 | + if (isset($package['type']) && $package['type'] === $type) { |
|
| 78 | + $packagesByType[] = $name; |
|
| 79 | + } |
|
| 80 | + } |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + return $packagesByType; |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * Checks whether the given package is installed |
|
| 88 | + * |
|
| 89 | + * This also returns true if the package name is provided or replaced by another package |
|
| 90 | + * |
|
| 91 | + * @param string $packageName |
|
| 92 | + * @param bool $includeDevRequirements |
|
| 93 | + * @return bool |
|
| 94 | + */ |
|
| 95 | + public static function isInstalled($packageName, $includeDevRequirements = true) |
|
| 96 | + { |
|
| 97 | + foreach (self::getInstalled() as $installed) { |
|
| 98 | + if (isset($installed['versions'][$packageName])) { |
|
| 99 | + return $includeDevRequirements || empty($installed['versions'][$packageName]['dev_requirement']); |
|
| 100 | + } |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + return false; |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Checks whether the given package satisfies a version constraint |
|
| 108 | + * |
|
| 109 | + * e.g. If you want to know whether version 2.3+ of package foo/bar is installed, you would call: |
|
| 110 | + * |
|
| 111 | + * Composer\InstalledVersions::satisfies(new VersionParser, 'foo/bar', '^2.3') |
|
| 112 | + * |
|
| 113 | + * @param VersionParser $parser Install composer/semver to have access to this class and functionality |
|
| 114 | + * @param string $packageName |
|
| 115 | + * @param string|null $constraint A version constraint to check for, if you pass one you have to make sure composer/semver is required by your package |
|
| 116 | + * @return bool |
|
| 117 | + */ |
|
| 118 | + public static function satisfies(VersionParser $parser, $packageName, $constraint) |
|
| 119 | + { |
|
| 120 | + $constraint = $parser->parseConstraints($constraint); |
|
| 121 | + $provided = $parser->parseConstraints(self::getVersionRanges($packageName)); |
|
| 122 | + |
|
| 123 | + return $provided->matches($constraint); |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * Returns a version constraint representing all the range(s) which are installed for a given package |
|
| 128 | + * |
|
| 129 | + * It is easier to use this via isInstalled() with the $constraint argument if you need to check |
|
| 130 | + * whether a given version of a package is installed, and not just whether it exists |
|
| 131 | + * |
|
| 132 | + * @param string $packageName |
|
| 133 | + * @return string Version constraint usable with composer/semver |
|
| 134 | + */ |
|
| 135 | + public static function getVersionRanges($packageName) |
|
| 136 | + { |
|
| 137 | + foreach (self::getInstalled() as $installed) { |
|
| 138 | + if (!isset($installed['versions'][$packageName])) { |
|
| 139 | + continue; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + $ranges = array(); |
|
| 143 | + if (isset($installed['versions'][$packageName]['pretty_version'])) { |
|
| 144 | + $ranges[] = $installed['versions'][$packageName]['pretty_version']; |
|
| 145 | + } |
|
| 146 | + if (array_key_exists('aliases', $installed['versions'][$packageName])) { |
|
| 147 | + $ranges = array_merge($ranges, $installed['versions'][$packageName]['aliases']); |
|
| 148 | + } |
|
| 149 | + if (array_key_exists('replaced', $installed['versions'][$packageName])) { |
|
| 150 | + $ranges = array_merge($ranges, $installed['versions'][$packageName]['replaced']); |
|
| 151 | + } |
|
| 152 | + if (array_key_exists('provided', $installed['versions'][$packageName])) { |
|
| 153 | + $ranges = array_merge($ranges, $installed['versions'][$packageName]['provided']); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + return implode(' || ', $ranges); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * @param string $packageName |
|
| 164 | + * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present |
|
| 165 | + */ |
|
| 166 | + public static function getVersion($packageName) |
|
| 167 | + { |
|
| 168 | + foreach (self::getInstalled() as $installed) { |
|
| 169 | + if (!isset($installed['versions'][$packageName])) { |
|
| 170 | + continue; |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + if (!isset($installed['versions'][$packageName]['version'])) { |
|
| 174 | + return null; |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + return $installed['versions'][$packageName]['version']; |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + /** |
|
| 184 | + * @param string $packageName |
|
| 185 | + * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present |
|
| 186 | + */ |
|
| 187 | + public static function getPrettyVersion($packageName) |
|
| 188 | + { |
|
| 189 | + foreach (self::getInstalled() as $installed) { |
|
| 190 | + if (!isset($installed['versions'][$packageName])) { |
|
| 191 | + continue; |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + if (!isset($installed['versions'][$packageName]['pretty_version'])) { |
|
| 195 | + return null; |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + return $installed['versions'][$packageName]['pretty_version']; |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * @param string $packageName |
|
| 206 | + * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as reference |
|
| 207 | + */ |
|
| 208 | + public static function getReference($packageName) |
|
| 209 | + { |
|
| 210 | + foreach (self::getInstalled() as $installed) { |
|
| 211 | + if (!isset($installed['versions'][$packageName])) { |
|
| 212 | + continue; |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + if (!isset($installed['versions'][$packageName]['reference'])) { |
|
| 216 | + return null; |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + return $installed['versions'][$packageName]['reference']; |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * @param string $packageName |
|
| 227 | + * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as install path. Packages of type metapackages also have a null install path. |
|
| 228 | + */ |
|
| 229 | + public static function getInstallPath($packageName) |
|
| 230 | + { |
|
| 231 | + foreach (self::getInstalled() as $installed) { |
|
| 232 | + if (!isset($installed['versions'][$packageName])) { |
|
| 233 | + continue; |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + return isset($installed['versions'][$packageName]['install_path']) ? $installed['versions'][$packageName]['install_path'] : null; |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); |
|
| 240 | + } |
|
| 241 | + |
|
| 242 | + /** |
|
| 243 | + * @return array |
|
| 244 | + * @psalm-return array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string} |
|
| 245 | + */ |
|
| 246 | + public static function getRootPackage() |
|
| 247 | + { |
|
| 248 | + $installed = self::getInstalled(); |
|
| 249 | + |
|
| 250 | + return $installed[0]['root']; |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + /** |
|
| 254 | + * Returns the raw installed.php data for custom implementations |
|
| 255 | + * |
|
| 256 | + * @deprecated Use getAllRawData() instead which returns all datasets for all autoloaders present in the process. getRawData only returns the first dataset loaded, which may not be what you expect. |
|
| 257 | + * @return array[] |
|
| 258 | + * @psalm-return array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>} |
|
| 259 | + */ |
|
| 260 | + public static function getRawData() |
|
| 261 | + { |
|
| 262 | + @trigger_error('getRawData only returns the first dataset loaded, which may not be what you expect. Use getAllRawData() instead which returns all datasets for all autoloaders present in the process.', E_USER_DEPRECATED); |
|
| 263 | + |
|
| 264 | + if (null === self::$installed) { |
|
| 265 | + // only require the installed.php file if this file is loaded from its dumped location, |
|
| 266 | + // and not from its source location in the composer/composer package, see https://github.com/composer/composer/issues/9937 |
|
| 267 | + if (substr(__DIR__, -8, 1) !== 'C') { |
|
| 268 | + self::$installed = include __DIR__ . '/installed.php'; |
|
| 269 | + } else { |
|
| 270 | + self::$installed = array(); |
|
| 271 | + } |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + return self::$installed; |
|
| 275 | + } |
|
| 276 | + |
|
| 277 | + /** |
|
| 278 | + * Returns the raw data of all installed.php which are currently loaded for custom implementations |
|
| 279 | + * |
|
| 280 | + * @return array[] |
|
| 281 | + * @psalm-return list<array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>}> |
|
| 282 | + */ |
|
| 283 | + public static function getAllRawData() |
|
| 284 | + { |
|
| 285 | + return self::getInstalled(); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Lets you reload the static array from another file |
|
| 290 | + * |
|
| 291 | + * This is only useful for complex integrations in which a project needs to use |
|
| 292 | + * this class but then also needs to execute another project's autoloader in process, |
|
| 293 | + * and wants to ensure both projects have access to their version of installed.php. |
|
| 294 | + * |
|
| 295 | + * A typical case would be PHPUnit, where it would need to make sure it reads all |
|
| 296 | + * the data it needs from this class, then call reload() with |
|
| 297 | + * `require $CWD/vendor/composer/installed.php` (or similar) as input to make sure |
|
| 298 | + * the project in which it runs can then also use this class safely, without |
|
| 299 | + * interference between PHPUnit's dependencies and the project's dependencies. |
|
| 300 | + * |
|
| 301 | + * @param array[] $data A vendor/composer/installed.php data set |
|
| 302 | + * @return void |
|
| 303 | + * |
|
| 304 | + * @psalm-param array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>} $data |
|
| 305 | + */ |
|
| 306 | + public static function reload($data) |
|
| 307 | + { |
|
| 308 | + self::$installed = $data; |
|
| 309 | + self::$installedByVendor = array(); |
|
| 310 | + } |
|
| 311 | + |
|
| 312 | + /** |
|
| 313 | + * @return array[] |
|
| 314 | + * @psalm-return list<array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[], dev: bool, install_path: string, type: string}, versions: array<string, array{dev_requirement: bool, pretty_version?: string, version?: string, aliases?: string[], reference?: string, replaced?: string[], provided?: string[], install_path?: string, type?: string}>}> |
|
| 315 | + */ |
|
| 316 | + private static function getInstalled() |
|
| 317 | + { |
|
| 318 | + if (null === self::$canGetVendors) { |
|
| 319 | + self::$canGetVendors = method_exists('Composer\Autoload\ClassLoader', 'getRegisteredLoaders'); |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + $installed = array(); |
|
| 323 | + |
|
| 324 | + if (self::$canGetVendors) { |
|
| 325 | + foreach (ClassLoader::getRegisteredLoaders() as $vendorDir => $loader) { |
|
| 326 | + if (isset(self::$installedByVendor[$vendorDir])) { |
|
| 327 | + $installed[] = self::$installedByVendor[$vendorDir]; |
|
| 328 | + } elseif (is_file($vendorDir.'/composer/installed.php')) { |
|
| 329 | + $installed[] = self::$installedByVendor[$vendorDir] = require $vendorDir.'/composer/installed.php'; |
|
| 330 | + if (null === self::$installed && strtr($vendorDir.'/composer', '\\', '/') === strtr(__DIR__, '\\', '/')) { |
|
| 331 | + self::$installed = $installed[count($installed) - 1]; |
|
| 332 | + } |
|
| 333 | + } |
|
| 334 | + } |
|
| 335 | + } |
|
| 336 | + |
|
| 337 | + if (null === self::$installed) { |
|
| 338 | + // only require the installed.php file if this file is loaded from its dumped location, |
|
| 339 | + // and not from its source location in the composer/composer package, see https://github.com/composer/composer/issues/9937 |
|
| 340 | + if (substr(__DIR__, -8, 1) !== 'C') { |
|
| 341 | + self::$installed = require __DIR__ . '/installed.php'; |
|
| 342 | + } else { |
|
| 343 | + self::$installed = array(); |
|
| 344 | + } |
|
| 345 | + } |
|
| 346 | + $installed[] = self::$installed; |
|
| 347 | + |
|
| 348 | + return $installed; |
|
| 349 | + } |
|
| 350 | 350 | } |