0 关注者

类 yii\base\Behavior

所有类 | 属性 | 方法
继承关系yii\base\Behavior » yii\base\BaseObject
实现yii\base\Configurable
子类yii\base\ActionFilter, yii\behaviors\AttributeBehavior, yii\behaviors\AttributeTypecastBehavior, yii\behaviors\AttributesBehavior, yii\behaviors\BlameableBehavior, yii\behaviors\CacheableWidgetBehavior, yii\behaviors\OptimisticLockBehavior, yii\behaviors\SluggableBehavior, yii\behaviors\TimestampBehavior, yii\filters\AccessControl, yii\filters\AjaxFilter, yii\filters\ContentNegotiator, yii\filters\Cors, yii\filters\HostControl, yii\filters\HttpCache, yii\filters\PageCache, yii\filters\RateLimiter, yii\filters\VerbFilter, yii\filters\auth\AuthMethod, yii\filters\auth\CompositeAuth, yii\filters\auth\HttpBasicAuth, yii\filters\auth\HttpBearerAuth, yii\filters\auth\HttpHeaderAuth, yii\filters\auth\QueryParamAuth
版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/base/Behavior.php

Behavior 是所有行为类的基类。

行为可以用来增强现有组件的功能，而无需修改其代码。 尤其，它可以将自己的方法和属性“注入”到组件中，并通过组件直接访问它们。 它还可以响应组件触发的事件，从而拦截正常的代码执行。

有关 Behavior 的更多详细信息和用法信息，请参阅 有关行为的指南文章。

公共属性

隐藏继承属性

属性 类型 描述 定义类
$owner yii\base\Component|null 此行为的所有者 yii\base\Behavior

公共方法

隐藏继承方法

方法 描述 定义类
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置，即已定义且不为空。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
attach() 将行为对象附加到组件。 yii\base\Behavior
canGetProperty() 返回一个值，指示属性是否可读。 yii\base\BaseObject
canSetProperty() 返回一个值，指示属性是否可写。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
detach() 将行为对象从组件分离。 yii\base\Behavior
events() 为 $owner 的事件声明事件处理程序。 yii\base\Behavior
hasMethod() 返回一个值，指示是否定义了方法。 yii\base\BaseObject
hasProperty() 返回一个值，指示是否定义了属性。 yii\base\BaseObject
init() 初始化对象。 yii\base\BaseObject

属性详情

隐藏继承属性

$owner 公共属性

此行为的所有者

public yii\base\Component|null $owner = null

方法详情

隐藏继承方法

__call() 公共方法

定义于: yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法，因为它是一个 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()");
}
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()。

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

  • 构造函数的最后一个参数是配置数组，就像这里的 $config。
  • 在构造函数的末尾调用父级实现。
public void __construct ( $config = [] )
$config array

将用于初始化对象属性的键值对

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() 公共方法

定义于： yii\base\BaseObject::__get()

返回对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，会在执行 $value = $object->property; 时隐式调用。

另请参阅 __set().

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);
}
__isset() 公共方法

定义于： yii\base\BaseObject::__isset()

检查属性是否已设置，即已定义且不为空。

不要直接调用此方法，因为它是一个 PHP 魔术方法，会在执行 isset($object->property) 时隐式调用。

注意，如果属性未定义，将返回 false。

另请参阅 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称
返回值 boolean

命名的属性是否已设置（非 null）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公共方法

定义于： yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，会在执行 $object->property = $value; 时隐式调用。

另请参阅 __get().

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);
    }
}
__unset() 公共方法

定义于： yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法，因为它是一个 PHP 魔术方法，会在执行 unset($object->property) 时隐式调用。

注意，如果属性未定义，此方法将不执行任何操作。如果属性为只读，则会抛出异常。

另请参阅 https://php.ac.cn/manual/en/function.unset.php.

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);
    }
}
attach() 公共方法

将行为对象附加到组件。

默认实现将设置 $owner 属性，并按照 events() 中声明的方式附加事件处理程序。如果你重写此方法，请确保调用父实现。

public void attach ( $owner )
$owner yii\base\Component

要将此行为附加到的组件。

 

                public function attach($owner)
{
    $this->owner = $owner;
    foreach ($this->events() as $event => $handler) {
        $this->_attachedEvents[$event] = $handler;
        $owner->on($event, is_string($handler) ? [$this, $handler] : $handler);
    }
}
canGetProperty() 公共方法

定义于： yii\base\BaseObject::canGetProperty()

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

如果属性可读，则

  • 该类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称匹配的成员变量（当 $checkVars 为 true 时）；

另请参阅 canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

该属性是否可读

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() 公共方法

定义于： yii\base\BaseObject::canSetProperty()

返回一个值，指示属性是否可写。

如果属性可写，则

  • 该类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称匹配的成员变量（当 $checkVars 为 true 时）；

另请参阅 canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

该属性是否可写

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 上，请使用 ::class 代替。

定义于： yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detach() 公共方法

将行为对象从组件分离。

默认实现将取消设置 $owner 属性，并分离 events() 中声明的事件处理程序。如果你重写此方法，请确保调用父实现。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        foreach ($this->_attachedEvents as $event => $handler) {
            $this->owner->off($event, is_string($handler) ? [$this, $handler] : $handler);
        }
        $this->_attachedEvents = [];
        $this->owner = null;
    }
}
events() 公共方法

为 $owner 的事件声明事件处理程序。

子类可以重写此方法来声明应附加到 $owner 组件事件的 PHP 回调函数。

回调函数将在行为附加到所有者时附加到 $owner 的事件；并在行为从组件分离时从事件中分离。

回调函数可以是以下任何一种

  • 此行为中的方法：'handleClick'，等效于 [$this, 'handleClick']
  • 对象方法：[$object, 'handleClick']
  • 静态方法：['Page', 'handleClick']
  • 匿名函数：function ($event) { ... }

以下是一个示例

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
返回值 array

事件（数组键）和相应的事件处理程序方法（数组值）。

 

                public function events()
{
    return [];
}
hasMethod() 公共方法

定义于： yii\base\BaseObject::hasMethod()

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

默认实现是调用 php 函数 method_exists()。当实现 php 魔术方法 __call() 时，你可以重写此方法。

public boolean hasMethod ( $name )
$name string

方法名
返回值 boolean

该方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

定义于: yii\base\BaseObject::hasProperty()

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

如果定义了属性，则：

  • 类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称匹配的成员变量（当 $checkVars 为 true 时）；

另请参见

public boolean hasProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否已定义

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公共方法

定义于: yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束后被调用，此时对象已使用给定的配置初始化。

public void init ( )

                public function init()
{
}