概述
在面向對象編程中,PHP提供了一系列的魔術方法,這些魔術方法為編程提供了很多便利。PHP中的魔術方法通常以__(兩個下劃線)開始,並且不需要顯示的調用而是由某種特定的條件出發。這篇文章簡單總結了PHP中提供的魔術方法。
開始之前
在總結PHP的魔術方法之前先來定義兩個類,以便後邊示例使用:
復制代碼 代碼如下:
<?php
class 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()函數。