类 yii\base\BaseObject
BaseObject 是实现属性特性的基类。
属性由 getter 方法（例如 getLabel）和/或 setter 方法（例如 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() 来检查属性是否存在。
除了属性特性外，BaseObject 还引入了重要的对象初始化生命周期。特别是，创建 BaseObject 或其派生类的新的实例将依次涉及以下生命周期
- 调用类构造函数；
- 根据给定的配置初始化对象属性；
- 调用
init()方法。
在上述中，步骤 2 和 3 都发生在类构造函数的末尾。建议您在 init() 方法中执行对象初始化，因为在此阶段，对象配置已应用。
为了确保上述生命周期，如果 BaseObject 的子类需要覆盖构造函数，则应像以下方式进行
public function __construct($param1, $param2, ..., $config = [])
{
...
parent::__construct($config);
}
也就是说，$config 参数（默认为 []）应声明为构造函数的最后一个参数，并且应在构造函数的末尾调用父类的实现。
公共方法
| 方法 | 描述 | 定义于 |
|---|---|---|
| __call() | 调用不是类方法的命名方法。 | yii\base\BaseObject |
| __construct() | 构造函数。 | yii\base\BaseObject |
| __get() | 返回对象属性的值。 | yii\base\BaseObject |
| __isset() | 检查属性是否已设置，即已定义且不为 null。 | yii\base\BaseObject |
| __set() | 设置对象属性的值。 | yii\base\BaseObject |
| __unset() | 将对象属性设置为 null。 | yii\base\BaseObject |
| canGetProperty() | 返回一个值，指示属性是否可以读取。 | yii\base\BaseObject |
| canSetProperty() | 返回一个值，指示属性是否可以设置。 | yii\base\BaseObject |
| className() | 返回此类的完全限定名称。 | yii\base\BaseObject |
| hasMethod() | 返回一个值，指示方法是否已定义。 | yii\base\BaseObject |
| hasProperty() | 返回一个值，指示属性是否已定义。 | yii\base\BaseObject |
| init() | 初始化对象。 | yii\base\BaseObject |
方法详情
调用不是类方法的命名方法。
不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时将隐式调用。
| public mixed __call ( $name, $params ) | ||
| $name | string |
方法名 |
| $params | array |
方法参数 |
| 返回值 | mixed |
方法返回值 |
|---|---|---|
| 抛出异常 | yii\base\UnknownMethodException |
调用未知方法时 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
构造函数。
默认实现执行两件事
- 使用给定的配置
$config初始化对象。 - 调用 init()。
如果此方法在子类中被覆盖，建议
- 构造函数的最后一个参数是一个配置数组，如这里的
$config。 - 在构造函数的末尾调用父类的实现。
| public void __construct ( $config = [] ) | ||
| $config | array |
将用于初始化对象属性的名称-值对 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
| public mixed __get ( $name ) | ||
| $name | string |
属性名 |
| 返回值 | mixed |
属性值 |
|---|---|---|
| 抛出异常 | yii\base\UnknownPropertyException |
如果属性未定义 |
| 抛出异常 | yii\base\InvalidCallException |
如果属性是只写属性 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
检查属性是否已设置，即已定义且不为 null。
不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 isset($object->property) 时将隐式调用。
请注意，如果属性未定义，则将返回 false。
| public 布尔型 __isset ( $name ) | ||
| $name | string |
属性名称或事件名称 |
| 返回值 | 布尔型 |
命名属性是否已设置（非 null）。 |
|---|---|---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
| public void __set ( $name, $value ) | ||
| $name | string |
属性名称或事件名称 |
| $value | mixed |
属性值 |
| 抛出异常 | yii\base\UnknownPropertyException |
如果属性未定义 |
|---|---|---|
| 抛出异常 | yii\base\InvalidCallException |
如果属性为只读 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
将对象属性设置为 null。
不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 unset($object->property) 时将隐式调用。
请注意，如果属性未定义，则此方法将不执行任何操作。如果属性为只读，则会抛出异常。
| public void __unset ( $name ) | ||
| $name | string |
属性名 |
| 抛出异常 | yii\base\InvalidCallException |
如果属性为只读。 |
|---|---|---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
返回一个值，指示属性是否可以读取。
如果属性可读，则
- 该类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
- 该类具有与指定名称相同的成员变量（当
$checkVars为 true 时）；
另请参阅 canSetProperty()。
| public 布尔型 canGetProperty ( $name, $checkVars = true ) | ||
| $name | string |
属性名 |
| $checkVars | 布尔型 |
是否将成员变量视为属性 |
| 返回值 | 布尔型 |
属性是否可读 |
|---|---|---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
返回一个值，指示属性是否可以设置。
如果属性可写，则
- 该类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
- 该类具有与指定名称相同的成员变量（当
$checkVars为 true 时）；
另请参阅 canGetProperty()。
| public 布尔型 canSetProperty ( $name, $checkVars = true ) | ||
| $name | string |
属性名 |
| $checkVars | 布尔型 |
是否将成员变量视为属性 |
| 返回值 | 布尔型 |
属性是否可写 |
|---|---|---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class。
返回此类的完全限定名称。
| public static 字符串 className ( ) | ||
| 返回值 | string |
此类的完全限定名称。 |
|---|---|---|
public static function className()
{
return get_called_class();
}
返回一个值，指示方法是否已定义。
默认实现是调用 php 函数 method_exists()。当您实现 php 魔术方法 __call() 时，您可以重写此方法。
| public 布尔型 hasMethod ( $name ) | ||
| $name | string |
方法名 |
| 返回值 | 布尔型 |
方法是否已定义 |
|---|---|---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
返回一个值，指示属性是否已定义。
如果属性已定义，则
- 该类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
- 该类具有与指定名称相同的成员变量（当
$checkVars为 true 时）；
另请参阅
| public 布尔型 hasProperty ( $name, $checkVars = true ) | ||
| $name | string |
属性名 |
| $checkVars | 布尔型 |
是否将成员变量视为属性 |
| 返回值 | 布尔型 |
属性是否已定义 |
|---|---|---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
请 注册 或 登录 以发表评论。