PHPのマジックメソッド徹底解説｜主要メソッドの役割と使い方まとめ

はじめに

PHPのマジックメソッド(Magic Methods)とは、特定の状況で自動的に実行される特殊なメソッドのことです。すべてのマジックメソッドは、接頭辞として二重アンダースコア(__)が付いた名前を持っています。

これらのメソッド名はPHPによって予約されており、マジックメソッドとしての機能以外の用途には使用できません。また、クラス内で宣言する場合は必ずpublicとして定義する必要があります。マジックメソッドはいわば「インターセプター(横取り機)」のような働きをし、特定の条件が満たされたときに自動的に呼び出されます。

本記事では、現在PHPで利用可能な主なマジックメソッドをカテゴリ別にわかりやすく解説します。

シリアライズ関連のマジックメソッド

__sleep

public __sleep ( void ) : array

serialize()は、クラス内に__sleep()という名前の関数が存在するかどうかをチェックします。存在する場合、シリアル化が行われる前にこの関数が実行されます。__sleep()は、シリアル化対象となるオブジェクトの変数名を格納した配列を返すことが求められます。

__wakeup

public __wakeup ( void ) : void

unserialize()は、__wakeup()というマジック名を持つ関数が存在するかをチェックします。存在する場合、この関数を使ってオブジェクトが保持していたリソース(データベース接続など)を再構築できます。

__serialize

public __serialize ( void ) : array

serialize()は、クラスに__serialize()メソッドが定義されているかどうかも確認します。定義されている場合は、シリアル化の前にこのメソッドが実行され、オブジェクトのシリアル化形式を表すキー/値ペアの連想配列を構築して返す必要があります。

__unserialize

public __unserialize ( array $data ) : void

unserialize()も同様に__unserialize()の有無をチェックします。存在する場合、__serialize()が返した復元済みの配列が引数として渡されるため、その配列をもとにオブジェクトのプロパティを適切に復元できます。

文字列化・呼び出し関連のマジックメソッド

__toString

public __toString ( void ) : string

__toString()は、オブジェクトを文字列として扱うときの表現を定義します。たとえば、echo $obj;を実行したときに出力される内容を決定します。このメソッドは必ず文字列を返さなければなりません。

__invoke

__invoke ([ $... ] ) : mixed

__invoke()は、スクリプト内でオブジェクトを関数のように呼び出そうとしたときに実行されます。

デバッグ・エクスポート関連のマジックメソッド

__set_state

static __set_state ( array $properties ) : object

__set_state()は、var_export()によってエクスポートされたクラスに対して呼び出される静的(static)メソッドです。引数には、array('property' => value, ...)の形式でエクスポートされたプロパティを格納した配列が1つ渡されます。

__debugInfo

__debugInfo ( void ) : array

var_dump()でオブジェクトをダンプする際、表示すべきプロパティを取得するために__debugInfo()が自動的に呼び出されます。このメソッドが定義されていない場合は、すべてのpublic・protected・privateプロパティが表示されます。

プロパティオーバーロード関連のマジックメソッド

__set

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

__set()は、アクセスできない(protectedまたはprivate)、あるいは存在しないプロパティへデータを書き込もうとしたときに実行されます。

__get

public __get ( string $name ) : mixed

__get()は、アクセスできない(protectedまたはprivate)、あるいは存在しないプロパティからデータを読み取ろうとしたときに利用されます。

__isset

public __isset ( string $name ) : bool

__isset()は、アクセスできない(protectedまたはprivate)、あるいは存在しないプロパティに対してisset()やempty()が呼び出されたときにトリガーされます。

__unset

public __unset ( string $name ) : void

__unset()は、アクセスできない(protectedまたはprivate)、あるいは存在しないプロパティに対してunset()が使用されたときに呼び出されます。

まとめ

マジックメソッドを活用することで、シリアライズ処理の制御、オブジェクトの文字列化、プロパティへの柔軟なアクセスなど、クラスの振る舞いを細かくカスタマイズできます。ただし、乱用するとコードの可読性や予測可能性が下がるため、必要な場面で適切に使うことが重要です。