PHP 中以雙下劃線 __ 開頭的類方法被視為魔術方法,會在特定生命周期或操作時自動觸發。**不可自定義同名方法**,否則會導致不可預期行為。
| 分類 | 方法 | 觸發時機 |
|---|---|---|
| 構造/銷毀 | __construct() | 實例化對象 new Class() |
__destruct() | 對象銷毀/腳本結束/引用計數歸零 | |
| 屬性訪問 | __get($name) | 讀取不可訪問/不存在屬性 |
__set($name, $value) | 寫入不可訪問/不存在屬性 | |
__isset($name) | isset()/empty() 檢測不可訪問屬性 | |
__unset($name) | unset() 不可訪問屬性 | |
| 方法調用 | __call($name, $args) | 調用不可訪問/不存在**實例方法** |
__callStatic($name, $args) | 調用不可訪問/不存在**靜態方法** (PHP 5.3+) | |
| 對象作函數 | __invoke($args...) | 將對象當函數調用 $obj() (PHP 5.3+) |
| 序列化 | __sleep() | serialize($obj) 前,返回需序列化的屬性名數組 |
__wakeup() | unserialize() 後,重新初始化資源 | |
| 導出 | __set_state($arr) | var_export() 導出類時調用 (PHP 5.1+),靜態方法 |
| 克隆 | __clone() | clone $obj 後,深拷貝資源/修改標識 |
| 字符串轉換 | __toString() | 對象作字符串使用 echo $obj、(string)$obj |
| 調試 | __debugInfo() | var_dump($obj) 時返回顯示屬性數組 (PHP 5.6+) |
class PropertyTest {
private $data = [];
public $declared = 'public';
public function __set($name, $value) {
echo "__set: $name = $value\n";
$this->data[$name] = $value;
}
public function __get($name) {
echo "__get: $name\n";
return $this->data[$name] ?? null;
}
public function __isset($name) {
echo "__isset: $name\n";
return isset($this->data[$name]);
}
public function __unset($name) {
echo "__unset: $name\n";
unset($this->data[$name]);
}
}
$obj = new PropertyTest();
$obj->dynamic = 'value'; // 觸發 __set
echo $obj->dynamic; // 觸發 __get
var_dump(isset($obj->dynamic)); // 觸發 __isset → bool(true)
unset($obj->dynamic); // 觸發 __unset
var_dump(isset($obj->dynamic)); // 觸發 __isset → bool(false)
class MethodTest {
public function __call($name, $args) {
echo "__call: $name(" . implode(', ', $args) . ")\n";
}
public static function __callStatic($name, $args) {
echo "__callStatic: $name(" . implode(', ', $args) . ")\n";
}
}
$obj = new MethodTest();
$obj->runTest('in', 'object'); // __call
MethodTest::runTest('in', 'static'); // __callStatic (PHP 5.3+)
class CallableClass {
public function __invoke($x) {
var_dump($x);
}
}
$obj = new CallableClass();
$obj(5); // 輸出 int(5)
var_dump(is_callable($obj)); // bool(true)
class User {
public $name;
private $id; // 不想序列化的臨時 ID
public function __construct() {
$this->id = uniqid();
}
public function __sleep() {
return ['name']; // 僅序列化 name
}
public function __wakeup() {
$this->id = uniqid(); // 反序列化後重新生成 ID
}
}
$u = new User();
$u->name = 'Leon';
$s = serialize($u); // O:4:"User":1:{s:4:"name";s:4:"Leon";}
$u2 = unserialize($s);
// $u->id !== $u2->id (不同 ID)
class A {
public $var1, $var2;
public static function __set_state($arr) {
$obj = new self();
$obj->var1 = $arr['var1'];
$obj->var2 = $arr['var2'];
return $obj;
}
}
$a = new A(); $a->var1 = 5; $a->var2 = 'foo';
eval('$b = ' . var_export($a, true) . ';'); // $b 為新實例,屬性同值
class Secret {
public $public = 'visible';
private $secret = 'hidden';
public function __debugInfo() {
return ['public' => $this->public, 'hint' => 'secret hidden'];
}
}
var_dump(new Secret());
// 輸出僅含 public 與 hint,隱藏 $secret
parent::__construct() 等調用鏈。__sleep 時務必返回數組,否則報錯;包含資源 (DB 連接、文件句柄) 的對象**必須**實現 __sleep/__wakeup 管理資源生命周期。__debugInfo 可防止敏感數據 (密碼、Token) 被 var_dump 洩露。__toString 必須返回字符串,否則報 Catchable fatal error。魔術方法賦予 PHP 類極大的靈活性:屬性/方法動態代理、序列化控制、對象函數化、調試輸出過濾。理解其觸發時機與返回值約束,能優雅實現 ActiveRecord、代理模式、DTO 等高級模式。