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

# マジックメソッド

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

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

## __sleep と __wakeup

serialize() checks if your class has a function with the magic name __sleep. If so, that function is being run prior to any serialization. It can clean up the object and is supposed to return an array with the names of all variables of that object that should be serialized.

The intended use of __sleep is to close any database connections that object may have, committing pending data or perform similar cleanup tasks. Also, the function is useful if you have very large objects which need not be saved completely.

Conversely, unserialize() checks for the presence of a function with the magic name __wakeup. If present, this function can reconstruct any resources that object may have.

The intended use of __wakeup is to reestablish any database connections that may have been lost during serialization and perform other reinitialization tasks.

## __toString

The __toString method allows a class to decide how it will react when it is converted to a string.

例 19-23. 簡単な例

`<?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

It is worth noting that the __toString method will only be called when it is directly combined with echo() or print().

例 19-24. Cases where __toString is called

`<?php // __toString called echo $class; // __toString called (still a normal parameter for echo) echo 'text', $class; // __toString not called (concatenation operator used first) echo 'text' . $class; // __toString not called (casted to string first) echo (string) $class; ?>`

前のページ | ホーム | 次のページ
オブジェクトのイタレーション | 上に戻る | finalキーワード