PHP中的魔術方法和魔術常量簡介和使用

edithfang發表於2015-04-08
魔術方法(Magic methods)


PHP中把以兩個下劃線__開頭的方法稱為魔術方法,這些方法在PHP中充當了舉足輕重的作用。 魔術方法包括:

  • __construct(),類的建構函式
  • __destruct(),類的解構函式
  • __call(),在物件中呼叫一個不可訪問方法時呼叫
  • __callStatic(),用靜態方式中呼叫一個不可訪問方法時呼叫
  • __get(),獲得一個類的成員變數時呼叫
  • __set(),設定一個類的成員變數時呼叫
  • __isset(),當對不可訪問屬性呼叫isset()或empty()時呼叫
  • __unset(),當對不可訪問屬性呼叫unset()時被呼叫。
  • __sleep(),執行serialize()時,先會呼叫這個函式
  • __wakeup(),執行unserialize()時,先會呼叫這個函式
  • __toString(),類被當成字串時的回應方法
  • __invoke(),呼叫函式的方式呼叫一個物件時的回應方法
  • __set_state(),呼叫var_export()匯出類時,此靜態方法會被呼叫。
  • __clone(),當物件複製完成時呼叫

__construct()和__destruct()

建構函式和解構函式應該不陌生,他們在物件建立和消亡時被呼叫。例如我們需要開啟一個檔案,在物件建立時開啟,物件消亡時關閉

<?php 
class FileRead
{
    protected $handle = NULL;

    function __construct(){
        $this->handle = fopen(...);
    }

    function __destruct(){
        fclose($this->handle);
    }
}
?>


這兩個方法在繼承時可以擴充套件,例如:

<?php 
class TmpFileRead extends FileRead
{
    function __construct(){
        parent::__construct();
    }

    function __destruct(){
        parent::__destruct();
    }
}
?>

__call()和__callStatic()

在物件中呼叫一個不可訪問方法時會呼叫這兩個方法,後者為靜態方法。這兩個方法我們在可變方法(Variable functions)呼叫中可能會用到。

<?php
class MethodTest 
{
    public function __call ($name, $arguments) {
        echo "Calling object method '$name' ". implode(', ', $arguments). "\n";
    }

    public static function __callStatic ($name, $arguments) {
        echo "Calling static method '$name' ". implode(', ', $arguments). "\n";
    }
}

$obj = new MethodTest;
$obj->runTest('in object context');
MethodTest::runTest('in static context');
?>

__get(),__set(),__isset()和__unset()

當get/set一個類的成員變數時呼叫這兩個函式。例如我們將物件變數儲存在另外一個陣列中,而不是物件本身的成員變數

<?php 
class MethodTest
{
    private $data = array();

    public function __set($name, $value){
        $this->data[$name] = $value;
    }

    public function __get($name){
        if(array_key_exists($name, $this->data))
            return $this->data[$name];
        return NULL;
    }

    public function __isset($name){
        return isset($this->data[$name])
    }

    public function unset($name){
        unset($this->data[$name]);
    }
}
?>

__sleep()和__wakeup()

當我們在執行serialize()和unserialize()時,會先呼叫這兩個函式。例如我們在序列化一個物件時,這個物件有一個資料庫連結,想要在反序列化中恢復連結狀態,則可以通過重構這兩個函式來實現連結的恢復。例子如下:

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

物件當成字串時的回應方法。例如使用echo $obj;來輸出一個物件

<?php
// Declare a simple class
class TestClass
{
    public function __toString() {
        return 'this is a object';
    }
}

$class = new TestClass();
echo $class;
?>


這個方法只能返回字串,而且不可以在這個方法中丟擲異常,否則會出現致命錯誤。

__invoke()

呼叫函式的方式呼叫一個物件時的回應方法。如下

<?php
class CallableClass 
{
    function __invoke() {
        echo 'this is a object';
    }
}
$obj = new CallableClass;
var_dump(is_callable($obj));
?>

__set_state()

呼叫var_export()匯出類時,此靜態方法會被呼叫。

<?php
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';
var_dump(var_export($a));
?>

__clone()

當物件複製完成時呼叫。例如在設計模式詳解及PHP實現:單例模式一文中提到的單例模式實現方式,利用這個函式來防止物件被克隆。

<?php 
public class Singleton {
    private static $_instance = NULL;

    // 私有構造方法 
    private function __construct() {}

    public static function getInstance() {
        if (is_null(self::$_instance)) {
            self::$_instance = new Singleton();
        }
        return self::$_instance;
    }

    // 防止克隆例項
    public function __clone(){
        die('Clone is not allowed.' . E_USER_ERROR);
    }
}
?>

魔術常量(Magic constants)

PHP中的常量大部分都是不變的,但是有8個常量會隨著他們所在程式碼位置的變化而變化,這8個常量被稱為魔術常量。

  • __LINE__,檔案中的當前行號
  • __FILE__,檔案的完整路徑和檔名
  • __DIR__,檔案所在的目錄
  • __FUNCTION__,函式名稱
  • __CLASS__,類的名稱
  • __TRAIT__,Trait的名字
  • __METHOD__,類的方法名
  • __NAMESPACE__,當前名稱空間的名稱


這些魔術常量常常被用於獲得當前環境資訊或者記錄日誌。
評論(1)

相關文章