PHP マニュアル: オーバーロード

オーバーロード

PHP におけるオーバーロード機能は、プロパティやメソッドを動的に作成するための手法です。これらの動的エンティティは、マジックメソッドを用いて処理されます。マジックメソッドは、クラス内でさまざまなアクションに対して用意することができます。

オーバーロードメソッドが起動するのは、宣言されていないプロパティやメソッドを操作しようとしたときです。また、現在のスコープからはアクセス不能なプロパティやメソッドを操作しようとしたときにも起動します。このセクションでは、これらの (宣言されていない、あるいは現在のスコープからはアクセス不能な) プロパティやメソッドのことをアクセス不能プロパティおよびアクセス不能メソッドと表記することにします。

オーバーロードメソッドは、すべて public で定義しなければなりません。

注意:
これらのマジックメソッドの引数は、リファレンス渡しとすることはできません。

注意:
PHP におけるオーバーロードの解釈は、他の多くのオブジェクト指向言語とは異なります。一般的に「オーバーロード」とは、「名前は同じだけれども引数の数や型が異なるメソッドを複数用意できる」という機能のことを指します。

プロパティのオーバーロード

public void __set(string $name, mixed $value)

public mixed __get(string $name)

public bool __isset(string $name)

public void __unset(string $name)

__set() は、アクセス不能(protected または private)または存在しないプロパティへデータを書き込む際に実行されます。

__get() は、アクセス不能(protected または private)または存在しないプロパティからデータを読み込む際に使用します。

__isset() は、 isset あるいは empty をアクセス不能(protected または private)または存在しないプロパティに対して実行したときに起動します。

__unset() は、 unset をアクセス不能(protected または private)または存在しないプロパティに対して実行したときに起動します。

引数 $name は、操作しようとしたプロパティの名前です。 __set() メソッドの引数 $value は、 $name に設定しようとした値となります。

プロパティのオーバーロードはオブジェクトのコンテキストでのみ動作します。これらのマジックメソッドは、static メソッドとしては呼び出されません。したがって、これらのメソッドを static メソッドとして宣言してはいけません。マジックメソッドを static メソッドとして宣言すると警告が発生します。

注意:
__set() の戻り値は無視されます。これは、PHP が代入演算子を処理する方法によるものです。同様に __get() は、
 $a = $obj->b = 8; 
のように代入と連結した場合には決してコールされません。

注意:
PHP は、オーバーロードメソッドを、同じオーバーロードメソッドから決してコールしません。これはたとえば、__get() の内部に return $this->foo というコードを書いたとしても、 foo というプロパティが定義されていなければ E_WARNING が発生し、null を返すということです。 2回目の __get() のコールを行ったりはしません。しかし、オーバーロードメソッドが、他のオーバーロードメソッドを暗黙のうちに呼び出す可能性はあります(たとえば、 __set() が __get() を呼び出す場合)。

例1 __get()、 __set()、__isset() および __unset() メソッドを使ったプロパティのオーバーロードの例

<?php
class PropertyTest
{
    /**  オーバーロードされるデータの場所  */
    private $data = array();

    /**  宣言されているプロパティにはオーバーロードは起動しません */
    public $declared = 1;

    /**  クラスの外部からアクセスした場合にのみこれがオーバーロードされます  */
    private $hidden = 2;

    public function __set($name, $value)
    {
        echo "Setting '$name' to '$value'\n";
        $this->data[$name] = $value;
    }

    public function __get($name)
    {
        echo "Getting '$name'\n";
        if (array_key_exists($name, $this->data)) {
            return $this->data[$name];
        }

        $trace = debug_backtrace();
        trigger_error(
            'Undefined property via __get(): ' . $name .
            ' in ' . $trace[0]['file'] .
            ' on line ' . $trace[0]['line'],
            E_USER_NOTICE);
        return null;
    }

    public function __isset($name)
    {
        echo "Is '$name' set?\n";
        return isset($this->data[$name]);
    }

    public function __unset($name)
    {
        echo "Unsetting '$name'\n";
        unset($this->data[$name]);
    }

    /**  マジックメソッドではありません。単なる例として示しています  */
    public function getHidden()
    {
        return $this->hidden;
    }
}


echo "<pre>\n";

$obj = new PropertyTest;

$obj->a = 1;
echo $obj->a . "\n\n";

var_dump(isset($obj->a));
unset($obj->a);
var_dump(isset($obj->a));
echo "\n";

echo $obj->declared . "\n\n";

echo "Let's experiment with the private property named 'hidden':\n";
echo "Privates are visible inside the class, so __get() not used...\n";
echo $obj->getHidden() . "\n";
echo "Privates not visible outside of class, so __get() is used...\n";
echo $obj->hidden . "\n";
?>

上の例の出力は以下となります。

Setting 'a' to '1'
Getting 'a'
1

Is 'a' set?
bool(true)
Unsetting 'a'
Is 'a' set?
bool(false)

1

Let's experiment with the private property named 'hidden':
Privates are visible inside the class, so __get() not used...
2
Privates not visible outside of class, so __get() is used...
Getting 'hidden'


Notice:  Undefined property via __get(): hidden in <file> on line 70 in <file> on line 29

メソッドのオーバーロード

public mixed __call(string $name, array $arguments)

public static mixed __callStatic(string $name, array $arguments)

__call() は、アクセス不能メソッドをオブジェクトのコンテキストで実行したときに起動します。

__callStatic() は、アクセス不能メソッドをstatic メソッドとして呼び出した場合に起動します。

引数 $name は、コールしようとしたメソッドの名前です。引数 $arguments は配列で、メソッド $name に渡そうとしたパラメータが格納されます。

例2 __call() および __callStatic() メソッドによる、メソッドのオーバーロードの例

<?php
class MethodTest
{
    public function __call($name, $arguments)
    {
        // 注意: $name は大文字小文字を区別します
        echo "Calling object method '$name' "
             . implode(', ', $arguments). "\n";
    }

    public static function __callStatic($name, $arguments)
    {
        // 注意: $name は大文字小文字を区別します
        echo "Calling static method '$name' "
             . implode(', ', $arguments). "\n";
    }
}

$obj = new MethodTest;
$obj->runTest('in object context');

MethodTest::runTest('in static context');
?>

上の例の出力は以下となります。

Calling object method 'runTest' in object context
Calling static method 'runTest' in static context