PHPのコーディング規則、PSRを学ぶ(4)の続きです。
この記事では、PHPのコーディング規則PSRの規則をまとめます。

1.規則概要

1. 文字コードはUTF-8（BOM無し）
2. 改行コードはLF
3. PHP（開始）コードは「<?php」または 「<?=」
4. PHPのみのファイルの場合は最後の「?>」を省略してよい
5. 最後は改行して終わる
6. インデント（字下げ）は「半角スペース4つ」でタブを使わない
7. 開き「{」は改行して記述
8. シンボル（クラス、関数、定数など）を宣言するためのファイルと、副作用のある処理（出力の生成、ini設定の変更など）を行うためのファイルは、分けるべき
9. クラス名は、StudlyCaps（単語の先頭文字を大文字で表記する記法）記法で定義
10. メソッド名はcamelCase（単語の先頭文字を大文字で表記するが、最初の1文字目は小文字とする記法）記法で定義
11. クラス定数(const)は全て大文字とし、区切り文字にはアンダースコアを用いて定義
12. 名前空間定義・use定義のあとには空行を挟む
13. プロパティの命名規則は「StudlyCaps」「camelCase」「under_score」どれでもよいがファイル内で一貫させること
14. PHPの予約語は小文字で使用
15. PHP定数であるtrue、false、nullは小文字で使用

<?php
namespace Vendor\Package;

use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class Foo extends Bar implements FooInterface
{
    public function sampleFunction($a, $b = null)
    {
        if ($a === $b) {
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }

    final public static function bar()
    {
        // メソッド本文
    }
}

2.名前空間とオートローダーについて

1. PHP5.3.0以上が必要

（namespaceを利用するためです。オートローダーを使わない場合は問題ありません。オートローダーについてはPSR-0（日本語）をご覧ください。）

2. 名前空間は「\<ベンダー名>\(<名前空間>\)*<クラス名>」と設定すること。

言い換えると、「\製作者名\(機構名)\機能名」と設定して名前空間を汚染しないようにしてください。

3. クラス名のアンダースコア「_」はディレクトリの区切りになる
4. 名前空間の中のアンダースコア「_」はディレクトリの区切りにはならない

初心者の方の目線で見た名前空間は、PHPのコーディング規則、PSRを学ぶ(3)にまとめています。

最後に

サイトの改修が完了しましたにいただいたコメントをヒントに「PHPのコーディング規則、PSRを学ぶ」が始まりました。コメントありがとうございました。

参考にさせていただいたサイトの運営者の方々、ありがとうございました。すごく勉強になりました。

PHP・CGIプログラムは使われてこそ価値があります。PHPプログラムを配布し始めたのは最近ですが、それを誰もが改修出来るようにすることによって、さらに良いものが生まれてくることを願っています。

「面白い（個人制作の）ゲームをやりたい！」「いいプログラムを使いたい！」からこそやっております。もし面白いと感じるゲームや便利なプログラムがあったらコメントなどで紹介してください。( ^^)

各記事へのリンク

1. PHPのコーディング規則、PSRを学ぶ(1)
2. PHPのコーディング規則、PSRを学ぶ(2)
3. PHPのコーディング規則、PSRを学ぶ(3)
4. PHPのコーディング規則、PSRを学ぶ(4)
5. PHPのコーディング規則、PSRを学ぶ(5)（当記事）

参考

• 新標準PSRに学ぶきれいなPHP
• PSR-0, 1, 2を日本語に翻訳してみました
• PSR-0 を和訳してみた
• 【php】いまどきのPHPコーディング規約 PSR

PHPのコーディング規則、PSRを学ぶ(3)の続きです。
今回は実際にクラス名定義を自宅サーバーで試してみます。

1.「SplClassLoader.php」を手に入れる

「ダウンロード」または「直接入力」の方法があります。

・ダウンロードでの方法
http://gist.github.com/221634にアクセスして「Download Gist」をクリック。

ダウンロードファイルは「.tar.gz」形式なので、「7Zip」などで解凍します。
「SplClassLoader.php」を「C:\xampp\htdocs\phptest」フォルダにコピー＆ペーストします。
文字コードは「UTF-8（BOMなし）」、改行コードは「LF」で保存します。
（文字コード・改行コードの設定方法がわからない方はこちらの記事（詳細は5章）で解説しています）

・直接入力での方法
「C:\xampp\htdocs\phptest」フォルダに「SplClassLoader.php」ファイルを新規作成。
そのファイルをテキストエディタで開いておきます。

http://gist.github.com/221634にアクセスして「<>」（View Raw）をクリック。

「SplClassLoader.php」のコードのみが表示されるので、「Ctrlボタン＋Aキー」または「右クリック > 全てを選択」で全てを選択し、コピーします。

テキストエディタで開いておいた「SplClassLoader.php」に貼り付け（ペースト）します。
文字コードは「UTF-8（BOMなし）」、改行コードは「LF」で保存します。
（文字コード・改行コードの設定方法がわからない方はこちらの記事（詳細は5章）で解説しています）

2.ローカルサーバーにあるファイルを編集

「C:\xampp\htdocs\phptest」フォルダに「test.php」ファイルを新規作成。
そのファイルに以下のコードを記述します。

<?php
require_once 'SplClassLoader.php';

$classloaderTest = new SplClassLoader('Test', __DIR__);
$classloaderTest->register();

$obj = new Test\Call();
echo $obj->SayHello();

この「test.php」では、「Test」ベンダーの呼び出しと「Test\Clas」クラスの「SayHello」関数を呼び出します。
文字コードは「UTF-8（BOMなし）」、改行コードは「LF」で保存します。

「C:\xampp\htdocs\phptest」フォルダに「Test」フォルダを新規作成。
「C:\xampp\htdocs\phptest\Test」フォルダに移動して、「Call.php」を新規作成。
そのファイルに以下のコードを記述します。

<?php
namespace Test;

class Call
{
    public function SayHello()
    {
        return 'Hello';
    }
}

この「Call.php」では、「Test」ベンダー中で「Call」クラスを定義し、「SayHello」関数をpublic（外でも呼び出せる）に設定します。
文字コードは「UTF-8（BOMなし）」、改行コードは「LF」で保存します。

「SayHello」関数が正常に呼び出されれば「Hello」と表示されます。

3.テストしてみる

XAMPPからApache（サーバー）を開始します。
（紹介しているPHP記述法はPHP5.3以上でないと動かないようです。PHP5.3未満の方は自宅サーバーの作り方を参考にしてください）
「http://localhost/phptest/test.php」にアクセスします。

「Hello」と表示されれば完了です。
表示されない場合はもう1度見直してください。

4.関数を追加してみる

「C:\xampp\htdocs\phptest\test.php」に以下のコードを追加します。

echo $obj->SayGoodBye(); // GoodByeを追加

「C:\xampp\htdocs\phptest\Test\Call.php」の「Call」クラス内に以下の関数を追加します

    public function SayGoodBye()
    {
        return '?GoodBye';
    }

「http://localhost/phptest/test.php」にアクセスします。

「Hello?GoodBye」と表示されます。

役割としては、赤が「SayHello」、青が「SayGoodBye」関数に分割されています。
Hello?GoodBye

いろいろと試してみてください。
変数とか定数はどうなの？という方は40分濃縮 PHP classの教室で解説されています。
今回は以上で終了します。

次の記事

次は、「PSRの規則をまとめてみる」を行います。
PHPのコーディング規則、PSRを学ぶ(5)へ

参考

40分濃縮 PHP classの教室

PHPのコーディング規則、PSRを学ぶ(2)の続きです。
今回はPSR-0, 1, 2を日本語に翻訳してみましたさんのPSR-0（日本語）を読んでみます。

1.本文の冒頭を読んでみる

2.冒頭を読んでみて考えてみる

疑問点1：「ベンダー名って何？」

IT業界では、ハードウェアや・ソフトウェアの供給元企業を「ITベンダー」と呼ぶ。対義語は「ユーザー企業」。（Wikipediaより）

つまり、個人製作の場合「自分の名前またはサイト名」をベンダー名として付ければいいのか。

なぜこういうことをするのか？を考えてみると・・・
PHPは同じ名前の関数やクラス名を指定すると「二重定義」でエラーが出ます。その防止策でしょう。これが「名前空間の汚染」防止なのかもしれません。

疑問点2：「名前空間って何？」

見た感じ、機能の名前を付けていい感じですね。

もう少し読み進めてみると・・・

なるほど！

「\Zend\Mail\Message」のクラス名を分解してみると、
「Zend」という製品の
「Mail」機構の
「Message」機能
というわけですね。

それを、「～/Zend/Mail/Message.php」から読み込むようにしなさいと。
それなら誰でもどこから読んでいるか理解できるし。

あと、「\Zend\Acl」のように機構を分けなくてもいいくらい短ければ、「～/Zend/Acl.php」から読み込むようにしなさいと。

疑問点3：「DIRECTORY_SEPARATORって何？」

直訳すると「DIRECTORY_SEPARATOR」＝ディレクトリの区切り・・・これでなんとなくわかったような気がします。

さらに少し読み進めてみると、

つまり、
・「\<ベンダー名>\(<名前空間>\)*<クラス名>」の構成で、ディレクトリが区切られる
・クラス名のアンダースコア「_」はディレクトリの区切りになる
・名前空間の中のアンダースコア「_」はディレクトリの区切りにはならない
３つのことが示されているわけですね！

私のサイトとこの記事で言い換えると、「\Rei-Farms（ベンダー名）\BLOG（名前空間）\Web製作_PSRの説明（クラス名）」とクラス名を設定して、ファイルは「/Rei-Farms/BLOG/Web製作/PSRの説明」にあると。

それだったら他人のコードを読んでいても混乱する可能性が非常に低くなりますね。

3.最後まで読み進めてみる

「これまでの基準（上記）に適合したクラス設定をしても大丈夫な”クラス名ローダー”を作ってね」というわけですね。

「http://gist.github.com/221634」に推奨の方法があるよとも書かれています。

4.「http://gist.github.com/221634」にアクセスする

OK！英語だ！／(^o^)＼
英語が苦手だとどうしても読むのをためらいますよね。
ですが、重要なことは先頭付近に書いてあることが多いです。

重要そうなところを抜粋してみます。
直訳
“Doctrine Commonパッケージ”の”Doctrine\Commone”のクラスをロードする例。

上記のように、このSplClassLoader.phpのクラスSplClassLoaderを使えばこの基準通りにクラス名が設定できるというわけですね。

これは試してみるしかない！と思いましたが、そろそろ長くなってきているのでこれにて終了します。

次の記事

次は、実際に「クラス名定義を自宅サーバーで試してみる」を行います。
PHPのコーディング規則、PSRを学ぶ(4)へ

参考

PHPのコーディング規約 PSR-0、PSR-1、PSR-2、PSR-3とは
PSR-0 を和訳してみた
5分で分かる名前空間とオートロード