feature #20735 Deprecate ClassCollectionLoader and Kernel::loadClassCache (dbrumann)

This PR was merged into the 3.3-dev branch.

Discussion
----------

Deprecate ClassCollectionLoader and Kernel::loadClassCache

| Q             | A
| ------------- | ---
| Branch?       | "master"
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | yes
| Tests pass?   | yes
| Fixed tickets | #20668
| License       | MIT

As suggested by @nicolas-grekas in #20668 I added deprecation notices to ClassCollectionLoader and Kernel::loadClassCache.

Commits
-------

660d79a Deprecates ClassCache-cache warmer.

Author: fabpot

DataCollector/DataCollector.php

@@ -98,7 +98,7 @@ protected function cloneVar($var)
      *
      * @return string The string representation of the variable
      *
-     * @deprecated Deprecated since version 3.2, to be removed in 4.0. Use cloneVar() instead.
+     * @deprecated since version 3.2, to be removed in 4.0. Use cloneVar() instead.
      */
     protected function varToString($var)
     {

DependencyInjection/AddClassesToCachePass.php

@@ -11,6 +11,10 @@
 
 namespace Symfony\Component\HttpKernel\DependencyInjection;
 
+if (PHP_VERSION_ID >= 70000) {
+    @trigger_error('The '.__NAMESPACE__.'\AddClassesToCachePass class is deprecated since version 3.3 and will be removed in 4.0.', E_USER_DEPRECATED);
+}
+
 use Composer\Autoload\ClassLoader;
 use Symfony\Component\Debug\DebugClassLoader;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -21,6 +25,8 @@
  * Sets the classes to compile in the cache for the container.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since version 3.3, to be removed in 4.0.
  */
 class AddClassesToCachePass implements CompilerPassInterface
 {

DependencyInjection/Extension.php

@@ -47,9 +47,15 @@ public function getAnnotatedClassesToCompile()
      * Adds classes to the class cache.
      *
      * @param array $classes An array of class patterns
+     *
+     * @deprecated since version 3.3, to be removed in 4.0.
      */
     public function addClassesToCompile(array $classes)
     {
+        if (PHP_VERSION_ID >= 70000) {
+            @trigger_error(__METHOD__.'() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);
+        }
+
         $this->classes = array_merge($this->classes, $classes);
     }
 

Kernel.php

@@ -321,17 +321,29 @@ public function getContainer()
      *
      * @param string $name      The cache name prefix
      * @param string $extension File extension of the resulting file
+     *
+     * @deprecated since version 3.3, to be removed in 4.0.
      */
     public function loadClassCache($name = 'classes', $extension = '.php')
     {
+        if (PHP_VERSION_ID >= 70000) {
+            @trigger_error(__METHOD__.'() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);
+        }
+
         $this->loadClassCache = array($name, $extension);
     }
 
     /**
      * @internal
+     *
+     * @deprecated since version 3.3, to be removed in 4.0.
      */
     public function setClassCache(array $classes)
     {
+        if (PHP_VERSION_ID >= 70000) {
+            @trigger_error(__METHOD__.'() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);
+        }
+
         file_put_contents($this->getCacheDir().'/classes.map', sprintf('<?php return %s;', var_export($classes, true)));
     }
 
@@ -375,8 +387,15 @@ public function getCharset()
         return 'UTF-8';
     }
 
+    /**
+     * @deprecated since version 3.3, to be removed in 4.0.
+     */
     protected function doLoadClassCache($name, $extension)
     {
+        if (PHP_VERSION_ID >= 70000) {
+            @trigger_error(__METHOD__.'() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);
+        }
+
         if (!$this->booted && is_file($this->getCacheDir().'/classes.map')) {
             ClassCollectionLoader::load(include($this->getCacheDir().'/classes.map'), $this->getCacheDir(), $name, $this->debug, false, $extension);
         }
@@ -579,7 +598,9 @@ protected function buildContainer()
             $container->merge($cont);
         }
 
-        $container->addCompilerPass(new AddClassesToCachePass($this));
+        if (PHP_VERSION_ID < 70000) {
+            $container->addCompilerPass(new AddClassesToCachePass($this));
+        }
         $container->addResource(new EnvParametersResource('SYMFONY__'));
 
         return $container;

Tests/DependencyInjection/AddClassesToCachePassTest.php

@@ -13,6 +13,9 @@
 
 use Symfony\Component\HttpKernel\DependencyInjection\AddClassesToCachePass;
 
+/**
+ * @group legacy
+ */
 class AddClassesToCachePassTest extends \PHPUnit_Framework_TestCase
 {
     public function testExpandClasses()

Tests/KernelTest.php

@@ -85,6 +85,9 @@ public function testBootSetsTheBootedFlagToTrue()
         $this->assertTrue($kernel->isBooted());
     }
 
+    /**
+     * @group legacy
+     */
     public function testClassCacheIsLoaded()
     {
         $kernel = $this->getKernel(array('initializeBundles', 'initializeContainer', 'doLoadClassCache'));
@@ -105,6 +108,9 @@ public function testClassCacheIsNotLoadedByDefault()
         $kernel->boot();
     }
 
+    /**
+     * @group legacy
+     */
     public function testClassCacheIsNotLoadedWhenKernelIsNotBooted()
     {
         $kernel = $this->getKernel(array('initializeBundles', 'initializeContainer', 'doLoadClassCache'));