[ClassLoader] Add ClassCollectionLoader::inline() to generate inlined…

…-classes files
symfony · nicolas-grekas · Jul 3, 2016 · Jul 5, 2016 · Jul 17, 2016 · 5ad1f0ad754a37424cb4fefcadc2b2ed3ad3fb5f
commit 5ad1f0ad754a37424cb4fefcadc2b2ed3ad3fb5f
diff --git a/src/Symfony/Component/ClassLoader/ClassCollectionLoader.php b/src/Symfony/Component/ClassLoader/ClassCollectionLoader.php
@@ -93,14 +93,41 @@ public static function load($classes, $cacheDir, $name, $autoReload, $adaptive =
             $declared = array_merge(get_declared_classes(), get_declared_interfaces(), get_declared_traits());
         }
 
+        $files = self::inline($classes, $cache, $declared);
+
+        if ($autoReload) {
+            // save the resources
+            self::writeCacheFile($metadata, serialize(array(array_values($files), $classes)));
+        }
+    }
+
+    /**
+     * Generates a file where classes and their parents are inlined.
+     *
+     * @param array  $classes  An array of classes to load
+     * @param string $cache    The file where classes are inlined
+     * @param array  $excluded An array of classes that won't be inlined
+     *
+     * @return array The source map of inlined classes, with classes as keys and files as values
+     *
+     * @throws \RuntimeException When class can't be loaded
+     */
+    public static function inline($classes, $cache, array $excluded)
+    {
+        $declared = array();
+        foreach (self::getOrderedClasses($excluded) as $class) {
+            $declared[$class->getName()] = true;
+        }
+
         $files = array();
         $content = '';
         foreach (self::getOrderedClasses($classes) as $class) {
-            if (in_array($class->getName(), $declared)) {
+            if (isset($declared[$class->getName()])) {
                 continue;
             }
+            $declared[$class->getName()] = true;
 
-            $files[] = $class->getFileName();
+            $files[$class->getName()] = $class->getFileName();
 
             $c = preg_replace(array('/^\s*<\?php/', '/\?>\s*$/'), '', file_get_contents($class->getFileName()));
 
@@ -116,15 +143,13 @@ public static function load($classes, $cacheDir, $name, $autoReload, $adaptive =
         }
 
         // cache the core classes
+        $cacheDir = dirname($cache);
         if (!is_dir($cacheDir) && !@mkdir($cacheDir, 0777, true) && !is_dir($cacheDir)) {
             throw new \RuntimeException(sprintf('Class Collection Loader was not able to create directory "%s"', $cacheDir));
         }
         self::writeCacheFile($cache, '<?php '.$content);
 
-        if ($autoReload) {
-            // save the resources
-            self::writeCacheFile($metadata, serialize(array($files, $classes)));
-        }
+        return $files;
     }
 
     /**

diff --git a/src/Symfony/Component/ClassLoader/Tests/ClassCollectionLoaderTest.php b/src/Symfony/Component/ClassLoader/Tests/ClassCollectionLoaderTest.php
@@ -12,6 +12,8 @@
 namespace Symfony\Component\ClassLoader\Tests;
 
 use Symfony\Component\ClassLoader\ClassCollectionLoader;
+use Symfony\Component\ClassLoader\Tests\Fixtures\DeclaredClass;
+use Symfony\Component\ClassLoader\Tests\Fixtures\WarmedClass;
 
 require_once __DIR__.'/Fixtures/ClassesWithParents/GInterface.php';
 require_once __DIR__.'/Fixtures/ClassesWithParents/CInterface.php';
@@ -271,4 +273,36 @@ class Pearlike_WithComments
 
         unlink($file);
     }
+
+    public function testInline()
+    {
+        $this->assertTrue(class_exists(WarmedClass::class, true));
+
+        @unlink($cache = sys_get_temp_dir().'/inline.php');
+
+        $classes = array(WarmedClass::class);
+        $excluded = array(DeclaredClass::class);
+
+        ClassCollectionLoader::inline($classes, $cache, $excluded);
+
+        $this->assertSame(<<<'EOTXT'
+<?php 
+namespace Symfony\Component\ClassLoader\Tests\Fixtures
+{
+interface WarmedInterface
+{
+}
+}
+namespace Symfony\Component\ClassLoader\Tests\Fixtures
+{
+class WarmedClass extends DeclaredClass implements WarmedInterface
+{
+}
+}
+EOTXT
+            , file_get_contents($cache)
+        );
+
+        unlink($cache);
+    }
 }
diff --git a/src/Symfony/Component/ClassLoader/Tests/Fixtures/DeclaredClass.php b/src/Symfony/Component/ClassLoader/Tests/Fixtures/DeclaredClass.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\ClassLoader\Tests\Fixtures;
+
+class DeclaredClass implements DeclaredInterface
+{
+}
diff --git a/src/Symfony/Component/ClassLoader/Tests/Fixtures/DeclaredInterface.php b/src/Symfony/Component/ClassLoader/Tests/Fixtures/DeclaredInterface.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\ClassLoader\Tests\Fixtures;
+
+interface DeclaredInterface
+{
+}
diff --git a/src/Symfony/Component/ClassLoader/Tests/Fixtures/WarmedClass.php b/src/Symfony/Component/ClassLoader/Tests/Fixtures/WarmedClass.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\ClassLoader\Tests\Fixtures;
+
+class WarmedClass extends DeclaredClass implements WarmedInterface
+{
+}
diff --git a/src/Symfony/Component/ClassLoader/Tests/Fixtures/WarmedInterface.php b/src/Symfony/Component/ClassLoader/Tests/Fixtures/WarmedInterface.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\ClassLoader\Tests\Fixtures;
+
+interface WarmedInterface
+{
+}