ＰＨＰマニュアル
前のページ	第 19章クラスとオブジェクト (PHP 5)	次のページ

マジックメソッド

以下の関数名 __construct, __destruct (コンストラクタとデストラクタ参照), __call, __get, __set, __isset, __unset (オーバーローディング参照), __sleep, __wakeup, __toString, __set_state, __clone および __autoload は、PHP クラスにおける特殊関数の名前です。これらの関数に関連する特別な機能を使用する場合を除き、クラス内にこれらの名前を有する関数を作成してはいけません。

注意

PHP は、__ で始まる関数名を特殊関数として予約しています。文書化された特殊な機能を必要とする場合を除き、 __ で始まる関数名を使用しないことが推奨されます。

`sleep` と `wakeup`

serialize() は、クラスに特殊な名前 __sleep の関数があるかどうかを調べます。もしあれば、シリアル化の前にその関数を実行します。この関数で、オブジェクトをクリアすることができます。またこの関数は、シリアル化するオブジェクトについて、すべての変数の名前を配列で返すことが前提となっています。このメソッドが何も返さなかった場合は、NULL がシリアル化され、E_NOTICE が発生します。

典型的な __sleep の使用法は、途中のデータをコミットしたり、似たようなタスクのクリアを行うといったものです。また、オブジェクトが非常に大きく、かつ、完全に保存する必要がない場合、この関数が有用です。

__sleep メソッドは、シリアル化する値 (通常は $this) を返さなければなりません。そうしないと、NULL がシリアル化されます。

逆に、unserialize() は、特殊な名前 __wakeup を有する関数の存在を調べます。もし存在する場合、この関数は、オブジェクトが有する可能性があるあらゆるリソースを再構築することができます。

意図される __wakeup の使用法は、シリアル化の際に失われたデータベース接続を再度確立したり、その他の再初期化を行うことです。

例 19-27. Sleep および wakeup


<?php
class Connection {
    protected $link;
    private $server, $username, $password, $db;
    
    public function __construct($server, $username, $password, $db)
    {
        $this->server = $server;
        $this->username = $username;
        $this->password = $password;
        $this->db = $db;
        $this->connect();
    }
    
    private function connect()
    {
        $this->link = mysql_connect($this->server, $this->username, $this->password);
        mysql_select_db($this->db, $this->link);
    }
    
    public function __sleep()
    {
        return array('server', 'username', 'password', 'db');
    }
    
    public function __wakeup()
    {
        $this->connect();
    }
}
?>

`__toString`

__toString メソッドにより、クラスが文字列に変換される際の動作を決めることができます。

例 19-28. 簡単な例


<?php
// 簡単なクラスを宣言
class TestClass
{
    public $foo;

    public function __construct($foo) {
        $this->foo = $foo;
    }

    public function __toString() {
        return $this->foo;
    }
}

$class = new TestClass('Hello');
echo $class;
?>

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

Hello

注意が必要なのは、PHP 5.2.0 より前では、 __toString メソッドは echo() または print(). と直接結合された場合のみコールされていたということです。

`__set_state`

この static メソッドは、 PHP 5.1.0 以降で var_export() によってエクスポートされたクラスのためにコールされます。

このメソッドの唯一のパラメータは、エクスポートされたプロパティを array('property' => value, ...) の形式で保持する配列です。

前のページ	ホーム	次のページ
パターン	上に戻る	finalキーワード

マジックメソッド

__sleep と __wakeup

__toString

__set_state

`sleep` と `wakeup`

`__toString`

`__set_state`