Class yii\base\Object

2019独角兽企业重金招聘Python工程师标准>>>

所有类 | 方法

继承	yii\base\Object
实现	yii\base\Configurable
可用自版本	2.0

对象的基类实现了属性特征。

一个属性被定义为一个getter方法(如getLabel),和/或setter方法(e.g. setLabel)。例如,下面的getter和setter方法定义一个属性命名label:

private $_label;

public function getLabel()
{
    return $this->_label;
}

public function setLabel($value)
{
    $this->_label = $value;
}

属性名是不区分大小写的

一个属性可以像访问对象的成员变量。读或写一个属性将导致相应的getter或setter方法的调用。例如,

// equivalent to $label = $object->getLabel();
$label = $object->label;
// equivalent to $object->setLabel('abc');
$object->label = 'abc';

如果一个属性只有一个getter方法,没有setter方法,它被认为是只读的。在这种情况下,试图修改属性值将导致异常。

可以调用hasProperty(),canGetProperty()和/或canSetProperty()检查属性的存在.

除了房地产特性,还引入了一个重要的对象初始化生命周期。特别是,创建一个新实例的对象或其派生类将涉及以下顺序生命周期:

1. 类的构造函数被调用;
2. 根据给定的对象属性初始化配置;
3. init()方法被调用。

在上面的步骤2和3发生在类构造函数的结束。建议您执行对象初始化在init()方法,因为在那个阶段,已经应用的对象配置。

为了确保上面的生命周期中,如果一个子类的对象需要覆盖的构造函数,它应该如下:

public function __construct($param1, $param2, ..., $config = [])
{
    ...
    parent::__construct($config);
}

即$config 参数(默认为[])应该声明为最后一个参数的构造函数,和父母实现年底应该被称为构造函数。

公共方法

隐藏继承方法

方法	描述	定义在
__call()	调用指定的方法而不是一个类方法。	yii\base\Object
__construct()	Constructor.	yii\base\Object
__get()	返回一个对象属性的值。	yii\base\Object
__isset()	检查如果属性设置,即定义和not null。	yii\base\Object
__set()	设置对象的属性值。	yii\base\Object
__unset()	对象属性设置为null	yii\base\Object
canGetProperty()	返回一个值指示是否可以读取属性	yii\base\Object
canSetProperty()	返回一个值指示是否可以设置一个属性。	yii\base\Object
className()	返回这个类的完全限定名称。	yii\base\Object
hasMethod()	返回一个值指示是否定义了一个方法.	yii\base\Object
hasProperty()	返回一个值指示是否定义属性。	yii\base\Object
init()	初始化对象。	yii\base\Object

方法详情

__call() public 方法

调用指定的方法而不是一个类方法.

不要直接调用这个方法,因为它是一个PHP魔术方法时将隐式地调用一个未知的方法被调用。

public mixed __call ( $name, $params )
$name	string	方法名
$params	array	方法参数
return	mixed	该方法返回值
throws	yii\base\UnknownMethodException	当调用未知的方法

__construct() public 方法

Constructor.

默认实现做两件事:

• 用给定的配置初始化对象$config.
• Call init().

如果在子类中重写此方法,建议

• 最后一个参数的构造函数是一个配置阵列 $config .
• 调用父实现的构造函数。

public void __construct ( $config = [] )
$config	array	名称-值对将用于初始化对象的属性

__get() public 方法

Returns the value of an object property.

不要直接调用这个方法,因为它是一个PHP魔术方法时将隐式地调用 $value = $object->property;.

参见 __set().

public mixed __get ( $name )
$name	string	属性名
return	mixed	属性值
throws	yii\base\UnknownPropertyException	如果没有定义的属性
throws	yii\base\InvalidCallException	如果只写属性

__isset() public 方法

检查如果属性设置,即定义和not null

不要直接调用这个方法,因为它是一个PHP魔术方法时将隐式地调用执行 isset($object->property).

注意,如果没有定义的属性,将返回false

参见 http://php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name	string	属性名或事件的名称
return	boolean	是否指定的属性设置(非空)。

__set() public 方法

设置对象的属性值。

不要直接调用这个方法,因为它是一个PHP魔术方法时将隐式地调用执行 $object->property = $value;.

参见 __get().

public void __set ( $name, $value )
$name	string	属性名或事件的名称
$value	mixed	属性名或事件的名称
throws	yii\base\UnknownPropertyException	如果没有定义的属性
throws	yii\base\InvalidCallException	如果属性是只读的

__unset() public 方法

对象属性设置为null。

不要直接调用这个方法,因为它是一个PHP魔术方法时将隐式地调用执行 unset($object->property).

注意,如果没有定义的属性,该方法将什么也不做。如果属性是只读的,它会抛出一个异常。

参见 http://php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name	string	The property name
throws	yii\base\InvalidCallException	如果属性是只读的。

canGetProperty() public 方法

返回一个值指示是否可以读取属性。

返回一个值指示是否可以读取属性。

• 相关的类都有一个getter方法指定的名称(在本例中,属性名称不区分大小写);
• 指定名称的类都有一个成员变量( (when $checkVars is true);

参见 canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name	string	属性名
$checkVars	boolean	将成员变量是否为属性
return	boolean	该属性是否可读

canSetProperty() public 方法

返回一个值指示是否可以设置一个属性。

属性是可写的,如果:

• 相关的类都有一个setter方法指定的名称(在本例中,属性名称不区分大小写);
• 指定名称的类都有一个成员变量 (when $checkVars is true);

参见 canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name	string	属性名
$checkVars	boolean	将成员变量是否为属性
return	boolean	该属性是否可以写

className() public static 方法

返回这个类的完全限定名称。

public static string className ( )
return	string	这个类的完全限定名称。

hasMethod() public 方法

返回一个值指示是否定义了一个方法。

默认实现调用php函数method_exists()。你可以重写该方法时执行php魔术方法__call()

public boolean hasMethod ( $name )
$name	string	方法名
return	boolean	是否定义的方法

hasProperty() public 方法

返回一个值指示是否定义属性。

如果定义的属性:

• 类有一个相关联的getter或setter方法指定的名称(在本例中,属性名称不区分大小写);
• 指定名称的类都有一个成员变量 (when $checkVars is true);

参见：

• canGetProperty()
• canSetProperty()

public boolean hasProperty ( $name, $checkVars = true )
$name	string	属性名
$checkVars	boolean	将成员变量是否为属性
return	boolean	是否定义的属性

init() public 方法

初始化对象。

调用该方法的构造函数初始化对象后给定的配置.

public void init ( )

转载于:https://my.oschina.net/u/2552765/blog/855994