-
- Notifications
You must be signed in to change notification settings - Fork 9.7k
[ClassLoader] A PSR-4 compatible class loader #10100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
<?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; | ||
| ||
/** | ||
* ClassLoader implements an PSR-4 class loader | ||
* | ||
* See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I prefer linking to http://www.php-fig.org/psr/psr-4/ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree. We should change this in | ||
* | ||
* @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, '\\') . '\\'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we don't put spaces around the | ||
$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 (strpos($class, $currentPrefix) === 0) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
| ||
$classWithoutPrefix = substr($class, strlen($currentPrefix)); | ||
$file = $currentBaseDir . str_replace('\\', DIRECTORY_SEPARATOR, $classWithoutPrefix) . '.php'; | ||
if (file_exists($file)) { | ||
return $file; | ||
} | ||
} | ||
} | ||
| ||
return null; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this standard or personal taste? I prefer explicitly writing There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it's a standard There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IMO There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. imo, when discussion what is correct, we should not consider what IDEs will do. And actually, this hole return statement should be removed. It does not make sense at all. | ||
} | ||
| ||
/** | ||
* @param string $class | ||
* @return bool | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. add an empty comment line between There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Symfony CS uses Boolean (with the first letter uppercase) | ||
*/ | ||
public function loadClass($class) | ||
{ | ||
$file = $this->findFile($class); | ||
if ($file !== null) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
| ||
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')); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<?php | ||
| ||
namespace Acme\DemoLib; | ||
| ||
class Class_With_Underscores | ||
{ | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<?php | ||
| ||
namespace Acme\DemoLib; | ||
| ||
class Foo | ||
{ | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<?php | ||
| ||
namespace Acme\DemoLib\Lets\Go\Deeper; | ||
| ||
class Class_With_Underscores | ||
{ | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<?php | ||
| ||
namespace Acme\DemoLib\Lets\Go\Deeper; | ||
| ||
class Foo | ||
{ | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
<?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') | ||
); | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we used to add a dot after the short description