PHP教學-探討魔術方法(Magic methods)和魔術常數(magic constants) 用法和差異

魔術方法(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);
    }
}
?>

魔術常數

PHP 向它執行的任何scripts提供了大量的預定義常數。不過很多常數都是由不同的擴展庫定義的，只有在加載了這些擴展庫時才會出現，或者動態加載後，或者在編譯時已經包括進去了。

有八個魔術常數它們的值隨著它們在程式碼中的位置改變而改變。例如 __LINE__ 的值就依賴於它在scripts中所處的行來決定。這些特殊的常數不區分大小寫，如下：

幾個 PHP 的「魔術常數」 名稱     說明
__LINE__     文件中的當前行號。
__FILE__     文件的完整路徑和文件名。如果用在被包含文件中，則返回被包含的文件名。自 PHP 4.0.2 起，__FILE__ 總是包含一個絕對路徑（如果是符號連接，則是解析後的絕對路徑），而在此之前的版本有時會包含一個相對路徑。
__DIR__     文件所在的目錄。如果用在被包括文件中，則返回被包括的文件所在的目錄。它等價於 dirname(__FILE__)。除非是根目錄，否則目錄中名不包括末尾的斜槓。（PHP 5.3.0中新增） =
__FUNCTION__     函式名稱（PHP 4.3.0 新加）。自 PHP 5 起本常數返回該函式被定義時的名字（區分大小寫）。在 PHP 4 中該值總是小寫字母的。
__CLASS__     類的名稱（PHP 4.3.0 新加）。自 PHP 5 起本常數返回該類被定義時的名字（區分大小寫）。在 PHP 4 中該值總是小寫字母的。類名包括其被聲明的作用區域（例如 Foo\Bar）。注意自 PHP 5.4 起 __CLASS__ 對 trait 也起作用。當用在 trait 方法中時，__CLASS__ 是呼叫 trait 方法的類的名字。
__TRAIT__     Trait 的名字（PHP 5.4.0 新加）。自 PHP 5.4 起此常數返回 trait 被定義時的名字（區分大小寫）。Trait 名包括其被聲明的作用區域（例如 Foo\Bar）。
__METHOD__     類的方法名（PHP 5.0.0 新加）。返回該方法被定義時的名字（區分大小寫）。
__NAMESPACE__     當前命名空間的名稱（區分大小寫）。此常數是在編譯時定義的（PHP 5.3.0 新增）。

範例


<?php

    // Set namespace (works only with PHP 5.3)
    namespace TestProject;

    // This prints file full path and name
    echo "This file full path and file name is '" . __FILE__ . "'.\n";

    // This prints file full path, without file name
    echo "This file full path is '" . __DIR__ . "'.\n";

    // This prints current line number on file
    echo "This is line number " . __LINE__ . ".\n";

    // Really simple basic test function
    function test_function_magic_constant() {
        echo "This is from '" . __FUNCTION__ . "' function.\n";
    }

    // Prints function and used namespace
    test_function_magic_constant();

    // Really simple class for testing magic constants
    class TestMagicConstants {
        // Prints class name
        public function printClassName() {
            echo "This is " . __CLASS__ . " class.\n";
        }

        // Prints class and method name
        public function printMethodName() {
            echo "This is " . __METHOD__ . " method.\n";
        }

        // Prints function name
        public function printFunction() {
            echo "This is function '" . __FUNCTION__ . "' inside class.\n";
        }

        // Prints namespace name (works only with PHP 5.3)
        public function printNamespace() {
            echo "Namespace name is '" . __NAMESPACE__ . "'.\n";
        }
    }

    // Create new TestMagicConstants class
    $test_magic_constants = new TestMagicConstants;

    // This prints class name and used namespace
    $test_magic_constants->printClassName();

    // This prints method name and used namespace
    $test_magic_constants->printMethodName();

    // This prints function name inside class and used namespace
    // same as method name, but without class
    $test_magic_constants->printFunction();

    // This prints namespace name (works only with PHP 5.3)
    $test_magic_constants->printNamespace();

?>

結果輸出

This file full path and file name is '/tmp/magic_constants/magic.php'.
This file full path is '/tmp/magic_constants'.
This is line number 13.
This is from 'TestProject\test_function_magic_constant' function.
This is TestProject\TestMagicConstants class.
This is TestProject\TestMagicConstants::printMethodName method.
This is function 'printFunction' inside class.
Namespace name is 'TestProject'.