2010-02-17 13:54:36 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
2011-01-15 13:29:43 +00:00
|
|
|
* This file is part of the Symfony package.
|
2010-02-17 13:54:36 +00:00
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2010-02-17 13:54:36 +00:00
|
|
|
*
|
2011-01-15 13:29:43 +00:00
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
2010-02-17 13:54:36 +00:00
|
|
|
*/
|
|
|
|
|
2011-01-27 13:11:54 +00:00
|
|
|
namespace Symfony\Component\ClassLoader;
|
2011-01-15 13:29:43 +00:00
|
|
|
|
2010-02-17 13:54:36 +00:00
|
|
|
/**
|
2010-04-07 01:51:29 +01:00
|
|
|
* ClassCollectionLoader.
|
2010-02-17 13:54:36 +00:00
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
2010-02-17 13:54:36 +00:00
|
|
|
*/
|
|
|
|
class ClassCollectionLoader
|
|
|
|
{
|
2012-07-09 13:50:58 +01:00
|
|
|
private static $loaded;
|
|
|
|
private static $seen;
|
2012-10-27 16:55:46 +01:00
|
|
|
private static $useTokenizer = true;
|
2010-08-11 18:35:07 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
2010-08-18 12:43:32 +01:00
|
|
|
* Loads a list of classes and caches them in one big file.
|
|
|
|
*
|
|
|
|
* @param array $classes An array of classes to load
|
|
|
|
* @param string $cacheDir A cache directory
|
|
|
|
* @param string $name The cache name prefix
|
|
|
|
* @param Boolean $autoReload Whether to flush the cache when the cache is stale or not
|
|
|
|
* @param Boolean $adaptive Whether to remove already declared classes or not
|
2011-02-26 22:12:46 +00:00
|
|
|
* @param string $extension File extension of the resulting file
|
2010-08-18 12:43:32 +01:00
|
|
|
*
|
2010-05-06 12:25:53 +01:00
|
|
|
* @throws \InvalidArgumentException When class can't be loaded
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public static function load($classes, $cacheDir, $name, $autoReload, $adaptive = false, $extension = '.php')
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-08-11 18:35:07 +01:00
|
|
|
// each $name can only be loaded once per PHP process
|
|
|
|
if (isset(self::$loaded[$name])) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2010-08-20 12:12:06 +01:00
|
|
|
self::$loaded[$name] = true;
|
|
|
|
|
2012-07-03 16:40:35 +01:00
|
|
|
$declared = array_merge(get_declared_classes(), get_declared_interfaces());
|
|
|
|
if (function_exists('get_declared_traits')) {
|
|
|
|
$declared = array_merge($declared, get_declared_traits());
|
|
|
|
}
|
|
|
|
|
2011-01-29 16:58:40 +00:00
|
|
|
if ($adaptive) {
|
|
|
|
// don't include already declared classes
|
2012-07-03 16:40:35 +01:00
|
|
|
$classes = array_diff($classes, $declared);
|
2011-01-29 16:58:40 +00:00
|
|
|
|
|
|
|
// the cache is different depending on which classes are already declared
|
|
|
|
$name = $name.'-'.substr(md5(implode('|', $classes)), 0, 5);
|
|
|
|
}
|
|
|
|
|
2012-07-03 16:41:16 +01:00
|
|
|
$classes = array_unique($classes);
|
|
|
|
|
2011-02-26 22:12:46 +00:00
|
|
|
$cache = $cacheDir.'/'.$name.$extension;
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
// auto-reload
|
|
|
|
$reload = false;
|
2010-05-07 15:09:11 +01:00
|
|
|
if ($autoReload) {
|
2011-03-14 17:46:05 +00:00
|
|
|
$metadata = $cacheDir.'/'.$name.$extension.'.meta';
|
2011-08-29 14:28:03 +01:00
|
|
|
if (!is_file($metadata) || !is_file($cache)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$reload = true;
|
2010-05-07 15:09:11 +01:00
|
|
|
} else {
|
2010-05-06 12:25:53 +01:00
|
|
|
$time = filemtime($cache);
|
|
|
|
$meta = unserialize(file_get_contents($metadata));
|
|
|
|
|
2012-07-02 18:17:58 +01:00
|
|
|
sort($meta[1]);
|
|
|
|
sort($classes);
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if ($meta[1] != $classes) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$reload = true;
|
2010-05-07 15:09:11 +01:00
|
|
|
} else {
|
2010-05-08 14:32:30 +01:00
|
|
|
foreach ($meta[0] as $resource) {
|
2011-08-29 14:28:03 +01:00
|
|
|
if (!is_file($resource) || filemtime($resource) > $time) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$reload = true;
|
|
|
|
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-08-29 14:28:03 +01:00
|
|
|
if (!$reload && is_file($cache)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
require_once $cache;
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
return;
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
$files = array();
|
|
|
|
$content = '';
|
2012-07-03 16:41:16 +01:00
|
|
|
foreach (self::getOrderedClasses($classes) as $class) {
|
|
|
|
if (in_array($class->getName(), $declared)) {
|
|
|
|
continue;
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2012-07-03 16:41:16 +01:00
|
|
|
$files[] = $class->getFileName();
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2012-07-03 16:41:16 +01:00
|
|
|
$c = preg_replace(array('/^\s*<\?php/', '/\?>\s*$/'), '', file_get_contents($class->getFileName()));
|
2011-01-16 09:16:20 +00:00
|
|
|
|
2012-10-14 12:45:05 +01:00
|
|
|
// fakes namespace declaration for global code
|
2012-07-03 16:41:16 +01:00
|
|
|
if (!$class->inNamespace()) {
|
2012-10-27 16:06:24 +01:00
|
|
|
$c = "\nnamespace\n{\n".$c."\n}\n";
|
2011-01-16 09:16:20 +00:00
|
|
|
}
|
|
|
|
|
2012-10-14 12:45:05 +01:00
|
|
|
$c = self::fixNamespaceDeclarations('<?php '.$c);
|
|
|
|
$c = preg_replace('/^\s*<\?php/', '', $c);
|
|
|
|
|
2011-01-16 09:16:20 +00:00
|
|
|
$content .= $c;
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
// cache the core classes
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!is_dir(dirname($cache))) {
|
2010-05-06 12:25:53 +01:00
|
|
|
mkdir(dirname($cache), 0777, true);
|
|
|
|
}
|
2011-06-17 13:14:54 +01:00
|
|
|
self::writeCacheFile($cache, '<?php '.$content);
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if ($autoReload) {
|
2010-05-06 12:25:53 +01:00
|
|
|
// save the resources
|
|
|
|
self::writeCacheFile($metadata, serialize(array($files, $classes)));
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2011-01-16 09:16:20 +00:00
|
|
|
/**
|
|
|
|
* Adds brackets around each namespace if it's not already the case.
|
2011-02-06 21:31:19 +00:00
|
|
|
*
|
2011-02-06 22:27:05 +00:00
|
|
|
* @param string $source Namespace string
|
2011-02-06 21:31:19 +00:00
|
|
|
*
|
|
|
|
* @return string Namespaces with brackets
|
2011-01-16 09:16:20 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public static function fixNamespaceDeclarations($source)
|
2011-01-16 09:16:20 +00:00
|
|
|
{
|
2012-10-27 16:55:46 +01:00
|
|
|
if (!function_exists('token_get_all') || !self::$useTokenizer) {
|
|
|
|
if (preg_match('/namespace(.*?)\s*;/', $source)) {
|
2012-10-27 16:58:32 +01:00
|
|
|
$source = preg_replace('/namespace(.*?)\s*;/', "namespace$1\n{", $source)."}\n";
|
2012-10-27 16:55:46 +01:00
|
|
|
}
|
|
|
|
|
2011-01-16 09:16:20 +00:00
|
|
|
return $source;
|
|
|
|
}
|
|
|
|
|
|
|
|
$output = '';
|
|
|
|
$inNamespace = false;
|
|
|
|
$tokens = token_get_all($source);
|
|
|
|
|
2011-06-17 13:11:55 +01:00
|
|
|
for ($i = 0, $max = count($tokens); $i < $max; $i++) {
|
|
|
|
$token = $tokens[$i];
|
2011-01-16 09:16:20 +00:00
|
|
|
if (is_string($token)) {
|
|
|
|
$output .= $token;
|
2011-06-17 13:14:54 +01:00
|
|
|
} elseif (in_array($token[0], array(T_COMMENT, T_DOC_COMMENT))) {
|
|
|
|
// strip comments
|
|
|
|
continue;
|
2011-01-16 09:16:20 +00:00
|
|
|
} elseif (T_NAMESPACE === $token[0]) {
|
|
|
|
if ($inNamespace) {
|
|
|
|
$output .= "}\n";
|
|
|
|
}
|
|
|
|
$output .= $token[1];
|
|
|
|
|
|
|
|
// namespace name and whitespaces
|
2011-06-17 13:11:55 +01:00
|
|
|
while (($t = $tokens[++$i]) && is_array($t) && in_array($t[0], array(T_WHITESPACE, T_NS_SEPARATOR, T_STRING))) {
|
2011-01-16 09:16:20 +00:00
|
|
|
$output .= $t[1];
|
|
|
|
}
|
|
|
|
if (is_string($t) && '{' === $t) {
|
|
|
|
$inNamespace = false;
|
2011-06-17 13:11:55 +01:00
|
|
|
--$i;
|
2011-01-16 09:16:20 +00:00
|
|
|
} else {
|
2012-05-01 13:46:26 +01:00
|
|
|
$output = rtrim($output);
|
2011-01-16 09:16:20 +00:00
|
|
|
$output .= "\n{";
|
|
|
|
$inNamespace = true;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$output .= $token[1];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($inNamespace) {
|
|
|
|
$output .= "}\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
return $output;
|
|
|
|
}
|
|
|
|
|
2011-02-06 21:31:19 +00:00
|
|
|
/**
|
2011-02-06 23:58:54 +00:00
|
|
|
* Writes a cache file.
|
2011-02-06 21:31:19 +00:00
|
|
|
*
|
2012-04-23 06:37:21 +01:00
|
|
|
* @param string $file Filename
|
2011-02-06 22:27:05 +00:00
|
|
|
* @param string $content Temporary file content
|
2011-02-06 21:31:19 +00:00
|
|
|
*
|
|
|
|
* @throws \RuntimeException when a cache file cannot be written
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
private static function writeCacheFile($file, $content)
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$tmpFile = tempnam(dirname($file), basename($file));
|
2010-08-12 20:58:19 +01:00
|
|
|
if (false !== @file_put_contents($tmpFile, $content) && @rename($tmpFile, $file)) {
|
2012-05-15 07:43:47 +01:00
|
|
|
@chmod($file, 0666 & ~umask());
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-08-12 20:58:19 +01:00
|
|
|
return;
|
2010-06-23 06:35:46 +01:00
|
|
|
}
|
|
|
|
|
2010-08-12 20:58:19 +01:00
|
|
|
throw new \RuntimeException(sprintf('Failed to write cache file "%s".', $file));
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
2011-01-27 13:11:54 +00:00
|
|
|
|
2012-07-02 18:17:58 +01:00
|
|
|
/**
|
2012-07-03 16:41:16 +01:00
|
|
|
* Gets an ordered array of passed classes including all their dependencies.
|
2012-07-02 18:17:58 +01:00
|
|
|
*
|
|
|
|
* @param array $classes
|
|
|
|
*
|
2012-07-03 16:41:16 +01:00
|
|
|
* @return array An array of sorted \ReflectionClass instances (dependencies added if needed)
|
|
|
|
*
|
2012-07-02 18:17:58 +01:00
|
|
|
* @throws \InvalidArgumentException When a class can't be loaded
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
private static function getOrderedClasses(array $classes)
|
2012-07-02 18:17:58 +01:00
|
|
|
{
|
2012-07-03 16:41:16 +01:00
|
|
|
$map = array();
|
|
|
|
self::$seen = array();
|
2012-07-02 18:17:58 +01:00
|
|
|
foreach ($classes as $class) {
|
|
|
|
try {
|
|
|
|
$reflectionClass = new \ReflectionClass($class);
|
|
|
|
} catch (\ReflectionException $e) {
|
|
|
|
throw new \InvalidArgumentException(sprintf('Unable to load class "%s"', $class));
|
|
|
|
}
|
|
|
|
|
2012-07-03 16:41:16 +01:00
|
|
|
$map = array_merge($map, self::getClassHierarchy($reflectionClass));
|
|
|
|
}
|
|
|
|
|
|
|
|
return $map;
|
|
|
|
}
|
|
|
|
|
2012-07-09 13:50:58 +01:00
|
|
|
private static function getClassHierarchy(\ReflectionClass $class)
|
2012-07-03 16:41:16 +01:00
|
|
|
{
|
|
|
|
if (isset(self::$seen[$class->getName()])) {
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
self::$seen[$class->getName()] = true;
|
|
|
|
|
|
|
|
$classes = array($class);
|
|
|
|
$parent = $class;
|
|
|
|
while (($parent = $parent->getParentClass()) && $parent->isUserDefined() && !isset(self::$seen[$parent->getName()])) {
|
|
|
|
self::$seen[$parent->getName()] = true;
|
|
|
|
|
|
|
|
array_unshift($classes, $parent);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (function_exists('get_declared_traits')) {
|
|
|
|
foreach ($classes as $c) {
|
|
|
|
foreach (self::getTraits($c) as $trait) {
|
|
|
|
self::$seen[$trait->getName()] = true;
|
|
|
|
|
|
|
|
array_unshift($classes, $trait);
|
|
|
|
}
|
|
|
|
}
|
2012-07-02 18:17:58 +01:00
|
|
|
}
|
|
|
|
|
2012-07-10 19:27:54 +01:00
|
|
|
return array_merge(self::getInterfaces($class), $classes);
|
|
|
|
}
|
|
|
|
|
|
|
|
private static function getInterfaces(\ReflectionClass $class)
|
|
|
|
{
|
|
|
|
$classes = array();
|
|
|
|
|
2012-07-03 16:41:16 +01:00
|
|
|
foreach ($class->getInterfaces() as $interface) {
|
2012-07-10 19:27:54 +01:00
|
|
|
$classes = array_merge($classes, self::getInterfaces($interface));
|
|
|
|
}
|
2012-07-02 18:17:58 +01:00
|
|
|
|
2012-07-10 19:27:54 +01:00
|
|
|
if ($class->isUserDefined() && $class->isInterface() && !isset(self::$seen[$class->getName()])) {
|
|
|
|
self::$seen[$class->getName()] = true;
|
|
|
|
|
|
|
|
$classes[] = $class;
|
2012-07-03 16:41:16 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
return $classes;
|
2012-07-02 18:17:58 +01:00
|
|
|
}
|
|
|
|
|
2012-07-09 13:50:58 +01:00
|
|
|
private static function getTraits(\ReflectionClass $class)
|
2012-07-02 18:17:58 +01:00
|
|
|
{
|
2012-07-03 16:41:16 +01:00
|
|
|
$traits = $class->getTraits();
|
|
|
|
$classes = array();
|
|
|
|
while ($trait = array_pop($traits)) {
|
|
|
|
if ($trait->isUserDefined() && !isset(self::$seen[$trait->getName()])) {
|
|
|
|
$classes[] = $trait;
|
|
|
|
|
|
|
|
$traits = array_merge($traits, $trait->getTraits());
|
|
|
|
}
|
2012-07-02 18:17:58 +01:00
|
|
|
}
|
|
|
|
|
2012-07-03 16:41:16 +01:00
|
|
|
return $classes;
|
2012-07-02 18:17:58 +01:00
|
|
|
}
|
2012-10-27 16:58:32 +01:00
|
|
|
|
2012-10-27 16:55:46 +01:00
|
|
|
/**
|
|
|
|
* This method is only useful for testing.
|
|
|
|
*/
|
|
|
|
public static function enableTokenizer($bool)
|
|
|
|
{
|
|
|
|
self::$useTokenizer = (Boolean) $bool;
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|