php之魔术方法 __set 和 __get

发表于 | 分类于

考虑到部分同学水平的问题，在分析yii2源码之前，我们准备先介绍一些php的基础知识。包括我们今天要讲的魔术方法set、get以及后面要介绍的依赖注入、控制反转等。

给大家补充的基础知识点，必须相当重要。如果这都不理解，yii2的源码分析就没有看的必要了。

首先，我们今天来看一下php的魔术方法 set 和 get。

在php中，有很多魔术方法，魔术方法都是以两个下划线 __ 开头的保留方法。

当然，这些魔术方法都是针对类而存在的。

set: 给类不存在或者不可访问的属性赋值时会被自动调用 get: 读取类不存在或者不可访问的属性时会被自动调用
二者的原型如下

1
2
public mixed __get ( string $name )
public void __set ( string $name , mixed $value )

我们来看一个例子

1
2
3
4
5
6
7
8
class A
{
    public $name;
}

$a = new A;
$a->name = 'zhangsan';
echo $a->name;

正常情况下，上面的代码会正确的输出 zhangsan 的结果，没有问题。

此时，假如我们输出对象a不存在的age属性，页面上会提示我们 A::$age 未定义。

1
2
3
echo $a->age;

Notice: Undefined property: A::$age

当然，有同学可能会说，我声明一个 public $a; 不就行了吗？可以呀，不过像你这样砸场子的话，我们就没有继续说下去的必要了。

我们对A类增加一个 __get 方法，看看这个会被自动调用的方法是啥效果

1
2
3
4
5
6
7
8
9
class A
{
    public $name;

    public function __get($name)
    {
        var_dump($name);
    }
}

依然访问 $a->age 属性

1
echo $a->age;

其结果瞬间由刚才的Notice提醒变成了

1
string(3) "age"

看来没问题。

你可以再写一个protected和private类型的属性，其结果跟不存在的age属性一样，会自动调用 __get 方法。但是 public 类型的 name 属性不会调用该方法。

现在，我们再为A类增加一个 __set 方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
class A
{
    public $name;

    public function __get($name)
    {
        // var_dump($name);
    }

    public function __set($name, $value)
    {
        var_dump($name, $value);
    }
}

我们为不存在的属性 age 赋值，看看效果

1
2
$a = new A;
$a->age = 20;

结果如下

1
string(3) "age" int(20)

当然，protected和private类型的属性被赋值时也可以得到相同的结果，可以自己尝试下。

so easy，那么，我们讲这些的意义是什么？

别急别急，鉴于以上，我们再看一个问题：

假如我们有一个B类以及一个配置数组如下

1
2
3
4
5
6
7
8
9
10
11
class B
{
    public $name;
}


$config = [
    'class' => 'B',
    'name' => 'zhangsan',
    'age' => 20,
];

如何根据$config的配置，来创建一个B对象并为B的对象属性赋值？

先思考一下再继续阅读哦。

来看一下我们是怎么使用set和get实现的

B类的实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
class B
{
    public $name;

    private $_definitions = [];

    public function __get($name)
    {
        return isset($this->_definitions[$name]) ? $this->_definitions[$name] : null;
    }

    public function __set($name, $value)
    {
        $this->_definitions[$name] = $value;
    }
}

实例化上述类并通过$config为对象b赋值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
$config = [
    'class' => 'B',
    'name' => 'zhangsan',
    'age' => 20,
];

$class = $config['class'];
unset($config['class']);

$object = new $class;

foreach ($config as $k => $v) {
    $object->$k = $v;
}

var_dump($object->name);
var_dump($object->age);

结果如下

1
string(8) "zhangsan" int(20)

有同学终于缓过神了，这有点像什么？这是不是有点像yii2中的配置项？

木有错，今天我们先介绍一些基础，后面分析yii2的源码时我们再详细的说说。