php常見魔術方法功能功能用法總結

概述

在物件導向編程中，PHP提供了一系列的魔術方法，這些魔術方法為編程提供了很多便利。PHP中的魔術方法通常以(兩個底線)開始，並且不需要顯示的調用而是由某種特定的條件出發。這篇文章簡單總結了PHP中提供的魔術方法。

開始之前

在總結PHP的魔術方法之前先來定義兩個類，以便後邊樣本使用：

代碼如下:

<?phpclass Device {    public $name;               public $battery;            public $data = array();     public $connection;          protected function connect() {        $this->connection = 'resource';        echo $this->name . ' connected' . PHP_EOL;    }     protected function disconnect() {        $this->connection = null;        echo $this->name . ' disconnected' . PHP_EOL;    }} class Battery {    private $charge = 0;     public function setCharge($charge) {        $charge = (int)$charge;        if($charge < 0) {            $charge = 0;        }        elseif($charge > 100) {            $charge = 100;        }        $this->charge = $charge;    }}?>

Device類有四個成員屬性和兩個成員方法。Battery類有一個成員屬性和一個成員方法。

建構函式和解構函式

建構函式和解構函式分別在對象建立和銷毀時被調用。對象被“銷毀”是指不存在任何對該對象的引用，比如引用該對象的變數被刪除(unset)、重新賦值或指令碼執行結束，都會調用解構函式。

construct()

construct()建構函式是目前為止最經常使用的函數。在建立對象時，可以在建構函式中做一些初始化工作。可以為建構函式定義任意多個參數，只要在執行個體化時傳入對應個數的參數即可。建構函式中出現的任何異常都會阻止對象的建立。

代碼如下:

class Device {   public function  construct(Battery $battery, $name) {       $this->battery = $battery;       $this->name = $name;       $this->connect();    }}

上面的範例程式碼中，Device類的建構函式為成員屬性賦值並且調用了connect()方法。

將建構函式聲明為私人方法，可以防止在類外部建立對象，這在單利模式中經常使用。

desctruct()

解構函式通常在對象被銷毀時調用，解構函式不接收任何參數。經常在解構函式中執行一些清理工作，比如關閉資料庫連接等。

屬性重載(Property Overloading)

有一點需要注意的是：PHP中的”重載”與其他大多數語言的重載不是太一樣，雖然都實現了相同的功能。
屬性重載涉及到的兩個魔術方法主要是用來處理屬性訪問，定義了當我們嘗試訪問一個不存在(或不可訪問)的屬性時會發生什麼。

get()

魔術方法get()在我們嘗試訪問一個不存在的屬性時會被調用。它接收一個參數，該參數表示訪問屬性的名字，並且將該屬性的值返回。在上面的Device類裡，有一個data屬性，該屬性就在這裡就起了作用，如下面得代碼：

代碼如下:

class Device {    public function  get($name) {         if(array_key_exists($name, $this->data)) {            return $this->data[$name];        }        return null;    }}

該魔術方法最常用的地方就是通過建立一個“唯讀”的屬性來擴充存取控制。在上面的Battery類中，有一個私人屬性$charge，我們可以通過get()魔術方法將該屬性擴充為在類外部可讀但不能修改。代碼如下：

代碼如下:

class Battery {    private $charge = 0;     public function  get($name) {        if(isset($this->$name)) {            return $this->$name;        }        return null;    }}

set()

set()魔術方法在我們嘗試修改一個不可訪問的屬性時會被調用，它接收兩個參數，一個表示屬性的名字，一個表示屬性的值。範例程式碼如下：

代碼如下:

class Device {    public function  set($name, $value) {        // use the property name as the array key        $this->data[$name] = $value;    }}

isset()

isset()魔術方法在對一個不可訪問的屬性調用isset()方法時會被調用，它接收一個參數，表示屬性的名字。它應該返回一個布爾值，用來表示該屬性是否存在。代碼如下：

代碼如下:

class Device {    public function  isset($name) {        return array_key_exists($name, $this->data);    }}

unset()

unset()魔術方法在調用unset()函數銷毀一個不能訪問的屬性時會被調用，它接收一個參數，表述屬性的名字。

對象轉換為字串

有時候我們需要將對象以字串的形式表現出來。如果我們直接列印一個對象，那麼程式將會輸出一個錯誤資訊：PHP Catchable fatal error: Object of class Device could not be converted to string

toString()

toString()在我們將對象當作字串一樣使用時會被調用，它不接收任何參數。該方法允許我們定義對象的表現形式。代碼如下：

代碼如下:

class Device {    public function  toString() {       $connected = (isset($this->connection)) ? 'connected' : 'disconnected';       $count = count($this->data);       return $this->name . ' is ' . $connected . ' with ' . $count . ' items in memory' . PHP_EOL;    }    ...}

set_state()(PHP 5.1)

靜態魔術方法set_state()，在我們使用var_export()函數輸出對象時會調用該方法。var_export()函數用來將PHP變數轉換為PHP代碼，它接收一個包含對象屬性值的關聯陣列作為參數。範例程式碼如下：

代碼如下:

class Battery {    //...    public static function  set_state(array $array) {        $obj = new self();        $obj->setCharge($array['charge']);        return $obj;    }    //...}

複製對象

預設的，對象都是按引用傳值的。因此，在將一個對象賦值給另一個變數時，只是建立了指向該對象的一個引用，並沒有複製該對象。為了實現真正得複製一個對象，我們需要使用clone關鍵字。
這種“按引用傳遞”的策略同樣適用於包含在對象內部的對象。即使我們複製了一個對象，在對象內部的任何對象都不會被複製，因此最終的結果是兩個對象共用了同一個內部對象。範例程式碼如下：

$device = new Device(new Battery(), 'iMagic');$device2 = clone $device; $device->battery->setCharge(65);echo $device2->battery->charge;// 65

clone()

clone()魔術方法clone()可以解決上面的問題。當對一個對象使用clone關鍵字時，該魔術方法會被調用。在這個魔術方法裡，我們可以實現任何子物件的複製，代碼如下：

代碼如下:

class Device {    ...    public function  clone() {        // copy our Battery object        $this->battery = clone $this->battery;    }    ...}

對象序列化

序列化是講任意資料轉換為字串格式的過程。序列化通常用來將整個對象存入資料庫或寫入檔案中。當還原序列化儲存的資料時，我們可以得到序列化之前的對象。但是，並不是所有得資料都可以被序列化，比如資料庫連接。幸運的是，有一個魔術方法可以幫我們解決這個問題。

sleep()

魔術方法sleep()在對一個對象序列化時(調用serialize())會被調用。它不接收任何參數，而且應該返回一個包含所有應該被序列化的屬性的數組。在該魔術方法中，也可以執行一些其他動作。
有一點要注意的是，不要再該函數中進行任何的析構操作，因為這可能會影響正在啟動並執行對象。

範例程式碼如下：

class Device {    public $name;               public $battery;           public $data = array();    public $connection;        //...    public function  sleep() {        return array('name', 'battery', 'data');    }    //...}

wakeup()

魔術方法wakeup()在對儲存的對象還原序列化時會被調用。它不接收任何參數，也沒有任何傳回值。可以用它來處理在序列化時丟失的資料庫連接或資源。代碼如下：

代碼如下:

class Device {    //...    public function  wakeup() {        // reconnect to the network        $this->connect();    }    //...}

方法重載

PHP還有兩個與成員方法相關的魔術方法call()和callStatic()，這兩個魔術方法類似於屬性重載方法。

call()

魔術方法call()在調用不存在或不可訪問的方法時會被調用。它接收兩個參數，一個是調用的方法的名字，一個是包含函數參數的數組。我們可以使用這種方法調用子物件中得同名函數。

在這個例子中，要注意函數call_user_func_array()，這個函數允許我們動態調用一個命名的函數。

範例程式碼如下:

class Device {    //...    public function  call($name, $arguments) {        // make sure our child object has this method        if(method_exists($this->connection, $name)) {            // forward the call to our child object            return call_user_func_array(array($this->connection, $name), $arguments);        }        return null;    }    //...}

callStatic()

魔術方法callStatic()與call()的功能一樣，唯一不同的是，該方法在嘗試訪問一個不存在或不可訪問的靜態方法時會被調用。範例程式碼如下：

class Device {    //...    public static function  callStatic($name, $arguments) {        // make sure our class has this method        if(method_exists('Connection', $name)) {            // forward the static call to our class            return call_user_func_array(array('Connection', $name), $arguments);        }        return null;    }    //...}

將對象作為函數

有時候我們會需要將對象作為函數使用。將對象作為函數使用，就像我們使用其他普通的函數一樣，可以傳參。

invoke()(PHP 5.3)

魔術方法invoke()在嘗試將對象作為函數使用時會被調用。在該方法中定義的任何參數，都將被作為函數的參數。範例程式碼如下：

class Device {    //...    public function invoke($data) {        echo $data;    }    //...}$device = new Device(new Battery(), 'iMagic');$device('test');// equiv to $device->invoke('test')// Outputs: test

其他:autoload()

autoload()方法並不是一個魔術方法，但是這個方法非常有用。但是，對著PHP版本的更新，該函數已經不建議使用，取而代之的是spl_auto_register()函數。