[技術分享] 說說PHP的魔術方法及其應用

 作者:新投云  發布于:2017-07-07  瀏覽數:
說說PHP的魔術方法及其應用

PHP中將所有__(兩個下劃線)開頭的類方法作為魔術方法,這方法之所以稱為魔術方法是因為其實現的功能就如變魔術一樣感覺很神奇。在特定的事件下觸發,這真的很酷。

__construct()#

這個方法應該是最常用的,被稱為構造器或者構造方法,當一個對象被實例化時會被首先調用,而在 PHP 框架中一些過濾器,中間件及依賴注入也一般在這個方法中完成。父類的構造器可以被子類繼承和重寫。

<?php
class A {

    public function __construct() {
        echo "This is A construct\n";
    }
}

class B extends A{

    // 調用父類構造方法,再調用自己的構造方法
    public function __construct() {
        parent::__construct();
        echo "This is B construct\n";
    }
}

class C extends A{

    // 重寫構造方法,之調用自己的構造方法
    public function __construct() {
        echo "This is C construct";
    }
}

new A();// This is A construct
new B();// This is A construct This is B construct
new C();// This is c construct

以上示例代碼將按順序輸出:

This is A construct
This is A construct
This is B construct
This is C construct

構造方法能幫助我們完成一些數據初始化,屬性初始化的任務,在實例化類后使得調用類更便利。

__destruct()#

析構方法,PHP 將對象銷毀前將調用這個方法,這個方法可能對于 PHP 這種運行時間短的腳本可能無意義,但在有些情況下還是具有意義的。

比如你需要一個長時間運行的腳本,設置 set_time_limit(0); 后需要不斷執行這個腳本,一般這樣的腳本是循環執行一些任務,這其中可能會涉及到頻繁的創建某個對象,這時候析構方法就會起到作用,它可以將對象打開的一些資源及時的釋放,以防止內存溢出或單個進程占用過多內存。

<?php

class Log{

  public function __construct() {
    $this->created = time();
    $this->logfile_handle = fopen('/tmp/log.txt', 'w');
  }

  public function __destruct() {
    fclose($this->logfile_handle);
  }
}

__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;
    }

}

class Penguin extends Animal {

  public function __construct($id) {
    $this->getPenguinFromDb($id);
  }

  public function getPenguinFromDb($id) {
    // elegant and robust database code goes here
  }

  public function __get($field) {
    if($field == 'name') {
        return $this->username;
    }
  }

  public function __set($field, $value) {
     if($field == 'name') {
        $this->username = $value;
     }
  }

}

在 MethodTest 這個類中使用 get 和 set 將所有不存在的屬性都保存在類的 data 屬性中,而在Penguin 類中我們連接了數據庫或者是數據提供者,由于某些原因數據源中原來的 name 變更為 username ,如果這時要檢查所有調用 Penguin 類的地方將 name 換成 username 顯然是困難而且無趣的甚至會有忽略的地方,而使用一個 __get 方法我們不用改變外部調用的屬性名就可以實現從 name 轉變為 username

__call 和 __callStatic#

call 和 callStatic 是類似的方法,前者是調用類不存在的方法時執行,而后者是調用類不存在的靜態方式方法時執行。正常情況下如果調用一個類不存在的方法 PHP 會拋出致命錯誤,而使用這兩個魔術方法我們可以替換一些更友好的提示或者記錄錯誤調用日志信息、將用戶重定向、拋出異常等等,亦或者是如同set 和 get 那樣做方法的重命名。

class A
{

    public static function __callStatic($name, $arguments)
    {   
        var_dump($name);
        var_dump($arguments);
        echo 'unknown static method ' . $name;
    }

    function __call($name, $arguments)
    {
        var_dump($name);
        var_dump($arguments);
        echo 'unknown method ' . $name;
    }
}

$a = new A();
$a->agfdgdrsfgdf([123,3213]);
A::sdfsd();

__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();
    }
}

__clone()#

如同名字一樣,這個方法在對象被復制是調用,如我們要實現一個單例模式,我們可以用這個魔術方法防止對象被克隆。

<?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);
    }
}

__toString()#

當對象被當做字符串是調用此方法。

PHP 5.2.0 之前,toString() 方法只有在直接使用于 echo 或 print 時才能生效。PHP 5.2.0 之后,則可以在任何字符串環境生效(例如通過 printf(),使用 %s 修飾符),但不能用于非字符串環境(如使用 %d 修飾符)。自 PHP 5.2.0 起,如果將一個未定義 toString() 方法的對象轉換為字符串,會產生 E_RECOVERABLE_ERROR 級別的錯誤。

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

class Penguin {

  public function __construct($name) {
      $this->species = 'Penguin';
      $this->name = $name;
  }

  public function __toString() {
      return $this->name . " (" . $this->species . ")\n";
  }
}

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

$tux = new Penguin('tux');
echo $tux;

在 TestClass 的調用中我們輸出了一個友好的提示,而在 Penguin 我們將對象的屬性組合后輸出,比如在模板中調用。

__invoke()#

當嘗試用函數的方式調用一個對象是觸發此方法。

PHP 5.3.0 添加

<?php
class CallableClass 
{
    function __invoke($x) {
        var_dump($x);
    }
}
$obj = new CallableClass;
$obj(5); // int(5)
var_dump(is_callable($obj)) // bool(true)

__set_state()#

調用 var_export() 導出類時,此魔術方法被調用。

PHP 5.1.0 添加

<?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));

__debuginfo()#

這個方法在對對象使用 var_dump() 時調用。

PHP 5.6.0 添加

<?php
class C {
    private $prop;

    public function __construct($val) {
        $this->prop = $val;
    }

    public function __debugInfo() {
        return [
            'propSquared' => $this->prop ** 2,
        ];
    }
}

var_dump(new C(42));
/*
object(C)#1 (1) {
  ["propSquared"]=>
  int(1764)
}
*/

相關文章

三期必中一期平特肖