PHP 魔术方法详解

PHP 阅读量

PHP 将所有以 __（两个下划线）开头的类方法保留为魔术方法。所以在定义类方法时，除了上述魔术方法，建议不要以 __ 为前缀。

越简单的东西,越容易被忽视

魔术方法

  • __construct(): 类的构造函数

  • __destruct(): 类的析构函数

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

  • __get(): 获取一个类的成员变量时调用

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

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

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

  • __sleep(): 执行serialize()时, 先会调用这个函数

  • __wakeup(): 执行unserialize()时,先会调用这个函数

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

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

  • __set_state(): 调用var_export()导出类时, 此静态方法会被调用

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

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

  • __debugInfo(): 打印所需调试信息

__construct()

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

1
2
3
4
5
function __constrct([参数列表])
{

    // 方法体 通常用来对成员属性进行初始化赋值
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?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;
    }   
                                                                                       
}

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

__destruct()

1
2
3
4
function __destruct()
{
    //方法体
}

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<?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
2
3
4
function __call(string $function_name, array $arguments)
{
    // 方法体
}

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?php

class Person
{                             
    function say()
    {  
        echo "Hello, world!<br>"; 
    }      
        
    /**
     * 声明此方法用来处理调用对象中不存在的方法
     */
    function __call($funcName, $arguments)
    { 
          echo "你所调用的函数：" . $funcName . "(参数：" ;  // 输出调用不存在的方法名
          print_r($arguments); // 输出调用不存在的方法时的参数列表
          echo ")不存在！<br>\n"; // 结束换行                      
    }                                          
}
$Person = new Person();            
$Person->run("teacher"); // 调用对象中不存在的方法，则自动调用了对象中的__call()方法
$Person->eat("小明", "苹果");             
$Person->say();

__callStatic()

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?php

class Person
{
    function say()
    {

        echo "Hello, world!<br>";
    }

    /**
     * 声明此方法用来处理调用对象中不存在的方法
     */
    public static function __callStatic($funcName, $arguments)
    {
        echo "你所调用的静态方法：" . $funcName . "(参数：" ;  // 输出调用不存在的方法名
        print_r($arguments); // 输出调用不存在的方法时的参数列表
        echo ")不存在！<br>\n"; // 结束换行
    }
}
$Person = new Person();
$Person::run("teacher"); // 调用对象中不存在的方法，则自动调用了对象中的__call()方法
$Person::eat("小明", "苹果");
$Person->say();

__get()

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<?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()方法，根据对象本身的情况会返回不同的值

__set()

__set( $property, $value ) 方法用来设置私有属性， 给一个未定义的属性赋值时，此方法会被触发，传递的参数是被设置的属性名和值。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?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岁了

__isset()

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<?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>";

__unset()

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<?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);

__sleep()

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

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

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

注意

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?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/>';

__wakeup()

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<?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;
    }

    /**
     * __sleep
     * @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)));

__toString()

类被当成字符串时的回应方法
__toString() 方法用于一个类被当成字符串时应怎样回应。例如 echo $obj; 应该显示些什么。

注意

此方法必须返回一个字符串，否则将发出一条 E_RECOVERABLE_ERROR 级别的致命错误。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?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;
    }

    public function __toString()
    {
        return  'go go go';
    }
}

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

__invoke()

调用函数的方式调用一个对象时的回应方法
当尝试以调用函数的方式调用一个对象时，__invoke() 方法会被自动调用。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?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;
    }

    public function __invoke()
    {
        echo '这可是一个对象哦';
    }

}

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

__set_state()

调用var_export()导出类时，此静态方法会被调用。
自 PHP 5.1.0 起，当调用 var_export() 导出类时，此静态方法会被自动调用。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?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;
    }

    public static function __set_state($an_array)
    {
        $a = new Person();
        $a->name = $an_array['name'];
        return $a;
    }

}

$person = new Person('小明'); // 初始赋值
$person->name = '小红';
var_export($person);

__clone()

当对象复制完成时调用
对象复制可以通过 clone 关键字来完成（如果可能，这将调用对象的 __clone() 方法）。对象中的 __clone() 方法不能被直接调用。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<?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;
    }

    public function __clone()
    {
        echo __METHOD__."你正在克隆对象<br>";
    }

}

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

var_dump('persion1:');
var_dump($person);
echo '<br>';
var_dump('persion2:');
var_dump($person2);

__autoload()

尝试加载未定义的类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/** 
 * 文件autoload_demo.php 
 */ 
function  __autoload($className)
{  
    $filePath = "project/class/{$className}.php";  
    if (is_readable($filePath)) {  
        require($filePath);  
    }  
}  
   
if (条件A) {  
    $a = new A();  
    $b = new B();  
    $c = new C();  
    // … 业务逻辑  
} else if (条件B) {  
    $a = newA();  
    $b = new B();  
    // … 业务逻辑  
}

__debugInfo()

打印所需调试信息
该方法在PHP 5.6.0及其以上版本才可以用，如果你发现使用无效或者报错，请查看啊你的版本。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<?php

class C {
    private $prop;

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

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

var_dump(new C(42));

Powered by Hexo and Hexo-theme-hiker

Copyright © 2017 - 2023 Keep It Simple And Stupid All Rights Reserved.

访客数 : | 访问量 :