魔術(shù)方法

魔術(shù)方法是一種特殊的方法，當(dāng)對(duì)對(duì)象執(zhí)行某些操作時(shí)會(huì)覆蓋 PHP 的默認(rèn)操作。

警告

PHP 保留所有以 __ 開頭的方法名稱。因此，除非覆蓋 PHP 的行為，否則不建議使用此類方法名稱。

下列方法名被認(rèn)為是魔術(shù)方法： __construct() 、 __destruct() 、 __call() 、 __callStatic() 、 __get() 、 __set() 、 __isset() 、 __unset() 、 __sleep() 、 __wakeup() 、 __serialize() 、 __unserialize() 、 __toString() 、 __invoke() 、 __set_state() 、 __clone() 、 __debugInfo() 。

警告

除了 __construct()， __destruct() ，和 __clone() 之外的所有魔術(shù)方法都必須聲明為 public，否則會(huì)發(fā)出 E_WARNING。在 PHP 8.0.0 之前沒有為魔術(shù)方法 __sleep() 、 __wakeup() 、 __serialize() 、 __unserialize() 、 __set_state() 發(fā)出診斷信息。

警告

如果定義魔術(shù)方法時(shí)使用類型聲明，它們必須與本文檔中描述的簽名相同，否則會(huì)發(fā)出致命錯(cuò)誤。在 PHP 8.0.0 之前，不會(huì)發(fā)出診斷信息。然而， __construct() 和 __destruct() 不能聲明返回類型，否則會(huì)發(fā)出致命錯(cuò)誤。

sleep() 和 wakeup()

public __sleep(): array

public __wakeup(): void

serialize() 函數(shù)會(huì)檢查類中是否存在一個(gè)魔術(shù)方法 __sleep()。如果存在，該方法會(huì)先被調(diào)用，然后才執(zhí)行序列化操作。此功能可以用于清理對(duì)象，并返回一個(gè)包含對(duì)象中所有應(yīng)被序列化的變量名稱的數(shù)組。如果該方法未返回任何內(nèi)容，則 null 被序列化，并產(chǎn)生一個(gè) E_NOTICE 級(jí)別的錯(cuò)誤。

注意:
__sleep() 不能返回父類的私有成員的名字。這樣做會(huì)產(chǎn)生一個(gè) E_NOTICE 級(jí)別的錯(cuò)誤。使用 __serialize() 接口替代。

__sleep() 方法常用于提交未提交的數(shù)據(jù)，或類似的清理操作。同時(shí)，如果有一些很大的對(duì)象，但不需要全部保存，這個(gè)功能就很好用。

與之相反，unserialize() 會(huì)檢查是否存在一個(gè) __wakeup() 方法。如果存在，則會(huì)先調(diào)用 __wakeup 方法，預(yù)先準(zhǔn)備對(duì)象需要的資源。

__wakeup() 經(jīng)常用在反序列化操作中，例如重新建立數(shù)據(jù)庫(kù)連接，或執(zhí)行其它初始化操作。

示例 #1 Sleep 和 wakeup


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

serialize() 和 unserialize()

public __serialize(): array

public __unserialize(array $data): void

serialize() 函數(shù)會(huì)檢查類中是否存在一個(gè)魔術(shù)方法 __serialize() 。如果存在，該方法將在任何序列化之前優(yōu)先執(zhí)行。它必須以一個(gè)代表對(duì)象序列化形式的鍵/值成對(duì)的關(guān)聯(lián)數(shù)組形式來返回，如果沒有返回?cái)?shù)組，將會(huì)拋出一個(gè) TypeError 錯(cuò)誤。

注意:
如果類中同時(shí)定義了 __serialize() 和 __sleep() 兩個(gè)魔術(shù)方法，則只有 __serialize() 方法會(huì)被調(diào)用。 __sleep() 方法會(huì)被忽略掉。如果對(duì)象實(shí)現(xiàn)了 Serializable 接口，接口的 serialize() 方法會(huì)被忽略，做為代替類中的 __serialize() 方法會(huì)被調(diào)用。

__serialize() 的預(yù)期用途是定義對(duì)象序列化友好的任意表示。數(shù)組的元素可能對(duì)應(yīng)對(duì)象的屬性，但是這并不是必須的。

相反， unserialize() 檢查是否存在具有名為 __unserialize() 的魔術(shù)方法。此函數(shù)將會(huì)傳遞從 __serialize() 返回的恢復(fù)數(shù)組。然后它可以根據(jù)需要從該數(shù)組中恢復(fù)對(duì)象的屬性。

注意:
如果類中同時(shí)定義了 __unserialize() 和 __wakeup() 兩個(gè)魔術(shù)方法，則只有 __unserialize() 方法會(huì)生效，__wakeup() 方法會(huì)被忽略。

注意:
此特性自 PHP 7.4.0 起可用。

示例 #2 序列化和反序列化


<?php
class Connection
{
    protected $link;
    private $dsn, $username, $password;

    public function __construct($dsn, $username, $password)
    {
        $this->dsn = $dsn;
        $this->username = $username;
        $this->password = $password;
        $this->connect();
    }

    private function connect()
    {
        $this->link = new PDO($this->dsn, $this->username, $this->password);
    }

    public function __serialize(): array
    {
        return [
          'dsn' => $this->dsn,
          'user' => $this->username,
          'pass' => $this->password,
        ];
    }

    public function __unserialize(array $data): void
    {
        $this->dsn = $data['dsn'];
        $this->username = $data['user'];
        $this->password = $data['pass'];

        $this->connect();
    }
}?>

__toString()

public __toString(): string

__toString() 方法用于一個(gè)類被當(dāng)成字符串時(shí)應(yīng)怎樣回應(yīng)。例如 echo $obj; 應(yīng)該顯示些什么。

警告

從 PHP 8.0.0 起，返回值遵循標(biāo)準(zhǔn)的 PHP 類型語義，這意味著如果禁用嚴(yán)格類型，它將會(huì)強(qiáng)制轉(zhuǎn)換為字符串。

從 PHP 8.0.0 起，任何包含 __toString() 方法的類都將隱性實(shí)現(xiàn) Stringable 接口，因此將通過該接口的類型檢查。推薦無論如何應(yīng)顯式實(shí)現(xiàn)該接口。

在 PHP 7.4 中，返回值必須是 string ，否則會(huì)拋出 Error 。

在 PHP 7.4.0 之前，返回值必須是 string ，否則會(huì)拋出致命錯(cuò)誤 E_RECOVERABLE_ERROR 。

警告

在 PHP 7.4.0 之前不能在 __toString() 方法中拋出異常。這么做會(huì)導(dǎo)致致命錯(cuò)誤。

示例 #3 簡(jiǎn)單示例


<?php
// 聲明一個(gè)簡(jiǎn)單的類
class TestClass
{
    public $foo;

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

    public function __toString() {
        return $this->foo;
    }
}

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

以上例程會(huì)輸出：

Hello

__invoke()

__invoke( ...$values): mixed

當(dāng)嘗試以調(diào)用函數(shù)的方式調(diào)用一個(gè)對(duì)象時(shí)，__invoke() 方法會(huì)被自動(dòng)調(diào)用。

示例 #4 使用 __invoke()


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

以上例程會(huì)輸出：

int(5)
bool(true)

__set_state()

static __set_state(array $properties): object

當(dāng)調(diào)用 var_export() 導(dǎo)出類時(shí)，此靜態(tài) 方法會(huì)被調(diào)用。

本方法的唯一參數(shù)是一個(gè)數(shù)組，其中包含按 ['property' => value, ...] 格式排列的類屬性。

示例 #5 使用 __set_state()>


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

$b = var_export($a, true);
var_dump($b);
eval('$c = ' . $b . ';');
var_dump($c);
var_dump($b);

?>

以上例程會(huì)輸出：

string(60) "A::__set_state(array(
   'var1' => 5,
   'var2' => 'foo',
))"
object(A)#2 (2) {
  ["var1"]=>
  int(5)
  ["var2"]=>
  string(3) "foo"
}

注意: 導(dǎo)出對(duì)象時(shí)， var_export() 不會(huì)檢查對(duì)象類是否實(shí)現(xiàn)了 __set_state() ，所以如果 __set_state() 沒有實(shí)現(xiàn)，重新導(dǎo)入對(duì)象會(huì)觸發(fā) Error 異常。特別是這會(huì)影響內(nèi)部(內(nèi)置)類。程序員有責(zé)任驗(yàn)證要重新導(dǎo)入的類是否實(shí)現(xiàn)了 __set_state() 。

__debugInfo()

__debugInfo(): array

當(dāng)通過 var_dump() 轉(zhuǎn)儲(chǔ)對(duì)象，獲取應(yīng)該要顯示的屬性的時(shí)候，該函數(shù)就會(huì)被調(diào)用。如果對(duì)象中沒有定義該方法，那么將會(huì)展示所有的公有、受保護(hù)和私有的屬性。

示例 #6 使用 __debugInfo()


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

以上例程會(huì)輸出：

object(C)#1 (1) {
  ["propSquared"]=>
  int(1764)
}

魔術(shù)方法

__sleep() 和 __wakeup()

__serialize() 和 __unserialize()

__toString()

__invoke()

__set_state()

__debugInfo()

sleep() 和 wakeup()

serialize() 和 unserialize()