Yii2的深入学习-yiibaseObject 类

Yii2的深入学习--yii\base\Object 类

之前我们说过 Yii2 中大多数类都继承自 yii\base\Object，今天就让我们来看一下这个类。

Object 是一个基础类，实现了属性的功能，其基本内容如下：

<span style="color: #000000;">phpnamespace yii\base;</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> Yii;</span><span style="color: #008000;">/*</span><span style="color: #008000;">* * Object 是一个基础类，实现了属性的功能 * Yii最基础的类，大多数类都继承了该类 </span><span style="color: #008000;">*/</span><span style="color: #0000ff;">class</span> <span style="color: #0000ff;">Object</span> <span style="color: #0000ff;">implements</span><span style="color: #000000;"> Configurable{    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 获取静态方法调用的类名。返回类的名称，如果不是在类中调用则返回 FALSE。     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">static</span> <span style="color: #0000ff;">function</span><span style="color: #000000;"> className()    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * Constructor.     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> __construct(<span style="color: #800080;">$config</span> =<span style="color: #000000;"> [])    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 初始化对象     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span><span style="color: #000000;"> init()    {    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 魔术方法，实现 getter     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> __get(<span style="color: #800080;">$name</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 魔术方法，实现 setter     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> __set(<span style="color: #800080;">$name</span>, <span style="color: #800080;">$value</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 魔术方法，实现 isset，基于 getter 实现，有 getter 方法的属性才算存在     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> __isset(<span style="color: #800080;">$name</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 魔术方法，实现 unset，基于 setter 实现，有 setter 方法的属性才能 unset 掉     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> __unset(<span style="color: #800080;">$name</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * Calls the named method which is not a class method.     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> __call(<span style="color: #800080;">$name</span>, <span style="color: #800080;">$params</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 检查对象或类是否具有 $name 属性，如果 $checkVars 为 true，则不局限于是否有 getter/setter     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> hasProperty(<span style="color: #800080;">$name</span>, <span style="color: #800080;">$checkVars</span> = <span style="color: #0000ff;">true</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 检查对象或类是否能够获取 $name 属性，如果 $checkVars 为 true，则不局限于是否有 getter     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> canGetProperty(<span style="color: #800080;">$name</span>, <span style="color: #800080;">$checkVars</span> = <span style="color: #0000ff;">true</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 检查对象或类是否能够设置 $name 属性，如果 $checkVars 为 true，则不局限于是否有 setter     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> canSetProperty(<span style="color: #800080;">$name</span>, <span style="color: #800080;">$checkVars</span> = <span style="color: #0000ff;">true</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * 检查对象或类是否具有 $name 方法     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> hasMethod(<span style="color: #800080;">$name</span><span style="color: #000000;">)    {        </span>...<span style="color: #000000;">    }}</span>

如果想看详细的注释的话，可以访问 https://github.com/ReadCode/yii2-2.0.3-annotated/blob/master/framework/base/Object.php

从上面的内容中，我们可以看到 Object 类重写了 __get 和 __set 方法，下面我们来详细看下这两个方法：

    <span style="color: #008000;">/*</span><span style="color: #008000;">*     * Returns the value of an object property.     *     * Do not call this method directly as it is a PHP magic method that     * will be implicitly called when executing `$value = $object->property;`.     *     * 魔术方法，实现 getter     *     * @param string $name the property name     * @return mixed the property value     * @throws UnknownPropertyException if the property is not defined     * @throws InvalidCallException if the property is write-only     * @see __set()     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> __get(<span style="color: #800080;">$name</span><span style="color: #000000;">)    {        </span><span style="color: #800080;">$getter</span> = 'get' . <span style="color: #800080;">$name</span><span style="color: #000000;">;        </span><span style="color: #0000ff;">if</span> (<span style="color: #008080;">method_exists</span>(<span style="color: #800080;">$this</span>, <span style="color: #800080;">$getter</span><span style="color: #000000;">)) {            </span><span style="color: #008000;">//</span><span style="color: #008000;"> 对象存在 $getter 方法，就直接调用</span>            <span style="color: #0000ff;">return</span> <span style="color: #800080;">$this</span>-><span style="color: #800080;">$getter</span><span style="color: #000000;">();        } </span><span style="color: #0000ff;">elseif</span> (<span style="color: #008080;">method_exists</span>(<span style="color: #800080;">$this</span>, 'set' . <span style="color: #800080;">$name</span><span style="color: #000000;">)) {            </span><span style="color: #008000;">//</span><span style="color: #008000;"> 如果存在 'set' . $name 方法，就认为该属性是只写的</span>            <span style="color: #0000ff;">throw</span> <span style="color: #0000ff;">new</span> InvalidCallException('Getting write-only property: ' . <span style="color: #008080;">get_class</span>(<span style="color: #800080;">$this</span>) . '::' . <span style="color: #800080;">$name</span><span style="color: #000000;">);        } </span><span style="color: #0000ff;">else</span><span style="color: #000000;"> {            </span><span style="color: #008000;">//</span><span style="color: #008000;"> 否则认为该属性不存在</span>            <span style="color: #0000ff;">throw</span> <span style="color: #0000ff;">new</span> UnknownPropertyException('Getting unknown property: ' . <span style="color: #008080;">get_class</span>(<span style="color: #800080;">$this</span>) . '::' . <span style="color: #800080;">$name</span><span style="color: #000000;">);        }    }    </span><span style="color: #008000;">/*</span><span style="color: #008000;">*     * Sets value of an object property.     *     * Do not call this method directly as it is a PHP magic method that     * will be implicitly called when executing `$object->property = $value;`.     *     * 魔术方法，实现 setter     *     * @param string $name the property name or the event name     * @param mixed $value the property value     * @throws UnknownPropertyException if the property is not defined     * @throws InvalidCallException if the property is read-only     * @see __get()     </span><span style="color: #008000;">*/</span>    <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> __set(<span style="color: #800080;">$name</span>, <span style="color: #800080;">$value</span><span style="color: #000000;">)    {        </span><span style="color: #800080;">$setter</span> = 'set' . <span style="color: #800080;">$name</span><span style="color: #000000;">;        </span><span style="color: #0000ff;">if</span> (<span style="color: #008080;">method_exists</span>(<span style="color: #800080;">$this</span>, <span style="color: #800080;">$setter</span><span style="color: #000000;">)) {            </span><span style="color: #008000;">//</span><span style="color: #008000;"> 对象存在 $setter 方法，就直接调用</span>            <span style="color: #800080;">$this</span>-><span style="color: #800080;">$setter</span>(<span style="color: #800080;">$value</span><span style="color: #000000;">);        } </span><span style="color: #0000ff;">elseif</span> (<span style="color: #008080;">method_exists</span>(<span style="color: #800080;">$this</span>, 'get' . <span style="color: #800080;">$name</span><span style="color: #000000;">)) {            </span><span style="color: #008000;">//</span><span style="color: #008000;"> 如果存在 'get' . $name 方法，就认为该属性是只读的</span>            <span style="color: #0000ff;">throw</span> <span style="color: #0000ff;">new</span> InvalidCallException('Setting read-only property: ' . <span style="color: #008080;">get_class</span>(<span style="color: #800080;">$this</span>) . '::' . <span style="color: #800080;">$name</span><span style="color: #000000;">);        } </span><span style="color: #0000ff;">else</span><span style="color: #000000;"> {            </span><span style="color: #008000;">//</span><span style="color: #008000;"> 否则认为该属性不存在</span>            <span style="color: #0000ff;">throw</span> <span style="color: #0000ff;">new</span> UnknownPropertyException('Setting unknown property: ' . <span style="color: #008080;">get_class</span>(<span style="color: #800080;">$this</span>) . '::' . <span style="color: #800080;">$name</span><span style="color: #000000;">);        }    }</span>

基于上面的代码，我们可以看到，如果访问一个 Object 对象的某个属性， Yii会调用名为 get属性名() 的函数。如， SomeObject->Foo ， 会自动调用 SomeObject->getFoo()。 如果修改某一属性，会调用相应的setter函数。 如， SomeObject->Foo = $someValue ，会自动调用 SomeObject->setFoo($someValue) 。

以 SomeObject 的 Foo 为例，如果只存在 getFoo() 方法，那它就是只读的，如果只存在 setFoo() 方法，那它就是只写的，只有两个方法都存在的时候才是既可读又可写的。

需要注意的一点是只有在读取和写入对象的一个不存在的成员变量时， __get() __set() 会被自动调用。 如果 Foo 是一个 public 的属性就不会经过 __get() 和  __set() 方法了。

所以通常属性是 private 的，举个例子如下：

<span style="color: #0000ff;">class</span> User <span style="color: #0000ff;">extends</span> yii\base\<span style="color: #0000ff;">Object</span><span style="color: #000000;">{    </span><span style="color: #0000ff;">private</span> <span style="color: #800080;">$_name</span><span style="color: #000000;">;    </span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span><span style="color: #000000;"> getName()    {        </span><span style="color: #0000ff;">return</span> <span style="color: #800080;">$this</span>-><span style="color: #000000;">_name;    }    </span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> setName(<span style="color: #800080;">$name</span><span style="color: #000000;">)    {        </span><span style="color: #800080;">$this</span>->_name = <span style="color: #008080;">trim</span>(<span style="color: #800080;">$name</span><span style="color: #000000;">);    }}</span>

我们还可以在 get 和 set 方法中做一些特殊的处理。

除了 __get() __set() 之外， yii\base\Object 还提供了以下方法便于使用属性：

• __isset() 用于测试属性值是否不为 null ，在 isset($object->property) 时被自动调用。 注意该属性要有相应的 getter。
• __unset() 用于将属性值设为 null ，在 unset($object->property) 时被自动调用。 注意该属性要有相应的 setter。
• hasProperty() 用于测试是否有某个属性。即，定义了 getter 或 setter。 如果 hasProperty() 的参数 $checkVars = true （默认为true）， 那么只要具有同名的成员变量也认为具有该属性，如前面提到的 public $title 。
• canGetProperty() 测试一个属性是否可读，参数 $checkVars 的意义同上。只要定义了 getter，属性即可读。 同时，如果 $checkVars 为 true 。那么只要类定义了成员变量，不管是 public， private 还是 protected， 都认为是可读。
• canSetProperty() 测试一个属性是否可写，参数 $checkVars 的意义同上。只要定义了 setter，属性即可写。 同时，在 $checkVars 为 ture 。那么只要类定义了成员变量，不管是 public， private 还是 protected， 都认为是可写。

 

对 Yii2 源码有兴趣的同学可以关注项目 yii2-2.0.3-annotated，现在在上面已经添加了不少关于 Yii2 源码的注释，之后还会继续添加～

有兴趣的同学也可以参与进来，提交 Yii2 源码的注释。