FIG-PHP PSR仕様シリーズ4-自動ロード
1.PSR-4仕様:自動ロード
PSR-4は置き換えではなくPSR-0仕様への補完であることが[SR-4-meta]で指摘されているが、PSR-0が2014.10.21で廃棄されたことが[SR-4-meta]に記載されており、PSR-0の不足が[SR-4-meta]に詳細に記載されており、package向けの自動ロードを満たすことはできない.
PSR-4仕様はpackage向けの自動ロードを満たすことができ、ファイルパスからクラスを自動的にロードする方法を仕様し、同時にファイルを自動的にロードする場所を仕様している.
1.1概要
このPSR仕様は、ファイルパスからクラスを自動的にロードすることを記述する.PSR-0仕様と相互運用可能であり、併用可能である.このPSRでは、自動ロードされたファイルがどこに配置されるべきかについても説明しています.
1.2規範
1.2.1「class」という用語はclasses、interfaces、traits、その他類似の構造を指す.
1.2.2規格に完全に適合するクラス名(A fully qualified class name)のフォーマットは以下の通りである.
\(\)*\
(1)完全コンプライアンスのクラス名には、通常「vendorネーミングスペース」と呼ばれるトップクラスのネーミングスペース名が必要である.
(2)完全コンプライアンスのクラス名は、1つ以上の二次ネーミングスペース名(sub-namespace names)を有することができる.
(3)完全コンプライアンスのクラス名はクラス名で終わる必要がある.
(4)完全コンプライアンスのクラス名のいずれの部分においても,下線には特別な意味はない.
(5)完全コンプライアンスのクラス名では,任意の大文字と小文字を混在させることができる.
(6)すべてのクラス名は(MUST)大文字と小文字の敏感な方法で参照しなければならない.
1.2.3完全コンプライアンスのクラス名に対応するファイルをロードする場合...
(1)完全コンプライアンスのクラス名には、前のネーミングスペースセパレータは含まれず、1つのトップネーミングスペースと1つ以上の2次ネーミングスペース名からなるネーミングスペースプレフィックスが、少なくとも1つの「baseディレクトリ」に対応する.
(2)ネーミングスペース接頭辞の後の2次ネーミングスペース名は、「baseディレクトリ」のサブディレクトリに対応し、ネーミングスペース区切り記号はディレクトリ区切り記号を表す.サブディレクトリ名は、2次ネーミングスペース名に一致する必要があります.
(3)後のクラス名は.phpは接尾辞のファイル名であり、このファイル名は後のクラス名に一致しなければならない.
(4)オートローディング実装では、例外を投げ出すことはできず、レベルのエラーを引き起こすことはできず、値を返すべきではない.
1.3. 例を挙げる
次の表は、完全にコンプライアンスされたクラス名、ネーミングスペース接頭辞、baseディレクトリに対応するファイルパスを示しています.
完全コンプライアンスクラス名
名前空間接頭辞
ベースディレクトリ
最終ファイルパス
\Acme\Log\Writer\File_Writer
Acme\Log\Writer
./acme-log-writer/lib/
./acme-log-writer/lib/File_Writer.php
\Aura\Web\Response\Status
Aura\Web
/path/to/aura-web/src/
/path/to/aura-web/src/Response/Status.php
\Symfony\Core\Request
Symfony\Core
./vendor/Symfony/Core/
./vendor/Symfony/Core/Request.php
\Zend\Acl
Zend
/usr/includes/Zend/
/usr/includes/Zend/Acl.php
備考:第1の行動例で説明すると、完全コンプライアンスのクラス名は「AcmeLogWriterFile_Writer」であり、前のネーミングスペースセパレータ''を削除すると、ネーミングスペース接頭辞は「AcmeLogWriter」、クラス名は「File_Writer」となる.このネーミングスペース接頭辞に対応するbaseディレクトリは「./acme-log-writer/lib/」であるため、最終的にロードされるファイル名はbaseディレクトリ+クラス名+「.php」、すなわち「./acme-log-writer/lib/File_Writer.php」である
この仕様に従う自動ローダの実装例は、以下のコードサンプルを参照してください.これらの実装例は、本仕様の内容と見なされてはならず、いつでも変更される可能性がある.
2.コードサンプル
以下のコードはPSR-4のクラス定義に従うことを示しています.
クローズド・パッケージの例:
次のクラスでは、複数のネーミングスペースを処理します.
3.ユニットテスト
次に、対応するユニットテストコードを示します.
4.PSR-4応用
PHPのパケット管理システムComposerはPSR-4をサポートしているとともに、
ComposerはPSR-0スタイルを使用
ComposerはPSR-4スタイルを使用
以上の2つの構造を比較すると、PSR-4がより簡潔なファイル構造をもたらすことが明らかになった.
5.参考資料
[PHP-FIG] php-fig, http://www.php-fig.org/
[PSR-0] Autoloading Standard, http://www.php-fig.org/psr/psr-0/
[PSR-4] Autoloader, http://www.php-fig.org/psr/psr-4/
[PSR-4-Meta] PSR-4 Meta Document, http://www.php-fig.org/psr/psr-4/meta/
[PSR-4-Example] Example Implementations of PSR-4, http://www.php-fig.org/psr/psr-4/examples/
PSR-4は置き換えではなくPSR-0仕様への補完であることが[SR-4-meta]で指摘されているが、PSR-0が2014.10.21で廃棄されたことが[SR-4-meta]に記載されており、PSR-0の不足が[SR-4-meta]に詳細に記載されており、package向けの自動ロードを満たすことはできない.
PSR-4仕様はpackage向けの自動ロードを満たすことができ、ファイルパスからクラスを自動的にロードする方法を仕様し、同時にファイルを自動的にロードする場所を仕様している.
1.1概要
このPSR仕様は、ファイルパスからクラスを自動的にロードすることを記述する.PSR-0仕様と相互運用可能であり、併用可能である.このPSRでは、自動ロードされたファイルがどこに配置されるべきかについても説明しています.
1.2規範
1.2.1「class」という用語はclasses、interfaces、traits、その他類似の構造を指す.
1.2.2規格に完全に適合するクラス名(A fully qualified class name)のフォーマットは以下の通りである.
\
(1)完全コンプライアンスのクラス名には、通常「vendorネーミングスペース」と呼ばれるトップクラスのネーミングスペース名が必要である.
(2)完全コンプライアンスのクラス名は、1つ以上の二次ネーミングスペース名(sub-namespace names)を有することができる.
(3)完全コンプライアンスのクラス名はクラス名で終わる必要がある.
(4)完全コンプライアンスのクラス名のいずれの部分においても,下線には特別な意味はない.
(5)完全コンプライアンスのクラス名では,任意の大文字と小文字を混在させることができる.
(6)すべてのクラス名は(MUST)大文字と小文字の敏感な方法で参照しなければならない.
1.2.3完全コンプライアンスのクラス名に対応するファイルをロードする場合...
(1)完全コンプライアンスのクラス名には、前のネーミングスペースセパレータは含まれず、1つのトップネーミングスペースと1つ以上の2次ネーミングスペース名からなるネーミングスペースプレフィックスが、少なくとも1つの「baseディレクトリ」に対応する.
(2)ネーミングスペース接頭辞の後の2次ネーミングスペース名は、「baseディレクトリ」のサブディレクトリに対応し、ネーミングスペース区切り記号はディレクトリ区切り記号を表す.サブディレクトリ名は、2次ネーミングスペース名に一致する必要があります.
(3)後のクラス名は.phpは接尾辞のファイル名であり、このファイル名は後のクラス名に一致しなければならない.
(4)オートローディング実装では、例外を投げ出すことはできず、レベルのエラーを引き起こすことはできず、値を返すべきではない.
1.3. 例を挙げる
次の表は、完全にコンプライアンスされたクラス名、ネーミングスペース接頭辞、baseディレクトリに対応するファイルパスを示しています.
完全コンプライアンスクラス名
名前空間接頭辞
ベースディレクトリ
最終ファイルパス
\Acme\Log\Writer\File_Writer
Acme\Log\Writer
./acme-log-writer/lib/
./acme-log-writer/lib/File_Writer.php
\Aura\Web\Response\Status
Aura\Web
/path/to/aura-web/src/
/path/to/aura-web/src/Response/Status.php
\Symfony\Core\Request
Symfony\Core
./vendor/Symfony/Core/
./vendor/Symfony/Core/Request.php
\Zend\Acl
Zend
/usr/includes/Zend/
/usr/includes/Zend/Acl.php
備考:第1の行動例で説明すると、完全コンプライアンスのクラス名は「AcmeLogWriterFile_Writer」であり、前のネーミングスペースセパレータ''を削除すると、ネーミングスペース接頭辞は「AcmeLogWriter」、クラス名は「File_Writer」となる.このネーミングスペース接頭辞に対応するbaseディレクトリは「./acme-log-writer/lib/」であるため、最終的にロードされるファイル名はbaseディレクトリ+クラス名+「.php」、すなわち「./acme-log-writer/lib/File_Writer.php」である
この仕様に従う自動ローダの実装例は、以下のコードサンプルを参照してください.これらの実装例は、本仕様の内容と見なされてはならず、いつでも変更される可能性がある.
2.コードサンプル
以下のコードはPSR-4のクラス定義に従うことを示しています.
クローズド・パッケージの例:
<?php
/**
* An example of a project-specific implementation.
*
* After registering this autoload function with SPL, the following line
* would cause the function to attempt to load the \Foo\Bar\Baz\Qux class
* from /path/to/project/src/Baz/Qux.php:
*
* new \Foo\Bar\Baz\Qux;
*
* @param string $class The fully-qualified class name.
* @return void
*/
spl_autoload_register(function ($class) {
// project-specific namespace prefix
//
$prefix = 'Foo\\Bar\\';
// base directory for the namespace prefix
// base
$base_dir = __DIR__ . '/src/';
// does the class use the namespace prefix?
// $class
$len = strlen($prefix);
if (strncmp($prefix, $class, $len) !== 0) {
// no, move to the next registered autoloader
// ,
return;
}
// get the relative class name
//
$relative_class = substr($class, $len);
// replace the namespace prefix with the base directory, replace namespace
// separators with directory separators in the relative class name, append
// with .php
// base ,
// '/' '\',
// .php $file
$file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
// if the file exists, require it
// , require
if (file_exists($file)) {
require $file;
}
});
次のクラスでは、複数のネーミングスペースを処理します.
<?php
namespace Example;
/**
* An example of a general-purpose implementation that includes the optional
* functionality of allowing multiple base directories for a single namespace
* prefix.
* base 。
*
* Given a foo-bar package of classes in the file system at the following
* paths ...
* foo-bar :
*
* /path/to/packages/foo-bar/
* src/
* Baz.php # Foo\Bar\Baz
* Qux/
* Quux.php # Foo\Bar\Qux\Quux
* tests/
* BazTest.php # Foo\Bar\BazTest
* Qux/
* QuuxTest.php # Foo\Bar\Qux\QuuxTest
*
* ... add the path to the class files for the \Foo\Bar\ namespace prefix
* as follows:
* ... \Foo\Bar\ ,
*
* <?php
* // instantiate the loader
* // loader
* $loader = new \Example\Psr4AutoloaderClass;
*
* // register the autoloader
* // autoloader
* $loader->register();
*
* // register the base directories for the namespace prefix
* // base
* $loader->addNamespace('Foo\Bar', '/path/to/packages/foo-bar/src');
* $loader->addNamespace('Foo\Bar', '/path/to/packages/foo-bar/tests');
*
* The following line would cause the autoloader to attempt to load the
* \Foo\Bar\Qux\Quux class from /path/to/packages/foo-bar/src/Qux/Quux.php:
* /path/to/packages/foo-bar/src/Qux/Quux.php \Foo\Bar\Qux\Quux 。
*
* <?php
* new \Foo\Bar\Qux\Quux;
*
* The following line would cause the autoloader to attempt to load the
* \Foo\Bar\Qux\QuuxTest class from /path/to/packages/foo-bar/tests/Qux/QuuxTest.php:
* /path/to/packages/foo-bar/tests/Qux/QuuxTest.php
* \Foo\Bar\Qux\QuuxTest 。
*
* <?php
* new \Foo\Bar\Qux\QuuxTest;
*/
class Psr4AutoloaderClass
{
/**
* An associative array where the key is a namespace prefix and the value
* is an array of base directories for classes in that namespace.
* :key ,value , base .
*
* @var array
*/
protected $prefixes = array();
/**
* Register loader with SPL autoloader stack.
* SPL loader
*
* @return void
*/
public function register()
{
spl_autoload_register(array($this, 'loadClass'));
}
/**
* Adds a base directory for a namespace prefix.
* base
*
* @param string $prefix The namespace prefix.
* @param string $base_dir A base directory for class files in the
* namespace.
* @param bool $prepend If true, prepend the base directory to the stack
* instead of appending it; this causes it to be searched first rather
* than last.
* @return void
*/
public function addNamespace($prefix, $base_dir, $prepend = false)
{
// normalize namespace prefix
//
$prefix = trim($prefix, '\\') . '\\';
// normalize the base directory with a trailing separator
// '/' base
$base_dir = rtrim($base_dir, DIRECTORY_SEPARATOR) . '/';
// initialize the namespace prefix array
//
if (isset($this->prefixes[$prefix]) === false) {
$this->prefixes[$prefix] = array();
}
// retain the base directory for the namespace prefix
// base
if ($prepend) {
array_unshift($this->prefixes[$prefix], $base_dir);
} else {
array_push($this->prefixes[$prefix], $base_dir);
}
}
/**
* Loads the class file for a given class name.
* 。
*
* @param string $class The fully-qualified class name.
* @return mixed The mapped file name on success, or boolean false on
* failure.
*/
public function loadClass($class)
{
// the current namespace prefix
$prefix = $class;
// work backwards through the namespace names of the fully-qualified
// class name to find a mapped file name
// ,
while (false !== $pos = strrpos($prefix, '\\')) {
// retain the trailing namespace separator in the prefix
//
$prefix = substr($class, 0, $pos + 1);
// the rest is the relative class name
//
$relative_class = substr($class, $pos + 1);
// try to load a mapped file for the prefix and relative class
//
$mapped_file = $this->loadMappedFile($prefix, $relative_class);
if ($mapped_file) {
return $mapped_file;
}
// remove the trailing namespace separator for the next iteration
// of strrpos()
// , strrpos()
$prefix = rtrim($prefix, '\\');
}
// never found a mapped file
//
return false;
}
/**
* Load the mapped file for a namespace prefix and relative class.
*
*
* @param string $prefix The namespace prefix.
* @param string $relative_class The relative class name.
* @return mixed Boolean false if no mapped file can be loaded, or the
* name of the mapped file that was loaded.
*/
protected function loadMappedFile($prefix, $relative_class)
{
// are there any base directories for this namespace prefix?
// base ?
if (isset($this->prefixes[$prefix]) === false) {
return false;
}
// look through base directories for this namespace prefix
// base
foreach ($this->prefixes[$prefix] as $base_dir) {
// replace the namespace prefix with the base directory,
// replace namespace separators with directory separators
// in the relative class name, append with .php
// base ,
// '/' '\',
// .php $file
$file = $base_dir
. str_replace('\\', '/', $relative_class)
. '.php';
// if the mapped file exists, require it
// , require
if ($this->requireFile($file)) {
// yes, we're done
return $file;
}
}
// never found it
return false;
}
/**
* If a file exists, require it from the file system.
*
* @param string $file The file to require.
* @return bool True if the file exists, false if not.
*/
protected function requireFile($file)
{
if (file_exists($file)) {
require $file;
return true;
}
return false;
}
}
3.ユニットテスト
次に、対応するユニットテストコードを示します.
<?php
namespace Example\Tests;
class MockPsr4AutoloaderClass extends Psr4AutoloaderClass
{
protected $files = array();
public function setFiles(array $files)
{
$this->files = $files;
}
protected function requireFile($file)
{
return in_array($file, $this->files);
}
}
class Psr4AutoloaderClassTest extends \PHPUnit_Framework_TestCase
{
protected $loader;
protected function setUp()
{
$this->loader = new MockPsr4AutoloaderClass;
$this->loader->setFiles(array(
'/vendor/foo.bar/src/ClassName.php',
'/vendor/foo.bar/src/DoomClassName.php',
'/vendor/foo.bar/tests/ClassNameTest.php',
'/vendor/foo.bardoom/src/ClassName.php',
'/vendor/foo.bar.baz.dib/src/ClassName.php',
'/vendor/foo.bar.baz.dib.zim.gir/src/ClassName.php',
));
$this->loader->addNamespace(
'Foo\Bar',
'/vendor/foo.bar/src'
);
$this->loader->addNamespace(
'Foo\Bar',
'/vendor/foo.bar/tests'
);
$this->loader->addNamespace(
'Foo\BarDoom',
'/vendor/foo.bardoom/src'
);
$this->loader->addNamespace(
'Foo\Bar\Baz\Dib',
'/vendor/foo.bar.baz.dib/src'
);
$this->loader->addNamespace(
'Foo\Bar\Baz\Dib\Zim\Gir',
'/vendor/foo.bar.baz.dib.zim.gir/src'
);
}
public function testExistingFile()
{
$actual = $this->loader->loadClass('Foo\Bar\ClassName');
$expect = '/vendor/foo.bar/src/ClassName.php';
$this->assertSame($expect, $actual);
$actual = $this->loader->loadClass('Foo\Bar\ClassNameTest');
$expect = '/vendor/foo.bar/tests/ClassNameTest.php';
$this->assertSame($expect, $actual);
}
public function testMissingFile()
{
$actual = $this->loader->loadClass('No_Vendor\No_Package\NoClass');
$this->assertFalse($actual);
}
public function testDeepFile()
{
$actual = $this->loader->loadClass('Foo\Bar\Baz\Dib\Zim\Gir\ClassName');
$expect = '/vendor/foo.bar.baz.dib.zim.gir/src/ClassName.php';
$this->assertSame($expect, $actual);
}
public function testConfusion()
{
$actual = $this->loader->loadClass('Foo\Bar\DoomClassName');
$expect = '/vendor/foo.bar/src/DoomClassName.php';
$this->assertSame($expect, $actual);
$actual = $this->loader->loadClass('Foo\BarDoom\ClassName');
$expect = '/vendor/foo.bardoom/src/ClassName.php';
$this->assertSame($expect, $actual);
}
}
4.PSR-4応用
PHPのパケット管理システムComposerはPSR-4をサポートしているとともに、
composer.json
で異なるprefixを定義して異なる自動ロードメカニズムを使用することも可能である.ComposerはPSR-0スタイルを使用
vendor/
vendor_name/
package_name/
src/
Vendor_Name/
Package_Name/
ClassName.php # Vendor_Name\Package_Name\ClassName
tests/
Vendor_Name/
Package_Name/
ClassNameTest.php # Vendor_Name\Package_Name\ClassName
ComposerはPSR-4スタイルを使用
vendor/
vendor_name/
package_name/
src/
ClassName.php # Vendor_Name\Package_Name\ClassName
tests/
ClassNameTest.php # Vendor_Name\Package_Name\ClassNameTest
以上の2つの構造を比較すると、PSR-4がより簡潔なファイル構造をもたらすことが明らかになった.
5.参考資料
[PHP-FIG] php-fig, http://www.php-fig.org/
[PSR-0] Autoloading Standard, http://www.php-fig.org/psr/psr-0/
[PSR-4] Autoloader, http://www.php-fig.org/psr/psr-4/
[PSR-4-Meta] PSR-4 Meta Document, http://www.php-fig.org/psr/psr-4/meta/
[PSR-4-Example] Example Implementations of PSR-4, http://www.php-fig.org/psr/psr-4/examples/