-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
618 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,57 +37,134 @@ | |
* | ||
* @author Fabien Potencier <[email protected]> | ||
* @author Jordi Boggiano <[email protected]> | ||
* @see http://www.php-fig.org/psr/psr-0/ | ||
* @see http://www.php-fig.org/psr/psr-4/ | ||
* @see https://www.php-fig.org/psr/psr-0/ | ||
* @see https://www.php-fig.org/psr/psr-4/ | ||
*/ | ||
class ClassLoader | ||
{ | ||
/** @var \Closure(string):void */ | ||
private static $includeFile; | ||
|
||
/** @var ?string */ | ||
private $vendorDir; | ||
|
||
// PSR-4 | ||
/** | ||
* @var array[] | ||
* @psalm-var array<string, array<string, int>> | ||
*/ | ||
private $prefixLengthsPsr4 = array(); | ||
/** | ||
* @var array[] | ||
* @psalm-var array<string, array<int, string>> | ||
*/ | ||
private $prefixDirsPsr4 = array(); | ||
/** | ||
* @var array[] | ||
* @psalm-var array<string, string> | ||
*/ | ||
private $fallbackDirsPsr4 = array(); | ||
|
||
// PSR-0 | ||
/** | ||
* @var array[] | ||
* @psalm-var array<string, array<string, string[]>> | ||
*/ | ||
private $prefixesPsr0 = array(); | ||
/** | ||
* @var array[] | ||
* @psalm-var array<string, string> | ||
*/ | ||
private $fallbackDirsPsr0 = array(); | ||
|
||
/** @var bool */ | ||
private $useIncludePath = false; | ||
|
||
/** | ||
* @var string[] | ||
* @psalm-var array<string, string> | ||
*/ | ||
private $classMap = array(); | ||
|
||
/** @var bool */ | ||
private $classMapAuthoritative = false; | ||
|
||
/** | ||
* @var bool[] | ||
* @psalm-var array<string, bool> | ||
*/ | ||
private $missingClasses = array(); | ||
|
||
/** @var ?string */ | ||
private $apcuPrefix; | ||
|
||
/** | ||
* @var self[] | ||
*/ | ||
private static $registeredLoaders = array(); | ||
|
||
/** | ||
* @param ?string $vendorDir | ||
*/ | ||
public function __construct($vendorDir = null) | ||
{ | ||
$this->vendorDir = $vendorDir; | ||
self::initializeIncludeClosure(); | ||
} | ||
|
||
/** | ||
* @return string[] | ||
*/ | ||
public function getPrefixes() | ||
{ | ||
if (!empty($this->prefixesPsr0)) { | ||
return call_user_func_array('array_merge', $this->prefixesPsr0); | ||
return call_user_func_array('array_merge', array_values($this->prefixesPsr0)); | ||
} | ||
|
||
return array(); | ||
} | ||
|
||
/** | ||
* @return array[] | ||
* @psalm-return array<string, array<int, string>> | ||
*/ | ||
public function getPrefixesPsr4() | ||
{ | ||
return $this->prefixDirsPsr4; | ||
} | ||
|
||
/** | ||
* @return array[] | ||
* @psalm-return array<string, string> | ||
*/ | ||
public function getFallbackDirs() | ||
{ | ||
return $this->fallbackDirsPsr0; | ||
} | ||
|
||
/** | ||
* @return array[] | ||
* @psalm-return array<string, string> | ||
*/ | ||
public function getFallbackDirsPsr4() | ||
{ | ||
return $this->fallbackDirsPsr4; | ||
} | ||
|
||
/** | ||
* @return string[] Array of classname => path | ||
* @psalm-return array<string, string> | ||
*/ | ||
public function getClassMap() | ||
{ | ||
return $this->classMap; | ||
} | ||
|
||
/** | ||
* @param array $classMap Class to filename map | ||
* @param string[] $classMap Class to filename map | ||
* @psalm-param array<string, string> $classMap | ||
* | ||
* @return void | ||
*/ | ||
public function addClassMap(array $classMap) | ||
{ | ||
|
@@ -102,9 +179,11 @@ public function addClassMap(array $classMap) | |
* Registers a set of PSR-0 directories for a given prefix, either | ||
* appending or prepending to the ones previously set for this prefix. | ||
* | ||
* @param string $prefix The prefix | ||
* @param array|string $paths The PSR-0 root directories | ||
* @param bool $prepend Whether to prepend the directories | ||
* @param string $prefix The prefix | ||
* @param string[]|string $paths The PSR-0 root directories | ||
* @param bool $prepend Whether to prepend the directories | ||
* | ||
* @return void | ||
*/ | ||
public function add($prefix, $paths, $prepend = false) | ||
{ | ||
|
@@ -147,11 +226,13 @@ public function add($prefix, $paths, $prepend = false) | |
* Registers a set of PSR-4 directories for a given namespace, either | ||
* appending or prepending to the ones previously set for this namespace. | ||
* | ||
* @param string $prefix The prefix/namespace, with trailing '\\' | ||
* @param array|string $paths The PSR-4 base directories | ||
* @param bool $prepend Whether to prepend the directories | ||
* @param string $prefix The prefix/namespace, with trailing '\\' | ||
* @param string[]|string $paths The PSR-4 base directories | ||
* @param bool $prepend Whether to prepend the directories | ||
* | ||
* @throws \InvalidArgumentException | ||
* | ||
* @return void | ||
*/ | ||
public function addPsr4($prefix, $paths, $prepend = false) | ||
{ | ||
|
@@ -195,8 +276,10 @@ public function addPsr4($prefix, $paths, $prepend = false) | |
* Registers a set of PSR-0 directories for a given prefix, | ||
* replacing any others previously set for this prefix. | ||
* | ||
* @param string $prefix The prefix | ||
* @param array|string $paths The PSR-0 base directories | ||
* @param string $prefix The prefix | ||
* @param string[]|string $paths The PSR-0 base directories | ||
* | ||
* @return void | ||
*/ | ||
public function set($prefix, $paths) | ||
{ | ||
|
@@ -211,10 +294,12 @@ public function set($prefix, $paths) | |
* Registers a set of PSR-4 directories for a given namespace, | ||
* replacing any others previously set for this namespace. | ||
* | ||
* @param string $prefix The prefix/namespace, with trailing '\\' | ||
* @param array|string $paths The PSR-4 base directories | ||
* @param string $prefix The prefix/namespace, with trailing '\\' | ||
* @param string[]|string $paths The PSR-4 base directories | ||
* | ||
* @throws \InvalidArgumentException | ||
* | ||
* @return void | ||
*/ | ||
public function setPsr4($prefix, $paths) | ||
{ | ||
|
@@ -234,6 +319,8 @@ public function setPsr4($prefix, $paths) | |
* Turns on searching the include path for class files. | ||
* | ||
* @param bool $useIncludePath | ||
* | ||
* @return void | ||
*/ | ||
public function setUseIncludePath($useIncludePath) | ||
{ | ||
|
@@ -256,6 +343,8 @@ public function getUseIncludePath() | |
* that have not been registered with the class map. | ||
* | ||
* @param bool $classMapAuthoritative | ||
* | ||
* @return void | ||
*/ | ||
public function setClassMapAuthoritative($classMapAuthoritative) | ||
{ | ||
|
@@ -276,6 +365,8 @@ public function isClassMapAuthoritative() | |
* APCu prefix to use to cache found/not-found classes, if the extension is enabled. | ||
* | ||
* @param string|null $apcuPrefix | ||
* | ||
* @return void | ||
*/ | ||
public function setApcuPrefix($apcuPrefix) | ||
{ | ||
|
@@ -296,33 +387,55 @@ public function getApcuPrefix() | |
* Registers this instance as an autoloader. | ||
* | ||
* @param bool $prepend Whether to prepend the autoloader or not | ||
* | ||
* @return void | ||
*/ | ||
public function register($prepend = false) | ||
{ | ||
spl_autoload_register(array($this, 'loadClass'), true, $prepend); | ||
|
||
if (null === $this->vendorDir) { | ||
return; | ||
} | ||
|
||
if ($prepend) { | ||
self::$registeredLoaders = array($this->vendorDir => $this) + self::$registeredLoaders; | ||
} else { | ||
unset(self::$registeredLoaders[$this->vendorDir]); | ||
self::$registeredLoaders[$this->vendorDir] = $this; | ||
} | ||
} | ||
|
||
/** | ||
* Unregisters this instance as an autoloader. | ||
* | ||
* @return void | ||
*/ | ||
public function unregister() | ||
{ | ||
spl_autoload_unregister(array($this, 'loadClass')); | ||
|
||
if (null !== $this->vendorDir) { | ||
unset(self::$registeredLoaders[$this->vendorDir]); | ||
} | ||
} | ||
|
||
/** | ||
* Loads the given class or interface. | ||
* | ||
* @param string $class The name of the class | ||
* @return bool|null True if loaded, null otherwise | ||
* @return true|null True if loaded, null otherwise | ||
*/ | ||
public function loadClass($class) | ||
{ | ||
if ($file = $this->findFile($class)) { | ||
includeFile($file); | ||
$includeFile = self::$includeFile; | ||
$includeFile($file); | ||
|
||
return true; | ||
} | ||
|
||
return null; | ||
} | ||
|
||
/** | ||
|
@@ -367,6 +480,21 @@ public function findFile($class) | |
return $file; | ||
} | ||
|
||
/** | ||
* Returns the currently registered loaders indexed by their corresponding vendor directories. | ||
* | ||
* @return self[] | ||
*/ | ||
public static function getRegisteredLoaders() | ||
{ | ||
return self::$registeredLoaders; | ||
} | ||
|
||
/** | ||
* @param string $class | ||
* @param string $ext | ||
* @return string|false | ||
*/ | ||
private function findFileWithExtension($class, $ext) | ||
{ | ||
// PSR-4 lookup | ||
|
@@ -432,14 +560,26 @@ private function findFileWithExtension($class, $ext) | |
|
||
return false; | ||
} | ||
} | ||
|
||
/** | ||
* Scope isolated include. | ||
* | ||
* Prevents access to $this/self from included files. | ||
*/ | ||
function includeFile($file) | ||
{ | ||
include $file; | ||
/** | ||
* @return void | ||
*/ | ||
private static function initializeIncludeClosure() | ||
{ | ||
if (self::$includeFile !== null) { | ||
return; | ||
} | ||
|
||
/** | ||
* Scope isolated include. | ||
* | ||
* Prevents access to $this/self from included files. | ||
* | ||
* @param string $file | ||
* @return void | ||
*/ | ||
self::$includeFile = \Closure::bind(static function($file) { | ||
include $file; | ||
}, null, null); | ||
} | ||
} |
Oops, something went wrong.