| ユーザフォーラムで議論/質問 | マニュアル検索 | ハイライト | ハイライトオフ | ポータル | php spot |
マジックメソッド以下の関数名 __construct(), __destruct(), __call(), __callStatic(), __get(), __set(), __isset(), __unset(), __sleep(), __wakeup(), __toString(), __invoke(), __set_state(), __clone() および __debugInfo() は、PHP クラスにおける特殊関数の名前です。 これらの関数に関連する特別な機能を使用する場合を除き、 クラス内にこれらの名前を有する関数を作成してはいけません。 警告
PHP は、__ で始まる関数名を特殊関数として予約しています。 文書化された特殊な機能を必要とする場合を除き、 __ で始まる関数名を使用しないことが推奨されます。 __sleep() と __wakeup()
public array __sleep
( void
)
void __wakeup
( void
)
serialize() は、クラスに特殊な名前
__sleep() の関数があるかどうかを調べます。
もしあれば、シリアル化の前にその関数を実行します。
この関数で、オブジェクトをクリアすることができます。
またこの関数は、シリアル化するオブジェクトについて、
すべての変数の名前を配列で返すことが前提となっています。
このメソッドが何も返さなかった場合は、
典型的な __sleep() の使用法は、 途中のデータをコミットしたり、 似たようなタスクのクリアを行うといったものです。 また、オブジェクトが非常に大きく、かつ、完全に保存する必要がない場合、 この関数が有用です。 逆に、unserialize() は、 特殊な名前 __wakeup() を有する 関数の存在を調べます。 もし存在する場合、この関数は、オブジェクトが有する可能性が あるあらゆるリソースを再構築することができます。 意図される __wakeup() の使用法は、 シリアル化の際に失われたデータベース接続を再度確立したり、 その他の再初期化を行うことです。 例1 sleep および wakeup
<?php __toString()
public string __toString
( void
)
__toString() メソッドにより、
クラスが文字列に変換される際の動作を決めることができます。たとえば
echo $obj; としたときに何を表示させるかといったことです。
このメソッドは文字列を返さなければなりません。それ以外の場合は
警告
__toString() メソッド内から例外を投げることはできません。そうした場合、致命的なエラーが発生します。 例2 簡単な例
<?php 上の例の出力は以下となります。 Hello
注意が必要なのは、PHP 5.2.0 より前では、
__toString() メソッドは
echo または print
と直接結合された場合のみコールされていたということです。
PHP 5.2.0 以降では、これはすべての文字列コンテキスト
(たとえば printf() における %s 修飾子)
でコールされます。しかし、その他の型のコンテキスト
(たとえば %d 修飾子) ではコールされません。
PHP 5.2.0 以降では、__toString()
メソッドを持っていないオブジェクトを文字列に変換しようとすると
__invoke()__invoke() メソッドは、 スクリプトがオブジェクトを関数としてコールしようとした際にコールされます。
例3 __invoke() の使用
<?php 上の例の出力は以下となります。 int(5) bool(true) __set_state()
static object __set_state
( array
$properties
)この static メソッドは、 PHP 5.1.0 以降で var_export() によって エクスポートされたクラスのためにコールされます。 このメソッドの唯一のパラメータは、エクスポートされたプロパティを array('property' => value, ...) の形式で保持する配列です。 例4 __set_state() の使用法 (PHP 5.1.0 以降)
<?php 上の例の出力は以下となります。 object(A)#2 (2) { ["var1"]=> int(5) ["var2"]=> string(3) "foo" }
__debugInfo()
array __debugInfo
( void
)
このメソッドは、var_dump() がオブジェクトをダンプするときに、 プロパティの情報を取得するために呼ばれます。 もしオブジェクトにこのメソッドが定義されていなければ、 すべての public, protected, private プロパティを表示します。 この機能は PHP 5.6.0 で追加されました。 例5 __debugInfo() の使用法
<?php 上の例の出力は以下となります。 object(C)#1 (1) { ["propSquared"]=> int(1764) } |
![]() |
各種マニュアル:
PHPマニュアル |
PEARマニュアル |
Smarty(英語)マニュアル |
PHP-GTKマニュアル |
「マジックメソッド」をGoogle検索
|