PHP 魔术方法
PHP 魔术方法
在面向对象编程中,PHP 提供了一系列的魔术方法,这些魔术方法为编程提供了很多便利,在 PHP 中的作用是非常重要的。PHP 中的魔术方法通常以__
(两个下划线)开始,并且不需要显式的调用而是在某种特定条件下自动调用的。
PHP 中包含下面这些魔术方法
方法名称 | 说明 |
---|---|
__construct() |
实例化类时自动调用 |
__destruct() |
类对象使用结束时自动调用 |
__set() |
在给未定义的属性赋值时自动调用 |
__get() |
调用未定义的属性时自动调用 |
__isset() |
使用 isset() 或 empty() 函数时自动调用 |
__unset() |
使用 unset() 时自动调用 |
__sleep() |
使用 serialize 序列化时自动调用 |
__unset() |
使用 unset() 时自动调用 |
__serialize() |
使用 serialize 序列化时自动调用 |
__unserialize() |
使用 unserialize 反序列化时自动调用 |
__call() |
调用一个不存在的方法时自动调用 |
__callStatic() |
调用一个不存在的静态方法时自动调用 |
__toString() |
把对象转换成字符串时自动调用 |
__invoke() |
当尝试把对象当方法调用时自动调用 |
__set_state() |
当使用 var_export() 函数时自动调用,接受一个数组参数 |
__clone() |
当使用 clone 复制一个对象时自动调用 |
__debugInfo() |
使用 var_dump() 打印对象信息时自动调用 |
注意: 所有的魔术方法 必须 声明为 public
警告:PHP 将所有以
__
(两个下划线)开头的类方法保留为魔术方法。所以在定义类方法时,除了上述魔术方法,建议不要以__
为前缀。
__sleep()
和 __wakeup()
public function __sleep ( ) : array
serialize() 函数会检查类中是否存在一个魔术方法 __sleep()
。如果存在,该方法会先被调用,然后才执行序列化操作。此功能可以用于清理对象,并返回一个包含对象中所有应被序列化的变量名称的数组。如果该方法未返回任何内容,则 null 被序列化,并产生一个 E_NOTICE 级别的错误。
注意:
__sleep()
不能返回父类的私有成员的名字。这样做会产生一个 E_NOTICE 级别的错误。可以用 Serializable 接口来替代。
__sleep()
方法常用于提交未提交的数据,或类似的清理操作。同时,如果有一些很大的对象,但不需要全部保存,这个功能就很好用。
public function __wakeup ( ) : void
与__sleep()
相反,unserialize() 会检查是否存在一个 __wakeup()
方法。如果存在,则会先调用 __wakeup
方法,预先准备对象需要的资源。
__wakeup()
经常用在反序列化操作中,例如重新建立数据库连接,或执行其它初始化操作。
示例 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 function __serialize ( ) : array
serialize() 函数会检查类中是否存在一个魔术方法 __serialize()
。如果存在,该方法将在任何序列化之前优先执行。它必须以一个代表对象序列化形式的 键/值 成对的关联数组形式来返回,如果没有返回数组,将会抛出一个 TypeError 错误。
注意:如果类中同时定义了
__serialize()
和__sleep()
两个魔术方法,则只有__serialize()
方法会被调用。__sleep()
方法会被忽略掉。如果对象实现了 Serializable 接口,接口的 serialize() 方法会被忽略,做为代替类中的__serialize()
方法会被调用。
public function __unserialize ( array $data ) : void
和 __serialize()
相反, unserialize()
函数会检查类中是否存在一个魔术方法__ unserialize()
。如果存在,该方法将会接收由魔术方法__serialize()
返回的数组。
注意:如果类中同时定义了
__unserialize()
和__wakeup()
两个魔术方法,则只有__unserialize()
方法会生效,__wakeup()
方法会被忽略。
注意:此特性自 PHP 7.4.0 起可用。
示例
<?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 function __toString ( ) : string
__toString()
方法用于一个类被当成字符串时应怎样回应。例如 echo $obj; 应该显示些什么。此方法必须返回一个字符串,否则将发出一条 E_RECOVERABLE_ERROR 级别的致命错误。
警告 不能在
__toString()
方法中抛出异常。这么做会导致致命错误。
示例
<?php
// Declare a simple class
class TestClass
{
public $foo;
public function __construct($foo)
{
$this->foo = $foo;
}
public function __toString() {
return $this->foo;
}
}
$class = new TestClass('Hello');
echo $class;
?>
以上例程会输出:
Hello
需要指出的是在 PHP 5.2.0 之前,
__toString()
方法只有在直接使用于 echo 或 print 时才能生效。PHP 5.2.0 之后,则可以在任何字符串环境生效(例如通过 printf(),使用 %s 修饰符),但不能用于非字符串环境(如使用 %d 修饰符)。自 PHP 5.2.0 起,如果将一个未定义__toString()
方法的对象转换为字符串,会产生 E_RECOVERABLE_ERROR 级别的错误。
__invoke()
public function __invoke ( $... = ? ) : mixed
当尝试以调用函数的方式调用一个对象时,__invoke()
方法会被自动调用。
注意:本特性只在 PHP 5.3.0 及以上版本有效。
示例
<?php
class CallableClass
{
function __invoke($x) {
var_dump($x);
}
}
$obj = new CallableClass;
$obj(5);
var_dump(is_callable($obj));
?>
以上程序会输出:
int(5)
bool(true)
__set_state()
static __set_state ( array $properties ) : object
自 PHP 5.1.0 起当调用 var_export()
导出类时,此静态 方法会被调用。
本方法的唯一参数是一个数组,其中包含按 array('property' => value, ...) 格式排列的类属性。
示例
<?php
class A
{
public $var1;
public $var2;
public static function __set_state($an_array) // As of PHP 5.1.0
{
$obj = new A;
$obj->var1 = $an_array['var1'];
$obj->var2 = $an_array['var2'];
return $obj;
}
}
$a = new A;
$a->var1 = 5;
$a->var2 = 'foo';
eval('$b = ' . var_export($a, true) . ';'); // $b = A::__set_state(array(
// 'var1' => 5,
// 'var2' => 'foo',
// ));
var_dump($b);
?>
以上例程会输出:
object(A)#2 (2) {
["var1"]=>
int(5)
["var2"]=>
string(3) "foo"
}
__debugInfo()
__debugInfo ( ) : array
该方法是在使用 var_dump() 获取对象的属性的时候,调用。如果没有定义__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));
?>
以上程序会输出:
object(C)#1 (1) {
["propSquared"]=>
int(1764)
}