annotate vendor/composer/ClassLoader.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents c2387f117808
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of Composer.
Chris@0 5 *
Chris@0 6 * (c) Nils Adermann <naderman@naderman.de>
Chris@0 7 * Jordi Boggiano <j.boggiano@seld.be>
Chris@0 8 *
Chris@0 9 * For the full copyright and license information, please view the LICENSE
Chris@0 10 * file that was distributed with this source code.
Chris@0 11 */
Chris@0 12
Chris@0 13 namespace Composer\Autoload;
Chris@0 14
Chris@0 15 /**
Chris@0 16 * ClassLoader implements a PSR-0, PSR-4 and classmap class loader.
Chris@0 17 *
Chris@0 18 * $loader = new \Composer\Autoload\ClassLoader();
Chris@0 19 *
Chris@0 20 * // register classes with namespaces
Chris@0 21 * $loader->add('Symfony\Component', __DIR__.'/component');
Chris@0 22 * $loader->add('Symfony', __DIR__.'/framework');
Chris@0 23 *
Chris@0 24 * // activate the autoloader
Chris@0 25 * $loader->register();
Chris@0 26 *
Chris@0 27 * // to enable searching the include path (eg. for PEAR packages)
Chris@0 28 * $loader->setUseIncludePath(true);
Chris@0 29 *
Chris@0 30 * In this example, if you try to use a class in the Symfony\Component
Chris@0 31 * namespace or one of its children (Symfony\Component\Console for instance),
Chris@0 32 * the autoloader will first look for the class under the component/
Chris@0 33 * directory, and it will then fallback to the framework/ directory if not
Chris@0 34 * found before giving up.
Chris@0 35 *
Chris@0 36 * This class is loosely based on the Symfony UniversalClassLoader.
Chris@0 37 *
Chris@0 38 * @author Fabien Potencier <fabien@symfony.com>
Chris@0 39 * @author Jordi Boggiano <j.boggiano@seld.be>
Chris@0 40 * @see http://www.php-fig.org/psr/psr-0/
Chris@0 41 * @see http://www.php-fig.org/psr/psr-4/
Chris@0 42 */
Chris@0 43 class ClassLoader
Chris@0 44 {
Chris@0 45 // PSR-4
Chris@0 46 private $prefixLengthsPsr4 = array();
Chris@0 47 private $prefixDirsPsr4 = array();
Chris@0 48 private $fallbackDirsPsr4 = array();
Chris@0 49
Chris@0 50 // PSR-0
Chris@0 51 private $prefixesPsr0 = array();
Chris@0 52 private $fallbackDirsPsr0 = array();
Chris@0 53
Chris@0 54 private $useIncludePath = false;
Chris@0 55 private $classMap = array();
Chris@0 56 private $classMapAuthoritative = false;
Chris@0 57 private $missingClasses = array();
Chris@0 58 private $apcuPrefix;
Chris@0 59
Chris@0 60 public function getPrefixes()
Chris@0 61 {
Chris@0 62 if (!empty($this->prefixesPsr0)) {
Chris@0 63 return call_user_func_array('array_merge', $this->prefixesPsr0);
Chris@0 64 }
Chris@0 65
Chris@0 66 return array();
Chris@0 67 }
Chris@0 68
Chris@0 69 public function getPrefixesPsr4()
Chris@0 70 {
Chris@0 71 return $this->prefixDirsPsr4;
Chris@0 72 }
Chris@0 73
Chris@0 74 public function getFallbackDirs()
Chris@0 75 {
Chris@0 76 return $this->fallbackDirsPsr0;
Chris@0 77 }
Chris@0 78
Chris@0 79 public function getFallbackDirsPsr4()
Chris@0 80 {
Chris@0 81 return $this->fallbackDirsPsr4;
Chris@0 82 }
Chris@0 83
Chris@0 84 public function getClassMap()
Chris@0 85 {
Chris@0 86 return $this->classMap;
Chris@0 87 }
Chris@0 88
Chris@0 89 /**
Chris@0 90 * @param array $classMap Class to filename map
Chris@0 91 */
Chris@0 92 public function addClassMap(array $classMap)
Chris@0 93 {
Chris@0 94 if ($this->classMap) {
Chris@0 95 $this->classMap = array_merge($this->classMap, $classMap);
Chris@0 96 } else {
Chris@0 97 $this->classMap = $classMap;
Chris@0 98 }
Chris@0 99 }
Chris@0 100
Chris@0 101 /**
Chris@0 102 * Registers a set of PSR-0 directories for a given prefix, either
Chris@0 103 * appending or prepending to the ones previously set for this prefix.
Chris@0 104 *
Chris@0 105 * @param string $prefix The prefix
Chris@0 106 * @param array|string $paths The PSR-0 root directories
Chris@0 107 * @param bool $prepend Whether to prepend the directories
Chris@0 108 */
Chris@0 109 public function add($prefix, $paths, $prepend = false)
Chris@0 110 {
Chris@0 111 if (!$prefix) {
Chris@0 112 if ($prepend) {
Chris@0 113 $this->fallbackDirsPsr0 = array_merge(
Chris@0 114 (array) $paths,
Chris@0 115 $this->fallbackDirsPsr0
Chris@0 116 );
Chris@0 117 } else {
Chris@0 118 $this->fallbackDirsPsr0 = array_merge(
Chris@0 119 $this->fallbackDirsPsr0,
Chris@0 120 (array) $paths
Chris@0 121 );
Chris@0 122 }
Chris@0 123
Chris@0 124 return;
Chris@0 125 }
Chris@0 126
Chris@0 127 $first = $prefix[0];
Chris@0 128 if (!isset($this->prefixesPsr0[$first][$prefix])) {
Chris@0 129 $this->prefixesPsr0[$first][$prefix] = (array) $paths;
Chris@0 130
Chris@0 131 return;
Chris@0 132 }
Chris@0 133 if ($prepend) {
Chris@0 134 $this->prefixesPsr0[$first][$prefix] = array_merge(
Chris@0 135 (array) $paths,
Chris@0 136 $this->prefixesPsr0[$first][$prefix]
Chris@0 137 );
Chris@0 138 } else {
Chris@0 139 $this->prefixesPsr0[$first][$prefix] = array_merge(
Chris@0 140 $this->prefixesPsr0[$first][$prefix],
Chris@0 141 (array) $paths
Chris@0 142 );
Chris@0 143 }
Chris@0 144 }
Chris@0 145
Chris@0 146 /**
Chris@0 147 * Registers a set of PSR-4 directories for a given namespace, either
Chris@0 148 * appending or prepending to the ones previously set for this namespace.
Chris@0 149 *
Chris@0 150 * @param string $prefix The prefix/namespace, with trailing '\\'
Chris@0 151 * @param array|string $paths The PSR-4 base directories
Chris@0 152 * @param bool $prepend Whether to prepend the directories
Chris@0 153 *
Chris@0 154 * @throws \InvalidArgumentException
Chris@0 155 */
Chris@0 156 public function addPsr4($prefix, $paths, $prepend = false)
Chris@0 157 {
Chris@0 158 if (!$prefix) {
Chris@0 159 // Register directories for the root namespace.
Chris@0 160 if ($prepend) {
Chris@0 161 $this->fallbackDirsPsr4 = array_merge(
Chris@0 162 (array) $paths,
Chris@0 163 $this->fallbackDirsPsr4
Chris@0 164 );
Chris@0 165 } else {
Chris@0 166 $this->fallbackDirsPsr4 = array_merge(
Chris@0 167 $this->fallbackDirsPsr4,
Chris@0 168 (array) $paths
Chris@0 169 );
Chris@0 170 }
Chris@0 171 } elseif (!isset($this->prefixDirsPsr4[$prefix])) {
Chris@0 172 // Register directories for a new namespace.
Chris@0 173 $length = strlen($prefix);
Chris@0 174 if ('\\' !== $prefix[$length - 1]) {
Chris@0 175 throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
Chris@0 176 }
Chris@0 177 $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
Chris@0 178 $this->prefixDirsPsr4[$prefix] = (array) $paths;
Chris@0 179 } elseif ($prepend) {
Chris@0 180 // Prepend directories for an already registered namespace.
Chris@0 181 $this->prefixDirsPsr4[$prefix] = array_merge(
Chris@0 182 (array) $paths,
Chris@0 183 $this->prefixDirsPsr4[$prefix]
Chris@0 184 );
Chris@0 185 } else {
Chris@0 186 // Append directories for an already registered namespace.
Chris@0 187 $this->prefixDirsPsr4[$prefix] = array_merge(
Chris@0 188 $this->prefixDirsPsr4[$prefix],
Chris@0 189 (array) $paths
Chris@0 190 );
Chris@0 191 }
Chris@0 192 }
Chris@0 193
Chris@0 194 /**
Chris@0 195 * Registers a set of PSR-0 directories for a given prefix,
Chris@0 196 * replacing any others previously set for this prefix.
Chris@0 197 *
Chris@0 198 * @param string $prefix The prefix
Chris@0 199 * @param array|string $paths The PSR-0 base directories
Chris@0 200 */
Chris@0 201 public function set($prefix, $paths)
Chris@0 202 {
Chris@0 203 if (!$prefix) {
Chris@0 204 $this->fallbackDirsPsr0 = (array) $paths;
Chris@0 205 } else {
Chris@0 206 $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
Chris@0 207 }
Chris@0 208 }
Chris@0 209
Chris@0 210 /**
Chris@0 211 * Registers a set of PSR-4 directories for a given namespace,
Chris@0 212 * replacing any others previously set for this namespace.
Chris@0 213 *
Chris@0 214 * @param string $prefix The prefix/namespace, with trailing '\\'
Chris@0 215 * @param array|string $paths The PSR-4 base directories
Chris@0 216 *
Chris@0 217 * @throws \InvalidArgumentException
Chris@0 218 */
Chris@0 219 public function setPsr4($prefix, $paths)
Chris@0 220 {
Chris@0 221 if (!$prefix) {
Chris@0 222 $this->fallbackDirsPsr4 = (array) $paths;
Chris@0 223 } else {
Chris@0 224 $length = strlen($prefix);
Chris@0 225 if ('\\' !== $prefix[$length - 1]) {
Chris@0 226 throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
Chris@0 227 }
Chris@0 228 $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
Chris@0 229 $this->prefixDirsPsr4[$prefix] = (array) $paths;
Chris@0 230 }
Chris@0 231 }
Chris@0 232
Chris@0 233 /**
Chris@0 234 * Turns on searching the include path for class files.
Chris@0 235 *
Chris@0 236 * @param bool $useIncludePath
Chris@0 237 */
Chris@0 238 public function setUseIncludePath($useIncludePath)
Chris@0 239 {
Chris@0 240 $this->useIncludePath = $useIncludePath;
Chris@0 241 }
Chris@0 242
Chris@0 243 /**
Chris@0 244 * Can be used to check if the autoloader uses the include path to check
Chris@0 245 * for classes.
Chris@0 246 *
Chris@0 247 * @return bool
Chris@0 248 */
Chris@0 249 public function getUseIncludePath()
Chris@0 250 {
Chris@0 251 return $this->useIncludePath;
Chris@0 252 }
Chris@0 253
Chris@0 254 /**
Chris@0 255 * Turns off searching the prefix and fallback directories for classes
Chris@0 256 * that have not been registered with the class map.
Chris@0 257 *
Chris@0 258 * @param bool $classMapAuthoritative
Chris@0 259 */
Chris@0 260 public function setClassMapAuthoritative($classMapAuthoritative)
Chris@0 261 {
Chris@0 262 $this->classMapAuthoritative = $classMapAuthoritative;
Chris@0 263 }
Chris@0 264
Chris@0 265 /**
Chris@0 266 * Should class lookup fail if not found in the current class map?
Chris@0 267 *
Chris@0 268 * @return bool
Chris@0 269 */
Chris@0 270 public function isClassMapAuthoritative()
Chris@0 271 {
Chris@0 272 return $this->classMapAuthoritative;
Chris@0 273 }
Chris@0 274
Chris@0 275 /**
Chris@0 276 * APCu prefix to use to cache found/not-found classes, if the extension is enabled.
Chris@0 277 *
Chris@0 278 * @param string|null $apcuPrefix
Chris@0 279 */
Chris@0 280 public function setApcuPrefix($apcuPrefix)
Chris@0 281 {
Chris@0 282 $this->apcuPrefix = function_exists('apcu_fetch') && ini_get('apc.enabled') ? $apcuPrefix : null;
Chris@0 283 }
Chris@0 284
Chris@0 285 /**
Chris@0 286 * The APCu prefix in use, or null if APCu caching is not enabled.
Chris@0 287 *
Chris@0 288 * @return string|null
Chris@0 289 */
Chris@0 290 public function getApcuPrefix()
Chris@0 291 {
Chris@0 292 return $this->apcuPrefix;
Chris@0 293 }
Chris@0 294
Chris@0 295 /**
Chris@0 296 * Registers this instance as an autoloader.
Chris@0 297 *
Chris@0 298 * @param bool $prepend Whether to prepend the autoloader or not
Chris@0 299 */
Chris@0 300 public function register($prepend = false)
Chris@0 301 {
Chris@0 302 spl_autoload_register(array($this, 'loadClass'), true, $prepend);
Chris@0 303 }
Chris@0 304
Chris@0 305 /**
Chris@0 306 * Unregisters this instance as an autoloader.
Chris@0 307 */
Chris@0 308 public function unregister()
Chris@0 309 {
Chris@0 310 spl_autoload_unregister(array($this, 'loadClass'));
Chris@0 311 }
Chris@0 312
Chris@0 313 /**
Chris@0 314 * Loads the given class or interface.
Chris@0 315 *
Chris@0 316 * @param string $class The name of the class
Chris@0 317 * @return bool|null True if loaded, null otherwise
Chris@0 318 */
Chris@0 319 public function loadClass($class)
Chris@0 320 {
Chris@0 321 if ($file = $this->findFile($class)) {
Chris@0 322 includeFile($file);
Chris@0 323
Chris@0 324 return true;
Chris@0 325 }
Chris@0 326 }
Chris@0 327
Chris@0 328 /**
Chris@0 329 * Finds the path to the file where the class is defined.
Chris@0 330 *
Chris@0 331 * @param string $class The name of the class
Chris@0 332 *
Chris@0 333 * @return string|false The path if found, false otherwise
Chris@0 334 */
Chris@0 335 public function findFile($class)
Chris@0 336 {
Chris@0 337 // class map lookup
Chris@0 338 if (isset($this->classMap[$class])) {
Chris@0 339 return $this->classMap[$class];
Chris@0 340 }
Chris@0 341 if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) {
Chris@0 342 return false;
Chris@0 343 }
Chris@0 344 if (null !== $this->apcuPrefix) {
Chris@0 345 $file = apcu_fetch($this->apcuPrefix.$class, $hit);
Chris@0 346 if ($hit) {
Chris@0 347 return $file;
Chris@0 348 }
Chris@0 349 }
Chris@0 350
Chris@0 351 $file = $this->findFileWithExtension($class, '.php');
Chris@0 352
Chris@0 353 // Search for Hack files if we are running on HHVM
Chris@0 354 if (false === $file && defined('HHVM_VERSION')) {
Chris@0 355 $file = $this->findFileWithExtension($class, '.hh');
Chris@0 356 }
Chris@0 357
Chris@0 358 if (null !== $this->apcuPrefix) {
Chris@0 359 apcu_add($this->apcuPrefix.$class, $file);
Chris@0 360 }
Chris@0 361
Chris@0 362 if (false === $file) {
Chris@0 363 // Remember that this class does not exist.
Chris@0 364 $this->missingClasses[$class] = true;
Chris@0 365 }
Chris@0 366
Chris@0 367 return $file;
Chris@0 368 }
Chris@0 369
Chris@0 370 private function findFileWithExtension($class, $ext)
Chris@0 371 {
Chris@0 372 // PSR-4 lookup
Chris@0 373 $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext;
Chris@0 374
Chris@0 375 $first = $class[0];
Chris@0 376 if (isset($this->prefixLengthsPsr4[$first])) {
Chris@0 377 $subPath = $class;
Chris@0 378 while (false !== $lastPos = strrpos($subPath, '\\')) {
Chris@0 379 $subPath = substr($subPath, 0, $lastPos);
Chris@0 380 $search = $subPath.'\\';
Chris@0 381 if (isset($this->prefixDirsPsr4[$search])) {
Chris@16 382 $pathEnd = DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $lastPos + 1);
Chris@0 383 foreach ($this->prefixDirsPsr4[$search] as $dir) {
Chris@16 384 if (file_exists($file = $dir . $pathEnd)) {
Chris@0 385 return $file;
Chris@0 386 }
Chris@0 387 }
Chris@0 388 }
Chris@0 389 }
Chris@0 390 }
Chris@0 391
Chris@0 392 // PSR-4 fallback dirs
Chris@0 393 foreach ($this->fallbackDirsPsr4 as $dir) {
Chris@0 394 if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
Chris@0 395 return $file;
Chris@0 396 }
Chris@0 397 }
Chris@0 398
Chris@0 399 // PSR-0 lookup
Chris@0 400 if (false !== $pos = strrpos($class, '\\')) {
Chris@0 401 // namespaced class name
Chris@0 402 $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
Chris@0 403 . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
Chris@0 404 } else {
Chris@0 405 // PEAR-like class name
Chris@0 406 $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext;
Chris@0 407 }
Chris@0 408
Chris@0 409 if (isset($this->prefixesPsr0[$first])) {
Chris@0 410 foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
Chris@0 411 if (0 === strpos($class, $prefix)) {
Chris@0 412 foreach ($dirs as $dir) {
Chris@0 413 if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
Chris@0 414 return $file;
Chris@0 415 }
Chris@0 416 }
Chris@0 417 }
Chris@0 418 }
Chris@0 419 }
Chris@0 420
Chris@0 421 // PSR-0 fallback dirs
Chris@0 422 foreach ($this->fallbackDirsPsr0 as $dir) {
Chris@0 423 if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
Chris@0 424 return $file;
Chris@0 425 }
Chris@0 426 }
Chris@0 427
Chris@0 428 // PSR-0 include paths.
Chris@0 429 if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
Chris@0 430 return $file;
Chris@0 431 }
Chris@0 432
Chris@0 433 return false;
Chris@0 434 }
Chris@0 435 }
Chris@0 436
Chris@0 437 /**
Chris@0 438 * Scope isolated include.
Chris@0 439 *
Chris@0 440 * Prevents access to $this/self from included files.
Chris@0 441 */
Chris@0 442 function includeFile($file)
Chris@0 443 {
Chris@0 444 include $file;
Chris@0 445 }