PHP中的魔术方法

PHP之十六个魔术方法详解 (一)

前言

PHP中把以两个下划线__开头的方法称为魔术方法(Magic methods)，这些方法在PHP中充当了举足轻重的作用。 魔术方法包括：

__construct()，类的构造函数

__destruct()，类的析构函数

__call()，在对象中调用一个不可访问方法时调用

__callStatic()，用静态方式中调用一个不可访问方法时调用

__get()，获得一个类的成员变量时调用

__set()，设置一个类的成员变量时调用

__isset()，当对不可访问属性调用isset()或empty()时调用

__unset()，当对不可访问属性调用unset()时被调用。

__sleep()，执行serialize()时，先会调用这个函数

__wakeup()，执行unserialize()时，先会调用这个函数

__toString()，类被当成字符串时的回应方法

__invoke()，调用函数的方式调用一个对象时的回应方法

__set_state()，调用var_export()导出类时，此静态方法会被调用。

__clone()，当对象复制完成时调用

__autoload()，尝试加载未定义的类

__debugInfo()，打印所需调试信息

范例

下面让我们以实例的形式向大家讲解下这几个魔术方法时如何使用的。

一、 __construct()，类的构造函数

php中构造方法是对象创建完成后第一个被对象自动调用的方法。在每个类中都有一个构造方法，如果没有显示地声明它，那么类中都会默认存在一个没有参数且内容为空的构造方法。

1、 构造方法的作用

通常构造方法被用来执行一些有用的初始化任务，如对成员属性在创建对象时赋予初始值。

2、 构造方法的在类中的声明格式

function __constrct([参数列表]){

 方法体 //通常用来对成员属性进行初始化赋值

}

3、 在类中声明构造方法需要注意的事项

1、在同一个类中只能声明一个构造方法，原因是，PHP不支持构造函数重载。

2、构造方法名称是以两个下画线开始的__construct()

下面是它的例子：

<?php

class Person

{                                                                      

 public $name;

 public $age;

 public $sex;                                                          

 /**

  * 显示声明一个构造方法且带参数

  */                                    

 public function __construct($name="", $sex="男", $age=22)

 {      

    $this->name = $name;

    $this->sex = $sex;

   $this->age = $age;

 }

       

 /**

  * say 方法

  */

 public function say()

 {

   echo "我叫：" . $this->name . "，性别：" . $this->sex . "，年龄：" . $this->age;

 }                          

}

创建对象$Person1且不带任参数

$Person1 = new Person();

echo $Person1->say(); //输出:我叫：，性别：男，年龄：27

创建对象$Person2且带参数“小明”

$Person2 = new Person("小明");

echo $Person2->say(); //输出：我叫：张三，性别：男，年龄：27

创建对象$Person3且带三个参数

$Person3 = new Person("李四","男",25);

echo $Person3->say(); //输出：我叫：李四，性别：男，年龄：25

二、__destruct()，类的析构函数

通过上面的讲解，现在我们已经知道了什么叫构造方法。那么与构造方法对应的就是析构方法。

析构方法允许在销毁一个类之前执行的一些操作或完成一些功能，比如说关闭文件、释放结果集等。

析构方法是PHP5才引进的新内容。

析造方法的声明格式与构造方法 __construct() 比较类似，也是以两个下划线开始的方法 __destruct() ，这种析构方法名称也是固定的。

1、 析构方法的声明格式

function __destruct()

{

//方法体

}

注意：析构函数不能带有任何参数。

2、 析构方法的作用

一般来说，析构方法在PHP中并不是很常用，它属类中可选择的一部分，通常用来完成一些在对象销毁前的清理任务。

举例演示，如下：

<?php

class Person{    

                                                       

   public $name;        

   public $age;        

   public $sex;        

                                                                   

   public function __construct($name="", $sex="男", $age=22)

   {  

       $this->name = $name;

       $this->sex  = $sex;

       $this->age  = $age;

   }

   

   /**

    * say 说话方法

    */

   public function say()

   {  

       echo "我叫：".$this->name."，性别：".$this->sex."，年龄：".$this->age;

   }    

   

   /**

    * 声明一个析构方法

    */

   public function __destruct()

   {

           echo "我觉得我还可以再抢救一下，我的名字叫".$this->name;

   }

}

$Person = new Person("小明");

unset($Person); //销毁上面创建的对象$Person

上面的程序运行时输出：

我觉得我还可以再抢救一下，我的名字叫小明

三、 __call()，在对象中调用一个不可访问方法时调用。

该方法有两个参数，第一个参数 $function_name 会自动接收不存在的方法名，第二个 $arguments 则以数组的方式接收不存在方法的多个参数。

1、 __call() 方法的格式：

function __call(string $function_name, array $arguments)

{

   // 方法体

}

2、 __call() 方法的作用：

为了避免当调用的方法不存在时产生错误，而意外的导致程序中止，可以使用 __call() 方法来避免。

该方法在调用的方法不存在时会自动调用，程序仍会继续执行下去。

请参考如下代码：

<?php

class Person

{                            

   function say()

   {  

                             

        echo "Hello, world!<br>";

   }      

       

   /**

   * 声明此方法用来处理调用对象中不存在的方法

   */

   function __call($funName, $arguments)

   {

       echo "你所调用的函数：" . $funName . "(参数：" ;  // 输出调用不存在的方法名

       print_r($arguments); // 输出调用不存在的方法时的参数列表

       echo ")不存在！<br>\n"; // 结束换行                      

   }                                          

}

$Person = new Person();            

$Person->run("teacher"); // 调用对象中不存在的方法，则自动调用了对象中的__call()方法

$Person->eat("小明", "苹果");            

$Person->say();                        

运行结果：

你所调用的函数：run(参数：Array ( [0] => teacher ) )不存在！

你所调用的函数：eat(参数：Array ( [0] => 小明 [1] => 苹果 ) )不存在！

Hello, world!

四、 __callStatic()，用静态方式中调用一个不可访问方法时调用

此方法与上面所说的 __call() 功能除了 __callStatic() 是未静态方法准备的之外，其它都是一样的。

请看下面代码：

<?php

class Person

{

   function say()

   {

       echo "Hello, world!<br>";

   }

   /**

    * 声明此方法用来处理调用对象中不存在的方法

    */

   public static function __callStatic($funName, $arguments)

   {

       echo "你所调用的静态方法：" . $funName . "(参数：" ;  // 输出调用不存在的方法名

       print_r($arguments); // 输出调用不存在的方法时的参数列表

       echo ")不存在！<br>\n"; // 结束换行

   }

}

$Person = new Person();

$Person::run("teacher"); // 调用对象中不存在的方法，则自动调用了对象中的__call()方法

$Person::eat("小明", "苹果");

$Person->say();

运行结果如下：

你所调用的静态方法：run(参数：Array ( [0] => teacher ) )不存在！

你所调用的静态方法：eat(参数：Array ( [0] => 小明 [1] => 苹果 ) )不存在！

Hello, world!

五、 __get()，获得一个类的成员变量时调用

在 php 面向对象编程中，类的成员属性被设定为 private 后，如果我们试图在外面调用它则会出现“不能访问某个私有属性”的错误。那么为了解决这个问题，我们可以使用魔术方法 __get()。

魔术方法__get()的作用

在程序运行过程中，通过它可以在对象的外部获取私有成员属性的值。

我们通过下面的 __get() 的实例来更进一步的连接它吧：

<?php

class Person

{

   private $name;

   private $age;

   function __construct($name="", $age=1)

   {

       $this->name = $name;

       $this->age = $age;

   }

   /**

    * 在类中添加__get()方法，在直接获取属性值时自动调用一次，以属性名作为参数传入并处理

    * @param $propertyName

    *

    * @return int

    */

   public function __get($propertyName)

   {  

       if ($propertyName == "age") {

           if ($this->age > 30) {

               return $this->age - 10;

           } else {

               return $this->$propertyName;

           }

       } else {

           return $this->$propertyName;

       }

   }

}

$Person = new Person("小明", 60);   // 通过Person类实例化的对象，并通过构造方法为属性赋初值

echo "姓名：" . $Person->name . "<br>";   // 直接访问私有属性name，自动调用了__get()方法可以间接获取

echo "年龄：" . $Person->age . "<br>";    // 自动调用了__get()方法，根据对象本身的情况会返回不同的值

运行结果：

姓名：小明

年龄：50

六、 __set()，设置一个类的成员变量时调用

__set() 的作用：

__set( $property, $value )` 方法用来设置私有属性，

给一个未定义的属性赋值时，此方法会被触发，传递的参数是被设置的属性名和值。

请看下面的演示代码：

<?php

class Person

{

   private $name;

   private $age;

   public function __construct($name="",  $age=25)

   {

       $this->name = $name;

       $this->age  = $age;

   }

   /**

    * 声明魔术方法需要两个参数，真接为私有属性赋值时自动调用，并可以屏蔽一些非法赋值

    * @param $property

    * @param $value

    */

   public function __set($property, $value) {

       if ($property=="age")

       {

           if ($value > 150 || $value < 0) {

               return;

           }

       }

       $this->$property = $value;

   }

   /**

    * 在类中声明说话的方法，将所有的私有属性说出

    */

   public function say(){

       echo "我叫".$this->name."，今年".$this->age."岁了";

   }

}

$Person=new Person("小明", 25); //注意，初始值将被下面所改变

//自动调用了__set()函数，将属性名name传给第一个参数，将属性值”李四”传给第二个参数

$Person->name = "小红";     //赋值成功。如果没有__set()，则出错。

//自动调用了__set()函数，将属性名age传给第一个参数，将属性值26传给第二个参数

$Person->age = 16; //赋值成功

$Person->age = 160; //160是一个非法值，赋值失效

$Person->say();  //输出：我叫小红，今年16岁了

运行结果：

我叫小红，今年16岁了

七、 __isset()，当对不可访问属性调用isset()或empty()时调用

在看这个方法之前我们看一下isset()函数的应用，isset()是测定变量是否设定用的函数，传入一个变量作为参数，如果传入的变量存在则传回true，否则传回false。

那么如果在一个对象外面使用isset()这个函数去测定对象里面的成员是否被设定可不可以用它呢？

分两种情况，如果对象里面成员是公有的，我们就可以使用这个函数来测定成员属性，如果是私有的成员属性，这个函数就不起作用了，原因就是因为私有的被封装了，在外部不可见。那么我们就不可以在对象的外部使用isset()函数来测定私有成员属性是否被设定了呢？当然是可以的，但不是一成不变。你只要在类里面加上一个__isset()方法就可以了，当在类外部使用isset()函数来测定对象里面的私有成员是否被设定时，就会自动调用类里面的__isset()方法了帮我们完成这样的操作。

__isset()的作用：当对不可访问属性调用 isset() 或 empty() 时，__isset() 会被调用。

请看下面代码演示：

<?php

class Person

{

   public $sex;

   private $name;

   private $age;

   public function __construct($name="",  $age=25, $sex='男')

   {

       $this->name = $name;

       $this->age  = $age;

       $this->sex  = $sex;

   }

   /**

    * @param $content

    *

    * @return bool

    */

   public function __isset($content) {

       echo "当在类外部使用isset()函数测定私有成员{$content}时，自动调用<br>";

       echo  isset($this->$content);

   }

}

$person = new Person("小明", 25); // 初始赋值

echo isset($person->sex),"<br>";

echo isset($person->name),"<br>";

echo isset($person->age),"<br>";

运行结果如下：

1 // public 可以 isset()

当在类外部使用isset()函数测定私有成员name时，自动调用 // __isset() 内 第一个echo

1 // __isset() 内第二个echo

当在类外部使用isset()函数测定私有成员age时，自动调用 // __isset() 内 第一个echo

1 // __isset() 内第二个echo

八、 __unset()，当对不可访问属性调用unset()时被调用。

看这个方法之前呢，我们也先来看一下 unset() 函数，unset()这个函数的作用是删除指定的变量且传回true，参数为要删除的变量。

那么如果在一个对象外部去删除对象内部的成员属性用unset()函数可以吗？

这里自然也是分两种情况：

1、 如果一个对象里面的成员属性是公有的，就可以使用这个函数在对象外面删除对象的公有属性。

2、 如果对象的成员属性是私有的，我使用这个函数就没有权限去删除。

虽然有以上两种情况，但我想说的是同样如果你在一个对象里面加上__unset()这个方法，就可以在对象的外部去删除对象的私有成员属性了。在对象里面加上了__unset()这个方法之后，在对象外部使用“unset()”函数删除对象内部的私有成员属性时，对象会自动调用__unset()函数来帮我们删除对象内部的私有成员属性。

请看如下代码：

<?php

class Person

{

   public $sex;

   private $name;

   private $age;

   public function __construct($name="",  $age=25, $sex='男')

   {

       $this->name = $name;

       $this->age  = $age;

       $this->sex  = $sex;

   }

   /**

    * @param $content

    *

    * @return bool

    */

   public function __unset($content) {

       echo "当在类外部使用unset()函数来删除私有成员时自动调用的<br>";

       echo  isset($this->$content);

   }

}

$person = new Person("小明", 25); // 初始赋值

unset($person->sex);

unset($person->name);

unset($person->age);

运行结果：

当在类外部使用unset()函数来删除私有成员时自动调用的

1当在类外部使用unset()函数来删除私有成员时自动调用的

1

九、 __sleep()，执行serialize()时，先会调用这个函数

serialize() 函数会检查类中是否存在一个魔术方法 __sleep()。如果存在，则该方法会优先被调用，然后才执行序列化操作。

此功能可以用于清理对象，并返回一个包含对象中所有应被序列化的变量名称的数组。

如果该方法未返回任何内容，则 NULL 被序列化，并产生一个 E_NOTICE 级别的错误。

注意：

__sleep() 不能返回父类的私有成员的名字。这样做会产生一个 E_NOTICE 级别的错误。可以用 Serializable 接口来替代。

作用：

__sleep() 方法常用于提交未提交的数据，或类似的清理操作。同时，如果有一些很大的对象，但不需要全部保存，这个功能就很好用。

具体请参考如下代码：

<?php

class Person

{

   public $sex;

   public $name;

   public $age;

   public function __construct($name="",  $age=25, $sex='男')

   {

       $this->name = $name;

       $this->age  = $age;

       $this->sex  = $sex;

   }

   /**

    * @return array

    */

   public function __sleep() {

       echo "当在类外部使用serialize()时会调用这里的__sleep()方法<br>";

       $this->name = base64_encode($this->name);

       return array('name', 'age'); // 这里必须返回一个数值，里边的元素表示返回的属性名称

   }

}

$person = new Person('小明'); // 初始赋值

echo serialize($person);

echo '<br/>';

代码运行结果：

当在类外部使用serialize()时会调用这里的__sleep()方法

O:6:"Person":2:{s:4:"name";s:8:"5bCP5piO";s:3:"age";i:25;}

十、 __wakeup()，执行unserialize()时，先会调用这个函数

如果说 __sleep() 是白的，那么 __wakeup() 就是黑的了。

那么为什么呢？

因为：

与之相反，`unserialize()` 会检查是否存在一个 `__wakeup()` 方法。如果存在，则会先调用 `__wakeup` 方法，预先准备对象需要的资源。

作用：

__wakeup() 经常用在反序列化操作中，例如重新建立数据库连接，或执行其它初始化操作。

还是看代码：

<?php

class Person

{

   public $sex;

   public $name;

   public $age;

   public function __construct($name="",  $age=25, $sex='男')

   {

       $this->name = $name;

       $this->age  = $age;

       $this->sex  = $sex;

   }

   /**

    * @return array

    */

   public function __sleep() {

       echo "当在类外部使用serialize()时会调用这里的__sleep()方法<br>";

       $this->name = base64_encode($this->name);

       return array('name', 'age'); // 这里必须返回一个数值，里边的元素表示返回的属性名称

   }

   /**

    * __wakeup

    */

   public function __wakeup() {

       echo "当在类外部使用unserialize()时会调用这里的__wakeup()方法<br>";

       $this->name = 2;

       $this->sex = '男';

       // 这里不需要返回数组

   }

}

$person = new Person('小明'); // 初始赋值

var_dump(serialize($person));

var_dump(unserialize(serialize($person)));

运行结果：

当在类外部使用serialize()时会调用这里的__sleep()方法

string(58) "O:6:"Person":2:{s:4:"name";s:8:"5bCP5piO";s:3:"age";i:25;}" 当在类外部使用serialize()时会调用这里的__sleep()方法

当在类外部使用unserialize()时会调用这里的__wakeup()方法

object(Person)#2 (3) { ["sex"]=> string(3) "男" ["name"]=> int(2) ["age"]=> int(25) }