PHPで動的にクラス名を指定するとオートロードできない

PHP で動的にクラス名を指定する場合、現在いる名前空間が修飾されないため、
クラス名のみで名前空間内のクラスを指定して new するとクラスを見つけられず致命的なエラーになります。

エラーになる例

クラスファイルのパス構成

例えば PSR-0 規約に準拠して以下のような構成で Car クラスと CarCreator クラスを配置していたとします。

  • /var/www/sample/Vendor/SampleVendor/Entity
    • Car.php
    • CarCreator.php

Car.php

SampleVendor\Entity の名前空間で Car クラスを定義します。

<?php
namespace SampleVendor\Entity

class Car {}

CarCreator.php

この状態で Car クラスと同じ名前空間の CarCreator クラスから Car クラスのインスタンスを生成してみます。
autoload.php は既に読み込まれた状態です。

<?php
namespace SampleVendor\Entity

class CarCreator {
    public function create() {
        // 現在の名前空間が修飾され問題なくインスタンスが生成される
        $car = new Car();

        // 名前空間が修飾されずクラスが見つからずエラー
        // Fatal error: Class 'Car' not found in /var/www/sample/...
        $className = 'Car';
        $car = new $className();
    }
}

このエラーを解決するには完全修飾形式でクラス名を設定するか、
Car クラスを別途 use 句で指定する必要があります。

解決方法

CarCreator.php

以下、完全修飾形式で $className を指定する場合の例です。

<?php
namespace SampleVendor\Entity
class CarCreator {
    public function create() {
        $className = __NAMESPACE__ . '\\' . 'Car';
        $car = new $className();
    }
}

__NAMESPACE__ 定数は現在の名前空間名の文字列なので、これを先頭に付与しておきます。

CharSequenceはインターフェース

String型を指定したい部分にCharSequenceって出てきたので
なによと思ったのですが、どうやらインターフェースみたいです。

公式リファレンスを見てみると以下のような説明が書かれています。
>char シーケンスへの統一された読み取り専用アクセスを提供します。

なるほどね。

ちなみにこのインターフェースを実装しているクラス一覧は以下の通り。

  • String
  • CharBuffer
  • StringBuffer
  • StringBuilder

たまに引数の型で出てくるので覚えておくといいかもしれません。

PHP5で定数の定義はどうするべきか

今まではPHPで定数といえば普通に大文字の変数名で定義しておくか、define関数を使って定義するかだったと思います。

変数の定義はのメリットとにかく手軽ということが挙げられます。制約などを考えずにいつもの変数通りに使えます。
逆にデメリットは変数であるということ。簡単に上書きできてしまいますし、グローバルな名前空間も汚してしまいます。「変」数なんです。「定」数ではありません。

//定数絡みの命名はよく大文字アンダーバー区切りが用いられる
$APPLE = 'リンゴ';
$ORANGE = 'オレンジ';

//もちろん配列や関数などによる定義も自由に可能
$FROUIT_LIST = array($APPLE, $ORANGE);

//上書きされる可能性もつきまとう
$ORANGE = 'グリーン';

もう一つのdefine関数の定義はしっかり定数です。define関数で定義する時、通常通り式による定義も出来ます。
デメリットとしては名前空間がグローバルなこと。変数とは名前は別扱いですがいろんなファイルやライブラリでどんどん定数を定義していくと重複の可能性も出てきますし、近年の名前空間を取り入れる流れからするとあんまりよくないです。PHPであらかじめ定義されている定数も結構な数あるためちょっと使いにくい。

define('ECODE_NOT_FOUND', 100);
define('ECODE_BAD_REQUEST', 200);
//式や関数による定義も可能
define('NEXT_MONTH', date('n', mktime(0, 0, 0, date('n')+1, date('j'), date('Y'))));

if( !file_exists('C:\define.txt') ) {
    //通常の変数と同じように値の参照が可能
    echo 'エラーコード:' . ECODE_NOT_FOUND
    die();
}

PHP5ではオブジェクト指向の機能が本格的に強化されJavaのような要素もじゃんじゃん取り入れられています。
この記事を書いている現在はPHP5.3が主流かと思います。オブジェクト指向化の中でクラス定数というものも出てきました。位置付けとしてはクラスに属する定数です。クラス定数はクラスの中でconstキーワードを用いて定義します。こんな感じで使えます。

//クラス定数を定義する専用のクラスを作るのもあり
class CONFIG {
    const TOPPAGE_URL = 'http://https://sousaku-memo.net/';
    const DEBUG_MODE = true;
    //以下の定義はエラーが発生するので注意
    //配列や式(Expression)による柔軟な定義が出来ないのが痛い…
    //const FAILD_ARRAY_DEFINE = array(10,20,4);
}

//参照するときは::(ダブルコロン)演算子を用いる。
//クラス名の接頭辞が付くことにより名前空間を汚さないのはGood
echo sprintf('<a href="%s" target="_blank">創作メモ帳トップページ</a>', CONFIG::TOPPAGE_URL);

んー、どれもメリットデメリットがあります…
PHP6にはクラス定数の強化を望みます。

自分はどうしているかというと、クラス定数はやっぱり式による定義が出来ないのがつらいのでdefine関数で定義をしています。また、あちこちで定義すると分からなくなるのでまとめてコメント付きで定義しています。