Docblock fixes

This PR was merged into the 2.3 branch.

Discussion
----------

[ClassLoader] define constant only if it wasn't defined before

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        |

Commits
-------

388229b define constant only if it wasn't defined before

ApcClassLoader.php

@@ -54,8 +54,8 @@ class ApcClassLoader
     /**
      * Constructor.
      *
-     * @param string $prefix      The APC namespace prefix to use.
-     * @param object $decorated   A class loader object that implements the findFile() method.
+     * @param string $prefix    The APC namespace prefix to use.
+     * @param object $decorated A class loader object that implements the findFile() method.
      *
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
@@ -79,7 +79,7 @@ class ApcClassLoader
     /**
      * Registers this instance as an autoloader.
      *
-     * @param bool    $prepend Whether to prepend the autoloader or not
+     * @param bool $prepend Whether to prepend the autoloader or not
      */
     public function register($prepend = false)
     {
@@ -99,7 +99,7 @@ class ApcClassLoader
      *
      * @param string $class The name of the class
      *
-     * @return bool|null    True, if loaded
+     * @return bool|null True, if loaded
      */
     public function loadClass($class)
     {

CHANGELOG.md

@@ -1,11 +1,6 @@
 CHANGELOG
 =========
 
-2.4.0
------
-
- * deprecated the DebugClassLoader as it has been moved to the Debug component instead
-
 2.3.0
 -----
 

ClassCollectionLoader.php

@@ -25,12 +25,12 @@ class ClassCollectionLoader
     /**
      * 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 bool    $autoReload Whether to flush the cache when the cache is stale or not
-     * @param bool    $adaptive   Whether to remove already declared classes or not
-     * @param string  $extension  File extension of the resulting file
+     * @param array  $classes    An array of classes to load
+     * @param string $cacheDir   A cache directory
+     * @param string $name       The cache name prefix
+     * @param bool   $autoReload Whether to flush the cache when the cache is stale or not
+     * @param bool   $adaptive   Whether to remove already declared classes or not
+     * @param string $extension  File extension of the resulting file
      *
      * @throws \InvalidArgumentException When class can't be loaded
      */
@@ -53,7 +53,7 @@ class ClassCollectionLoader
             $classes = array_diff($classes, $declared);
 
             // the cache is different depending on which classes are already declared
-            $name = $name.'-'.substr(hash('sha256', implode('|', $classes)), 0, 5);
+            $name = $name.'-'.substr(md5(implode('|', $classes)), 0, 5);
         }
 
         $classes = array_unique($classes);
@@ -335,10 +335,10 @@ class ClassCollectionLoader
      * This function does not check for circular dependencies as it should never
      * occur with PHP traits.
      *
-     * @param array             $tree       The dependency tree
-     * @param \ReflectionClass  $node       The node
-     * @param \ArrayObject      $resolved   An array of already resolved dependencies
-     * @param \ArrayObject      $unresolved An array of dependencies to be resolved
+     * @param array            $tree       The dependency tree
+     * @param \ReflectionClass $node       The node
+     * @param \ArrayObject     $resolved   An array of already resolved dependencies
+     * @param \ArrayObject     $unresolved An array of dependencies to be resolved
      *
      * @return \ArrayObject The dependencies for the given node
      *

ClassLoader.php

@@ -103,7 +103,7 @@ class ClassLoader
     /**
      * Turns on searching the include for class files.
      *
-     * @param bool    $useIncludePath
+     * @param bool $useIncludePath
      */
     public function setUseIncludePath($useIncludePath)
     {
@@ -124,7 +124,7 @@ class ClassLoader
     /**
      * Registers this instance as an autoloader.
      *
-     * @param bool    $prepend Whether to prepend the autoloader or not
+     * @param bool $prepend Whether to prepend the autoloader or not
      */
     public function register($prepend = false)
     {
@@ -144,7 +144,7 @@ class ClassLoader
      *
      * @param string $class The name of the class
      *
-     * @return bool|null    True, if loaded
+     * @return bool|null True, if loaded
      */
     public function loadClass($class)
     {

ClassMapGenerator.php

@@ -11,10 +11,12 @@
 
 namespace Symfony\Component\ClassLoader;
 
-if (PHP_VERSION_ID >= 50400) {
-    define('SYMFONY_TRAIT', T_TRAIT);
-} else {
-    define('SYMFONY_TRAIT', 0);
+if (!defined('SYMFONY_TRAIT')) {
+    if (PHP_VERSION_ID >= 50400) {
+        define('SYMFONY_TRAIT', T_TRAIT);
+    } else {
+        define('SYMFONY_TRAIT', 0);
+    }
 }
 
 /**

DebugClassLoader.php

@@ -22,8 +22,6 @@ namespace Symfony\Component\ClassLoader;
  * @author Christophe Coevoet <stof@notk.org>
  *
  * @api
- *
- * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the DebugClassLoader provided by the Debug component instead.
  */
 class DebugClassLoader
 {
@@ -41,16 +39,6 @@ class DebugClassLoader
         $this->classFinder = $classFinder;
     }
 
-    /**
-     * Gets the wrapped class loader.
-     *
-     * @return object a class loader instance
-     */
-    public function getClassLoader()
-    {
-        return $this->classFinder;
-    }
-
     /**
      * Replaces all autoloaders implementing a findFile method by a DebugClassLoader wrapper.
      */
@@ -98,7 +86,7 @@ class DebugClassLoader
      *
      * @param string $class The name of the class
      *
-     * @return bool|null    True, if loaded
+     * @return bool|null True, if loaded
      *
      * @throws \RuntimeException
      */

MapClassLoader.php

@@ -33,7 +33,7 @@ class MapClassLoader
     /**
      * Registers this instance as an autoloader.
      *
-     * @param bool    $prepend Whether to prepend the autoloader or not
+     * @param bool $prepend Whether to prepend the autoloader or not
      */
     public function register($prepend = false)
     {

Psr4ClassLoader.php

@@ -1,94 +0,0 @@
-<?php
-
-/*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Symfony\Component\ClassLoader;
-
-/**
- * A PSR-4 compatible class loader.
- *
- * See http://www.php-fig.org/psr/psr-4/
- *
- * @author Alexander M. Turek <me@derrabus.de>
- */
-class Psr4ClassLoader
-{
-    /**
-     * @var array
-     */
-    private $prefixes = array();
-
-    /**
-     * @param string $prefix
-     * @param string $baseDir
-     */
-    public function addPrefix($prefix, $baseDir)
-    {
-        $prefix = trim($prefix, '\\').'\\';
-        $baseDir = rtrim($baseDir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
-        $this->prefixes[] = array($prefix, $baseDir);
-    }
-
-    /**
-     * @param string $class
-     *
-     * @return string|null
-     */
-    public function findFile($class)
-    {
-        $class = ltrim($class, '\\');
-
-        foreach ($this->prefixes as $current) {
-            list($currentPrefix, $currentBaseDir) = $current;
-            if (0 === strpos($class, $currentPrefix)) {
-                $classWithoutPrefix = substr($class, strlen($currentPrefix));
-                $file = $currentBaseDir.str_replace('\\', DIRECTORY_SEPARATOR, $classWithoutPrefix).'.php';
-                if (file_exists($file)) {
-                    return $file;
-                }
-            }
-        }
-    }
-
-    /**
-     * @param string $class
-     *
-     * @return bool
-     */
-    public function loadClass($class)
-    {
-        $file = $this->findFile($class);
-        if (null !== $file) {
-            require $file;
-
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Registers this instance as an autoloader.
-     *
-     * @param bool    $prepend
-     */
-    public function register($prepend = false)
-    {
-        spl_autoload_register(array($this, 'loadClass'), true, $prepend);
-    }
-
-    /**
-     * Removes this instance from the registered autoloaders.
-     */
-    public function unregister()
-    {
-        spl_autoload_unregister(array($this, 'loadClass'));
-    }
-}

Tests/ClassCollectionLoaderTest.php

@@ -227,7 +227,7 @@ class WithComments
 {
 public static \$loaded = true;
 }
-\$string ='string shoult not be   modified {\$string}';
+\$string ='string should not be   modified {\$string}';
 \$heredoc = (<<<HD
 
 

Tests/ClassLoaderTest.php

@@ -72,7 +72,7 @@ class ClassLoaderTest extends \PHPUnit_Framework_TestCase
     public function getLoadNonexistentClassTests()
     {
         return array(
-            array('\\Pearlike3_Bar', '\\Pearlike3_Bar', '->loadClass() loads non existing Pearlike3_Bar class with a leading slash'),
+            array('\\Pearlike3_Bar', '\\Pearlike3_Bar', '->loadClass() loads non exising Pearlike3_Bar class with a leading slash'),
         );
     }
 

Tests/ClassMapGeneratorTest.php

@@ -120,6 +120,10 @@ class ClassMapGeneratorTest extends \PHPUnit_Framework_TestCase
 
     public function testCreateMapFinderSupport()
     {
+        if (!class_exists('Symfony\\Component\\Finder\\Finder')) {
+            $this->markTestSkipped('Finder component is not available');
+        }
+
         $finder = new \Symfony\Component\Finder\Finder();
         $finder->files()->in(__DIR__.'/Fixtures/beta/NamespaceCollision');
 

Tests/DebugClassLoaderTest.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\ClassLoader\Tests;
+
+use Symfony\Component\ClassLoader\ClassLoader;
+use Symfony\Component\ClassLoader\DebugClassLoader;
+
+class DebugClassLoaderTest extends \PHPUnit_Framework_TestCase
+{
+    private $loader;
+
+    protected function setUp()
+    {
+        $this->loader = new ClassLoader();
+        spl_autoload_register(array($this->loader, 'loadClass'));
+    }
+
+    protected function tearDown()
+    {
+        spl_autoload_unregister(array($this->loader, 'loadClass'));
+    }
+
+    public function testIdempotence()
+    {
+        DebugClassLoader::enable();
+        DebugClassLoader::enable();
+
+        $functions = spl_autoload_functions();
+        foreach ($functions as $function) {
+            if (is_array($function) && $function[0] instanceof DebugClassLoader) {
+                $reflClass = new \ReflectionClass($function[0]);
+                $reflProp = $reflClass->getProperty('classFinder');
+                $reflProp->setAccessible(true);
+
+                $this->assertNotInstanceOf('Symfony\Component\ClassLoader\DebugClassLoader', $reflProp->getValue($function[0]));
+
+                return;
+            }
+        }
+
+        throw new \Exception('DebugClassLoader did not register');
+    }
+}

Tests/Fixtures/Namespaced/WithComments.php

@@ -17,7 +17,7 @@ class WithComments
     public static $loaded = true;
 }
 
-$string = 'string shoult not be   modified {$string}';
+$string = 'string should not be   modified {$string}';
 
 $heredoc = (<<<HD
 

Tests/Fixtures/psr-4/Class_With_Underscores.php

@@ -1,7 +0,0 @@
-<?php
-
-namespace Acme\DemoLib;
-
-class Class_With_Underscores
-{
-}

Tests/Fixtures/psr-4/Foo.php

@@ -1,7 +0,0 @@
-<?php
-
-namespace Acme\DemoLib;
-
-class Foo
-{
-}

Tests/Fixtures/psr-4/Lets/Go/Deeper/Class_With_Underscores.php

@@ -1,7 +0,0 @@
-<?php
-
-namespace Acme\DemoLib\Lets\Go\Deeper;
-
-class Class_With_Underscores
-{
-}

Tests/Fixtures/psr-4/Lets/Go/Deeper/Foo.php

@@ -1,7 +0,0 @@
-<?php
-
-namespace Acme\DemoLib\Lets\Go\Deeper;
-
-class Foo
-{
-}

Tests/Psr4ClassLoaderTest.php

@@ -1,71 +0,0 @@
-<?php
-
-/*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Symfony\Component\ClassLoader\Tests;
-
-use Symfony\Component\ClassLoader\Psr4ClassLoader;
-
-class Psr4ClassLoaderTest extends \PHPUnit_Framework_TestCase
-{
-    /**
-     * @param string $className
-     * @dataProvider getLoadClassTests
-     */
-    public function testLoadClass($className)
-    {
-        $loader = new Psr4ClassLoader();
-        $loader->addPrefix(
-            'Acme\\DemoLib',
-            __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'psr-4'
-        );
-        $loader->loadClass($className);
-        $this->assertTrue(class_exists($className), sprintf('loadClass() should load %s', $className));
-    }
-
-    /**
-     * @return array
-     */
-    public function getLoadClassTests()
-    {
-        return array(
-            array('Acme\\DemoLib\\Foo'),
-            array('Acme\\DemoLib\\Class_With_Underscores'),
-            array('Acme\\DemoLib\\Lets\\Go\\Deeper\\Foo'),
-            array('Acme\\DemoLib\\Lets\\Go\\Deeper\\Class_With_Underscores'),
-        );
-    }
-
-    /**
-     * @param string $className
-     * @dataProvider getLoadNonexistentClassTests
-     */
-    public function testLoadNonexistentClass($className)
-    {
-        $loader = new Psr4ClassLoader();
-        $loader->addPrefix(
-            'Acme\\DemoLib',
-            __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'psr-4'
-        );
-        $loader->loadClass($className);
-        $this->assertFalse(class_exists($className), sprintf('loadClass() should not load %s', $className));
-    }
-
-    /**
-     * @return array
-     */
-    public function getLoadNonexistentClassTests()
-    {
-        return array(
-            array('Acme\\DemoLib\\I_Do_Not_Exist'),
-            array('UnknownVendor\\SomeLib\\I_Do_Not_Exist'),
-        );
-    }
-}

UniversalClassLoader.php

@@ -70,7 +70,7 @@ class UniversalClassLoader
      * Turns on searching the include for class files. Allows easy loading
      * of installed PEAR packages
      *
-     * @param bool    $useIncludePath
+     * @param bool $useIncludePath
      */
     public function useIncludePath($useIncludePath)
     {
@@ -229,7 +229,7 @@ class UniversalClassLoader
     /**
      * Registers this instance as an autoloader.
      *
-     * @param bool    $prepend Whether to prepend the autoloader or not
+     * @param bool $prepend Whether to prepend the autoloader or not
      *
      * @api
      */
@@ -243,7 +243,7 @@ class UniversalClassLoader
      *
      * @param string $class The name of the class
      *
-     * @return bool|null    True, if loaded
+     * @return bool|null True, if loaded
      */
     public function loadClass($class)
     {

WinCacheClassLoader.php

@@ -53,8 +53,8 @@ class WinCacheClassLoader
     /**
      * Constructor.
      *
-     * @param string $prefix      The WinCache namespace prefix to use.
-     * @param object $decorated   A class loader object that implements the findFile() method.
+     * @param string $prefix    The WinCache namespace prefix to use.
+     * @param object $decorated A class loader object that implements the findFile() method.
      *
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
@@ -76,7 +76,7 @@ class WinCacheClassLoader
     /**
      * Registers this instance as an autoloader.
      *
-     * @param bool    $prepend Whether to prepend the autoloader or not
+     * @param bool $prepend Whether to prepend the autoloader or not
      */
     public function register($prepend = false)
     {
@@ -96,7 +96,7 @@ class WinCacheClassLoader
      *
      * @param string $class The name of the class
      *
-     * @return bool|null    True, if loaded
+     * @return bool|null True, if loaded
      */
     public function loadClass($class)
     {

XcacheClassLoader.php

@@ -52,8 +52,8 @@ class XcacheClassLoader
     /**
      * Constructor.
      *
-     * @param string $prefix      The XCache namespace prefix to use.
-     * @param object $decorated   A class loader object that implements the findFile() method.
+     * @param string $prefix    The XCache namespace prefix to use.
+     * @param object $decorated A class loader object that implements the findFile() method.
      *
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
@@ -77,7 +77,7 @@ class XcacheClassLoader
     /**
      * Registers this instance as an autoloader.
      *
-     * @param bool    $prepend Whether to prepend the autoloader or not
+     * @param bool $prepend Whether to prepend the autoloader or not
      */
     public function register($prepend = false)
     {
@@ -97,7 +97,7 @@ class XcacheClassLoader
      *
      * @param string $class The name of the class
      *
-     * @return bool|null    True, if loaded
+     * @return bool|null True, if loaded
      */
     public function loadClass($class)
     {

composer.json

@@ -28,7 +28,7 @@
     "target-dir": "Symfony/Component/ClassLoader",
     "extra": {
         "branch-alias": {
-            "dev-master": "2.5-dev"
+            "dev-master": "2.3-dev"
         }
     }
 }