php魔術方法

__construct()，__destruct()，__call()，__callStatic()，__get()，__set()，__isset()，__unset()，__sleep()，__wakeup()，__toString()，__invoke()，__set_state()和 __clone() 等方法在 PHP 中被稱為"魔術方法"（Magic methods）。在命名自己的類方法時不能使用這些方法名，除非是想使用其魔術功能。

PHP 將所有以 __（兩個底線）開頭的類方法保留為魔術方法。所以在定義類方法時，除了上述魔術方法，建議不要以 __ 為首碼。

__sleep() 和 __wakeup()

publicarray__sleep ( void )

void__wakeup ( void )

serialize( ) 函數會檢查類中是否存在一個魔術方法 __sleep( )。如果存在，該方法會先被調用，然後才執行序列化操作。此功能可以用於清理對象，並返回一個包含對象中所有應被序列化的變數名稱的數組。如果該方法未返回任何內容，則 NULL 被序列化，併產生一個 E_NOTICE 層級的錯誤。

注意:

__sleep() 不能返回父類的私人成員的名字。這樣做會產生一個 E_NOTICE 層級的錯誤。可以用 Serializable 介面來替代。

__sleep() 方法常用於提交未提交的資料，或類似的清理操作。同時，如果有一些很大的對象，但不需要全部儲存，這個功能就很好用。

與之相反， unserialize() 會檢查是否存在一個 __wakeup() 方法。如果存在，則會先調用 __wakeup 方法，預先準備對象需要的資源。

__wakeup() 經常用在還原序列化操作中，例如重建立立資料庫連接，或執行其它初始化操作。

Example #1 Sleep 和 wakeup

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()

public string __toString ( void )

__toString() 方法用於一個類被當成字串時應怎樣回應。例如 echo $obj; 應該顯示些什麼。此方法必須返回一個字串，否則將發出一條 E_RECOVERABLE_ERROR 層級的致命錯誤。

不能在 __toString() 方法中拋出異常，這麼做會導致致命錯誤。

Example #2 簡單樣本

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 時才會生效。PHP 5.2.0 之後，則可以在任何字串環境生效（例如通過 printf()，使用 %s 修飾符），但不能用於非字串環境（如使用 %d 修飾符）。自 PHP 5.2.0 起，如果將一個未定義 __toString() 方法的對象轉換為字串，會產生 E_RECOVERABLE_ERROR 層級的錯誤。

__invoke()

mixed__invoke ([ $... ] )

當嘗試以調用函數的方式調用一個對象時，__invoke() 方法會被自動調用。

注意:

本特性只在 PHP 5.3.0 及以上版本有效。

Example #3 使用 __invoke()

class CallableClass{    function __invoke($x){        var_dump($x);    }}$obj = new CallableClass;$obj(5);var_dump(is_callable($obj));

輸出結果：

int(5)

bool(true)

__set_state()

static object __set_state ( array $properties )

自 PHP 5.1.0 起當調用 var_export() 匯出類時，此靜態方法會被調用。

本方法的唯一參數是一個數組，其中包含按 array('property' => value, ...) 格式排列的類屬性。

Example #4 使用 __set_state()>（PHP 5.1.0 起）

class A{    public $var1;    public $var2;    public static function __set_state($an_array)    {        $obj = new A;        $obj -> var1 = $an_array['var1'];        $obj -> var2 = $an_array['var2'];        return $obj;    }}$a = new A;$a->var1 = 5;$a->var2 = 'foo';eval('$b='.var_export($a,true).';');var_dump($b);

輸出結果：

object(A)#2 (2) { ["var1"]=> int(5) ["var2"]=> string(3) "foo" }

