0 关注者

类 yii\behaviors\CacheableWidgetBehavior

所有类 | 属性 | 方法
继承关系yii\behaviors\CacheableWidgetBehavior » yii\base\Behavior » yii\base\BaseObject
实现接口yii\base\Configurable
可用版本2.0.14
源代码 https://github.com/yiisoft/yii2/blob/master/framework/behaviors/CacheableWidgetBehavior.php

可缓存小部件行为会根据指定的持续时间和依赖项自动缓存小部件内容。

如果应用程序已配置了 cache 组件，则可以使用该行为而无需任何配置。默认情况下，小部件将缓存一分钟。

以下示例将无限期缓存帖子小部件，直到任何帖子被修改。

use yii\behaviors\CacheableWidgetBehavior;

public function behaviors()
{
    return [
        [
            'class' => CacheableWidgetBehavior::class,
            'cacheDuration' => 0,
            'cacheDependency' => [
                'class' => 'yii\caching\DbDependency',
                'sql' => 'SELECT MAX(updated_at) FROM posts',
            ],
        ],
    ];
}

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$cache yii\caching\CacheInterface|字符串|数组 缓存对象或缓存组件 ID 或用于创建缓存对象的配置数组。 yii\behaviors\CacheableWidgetBehavior
$cacheDependency yii\caching\Dependency|数组|空 缓存依赖项或用于创建缓存依赖项的配置数组，或 null 表示没有缓存依赖项。 yii\behaviors\CacheableWidgetBehavior
$cacheDuration 整数 缓存持续时间（以秒为单位）。 yii\behaviors\CacheableWidgetBehavior
$cacheEnabled 布尔值 是否启用缓存。 yii\behaviors\CacheableWidgetBehavior
$cacheKeyVariations 字符串[]|字符串 一个字符串数组或单个字符串，它会导致缓存内容的变化（例如，应用程序语言、GET 参数）。 yii\behaviors\CacheableWidgetBehavior
$owner yii\base\Component|空 此行为的所有者 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
afterRun() 输出小部件内容并结束片段缓存。 yii\behaviors\CacheableWidgetBehavior
attach() 将行为对象附加到组件。 yii\behaviors\CacheableWidgetBehavior
beforeRun() 开始片段缓存。如果可以从缓存中检索其内容，则阻止所有者小部件执行。 yii\behaviors\CacheableWidgetBehavior
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

属性详情

隐藏继承的属性

$cache 公共属性

缓存对象或缓存组件 ID 或用于创建缓存对象的配置数组。默认为 cache 应用程序组件。

public yii\caching\CacheInterface|字符串|数组 $cache = 'cache'
$cacheDependency 公共属性

缓存依赖项或用于创建缓存依赖项的配置数组，或 null 表示没有缓存依赖项。

例如，

[
    'class' => 'yii\caching\DbDependency',
    'sql' => 'SELECT MAX(updated_at) FROM posts',
]

将使小部件缓存依赖于所有帖子的最后修改时间。如果任何帖子的修改时间发生更改，则缓存的内容将失效。

public yii\caching\Dependency|数组|空 $cacheDependency = null
$cacheDuration 公共属性

缓存持续时间（以秒为单位）。设置为 0 表示缓存数据永不过期。默认为 60 秒或 1 分钟。

public 整数 $cacheDuration = 60
$cacheEnabled 公共属性

是否启用缓存。允许根据特定条件打开和关闭小部件缓存。以下配置将在传递特殊 GET 参数时禁用缓存

empty(Yii::$app->request->get('disable-caching'))
public 布尔值 $cacheEnabled = true
$cacheKeyVariations 公共属性

一个字符串数组或单个字符串，它会导致缓存内容的变化（例如，应用程序语言、GET 参数）。

以下变体设置将导致内容根据当前应用程序语言缓存到不同的版本中

[
    Yii::$app->language,
]
public 字符串[]|字符串 $cacheKeyVariations = []

方法详情

隐藏继承的方法

__call() 公共方法

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

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

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用。

public 混合 __call ( $name, $params )
$name 字符串

方法名称
$params 数组

方法参数
返回值 混合

方法返回值
抛出 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 数组

将用于初始化对象属性的名称-值对

 

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

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

返回对象属性的值。

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

另请参阅 __set()。

public 混合 __get ( $name )
$name 字符串

属性名称
返回值 混合

属性值
抛出 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 布尔值 __isset ( $name )
$name 字符串

属性名称或事件名称
返回值 布尔值

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

 

                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 字符串

属性名称或事件名称
$value 混合

属性值
抛出 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 字符串

属性名称
抛出 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);
    }
}
afterRun() 公共方法

输出小部件内容并结束片段缓存。

public void afterRun ( $event )
$event yii\base\WidgetEvent

Widget::EVENT_AFTER_RUN 事件。

 

                public function afterRun($event)
{
    echo $event->result;
    $event->result = null;
    $this->owner->view->endCache();
}
attach() 公共方法

将行为对象附加到组件。

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

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

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

 

                public function attach($owner)
{
    parent::attach($owner);
    $this->initializeEventHandlers();
}
beforeRun() 公共方法

开始片段缓存。如果可以从缓存中检索其内容，则阻止所有者小部件执行。

public void beforeRun ( $event )
$event yii\base\WidgetEvent

Widget::EVENT_BEFORE_RUN 事件。

 

                public function beforeRun($event)
{
    $cacheKey = $this->getCacheKey();
    $fragmentCacheConfiguration = $this->getFragmentCacheConfiguration();
    if (!$this->owner->view->beginCache($cacheKey, $fragmentCacheConfiguration)) {
        $event->isValid = false;
    }
}
canGetProperty() 公共方法

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

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

如果属性是可读的

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

另请参阅 canSetProperty()。

public 布尔值 canGetProperty ( $name, $checkVars = true )
$name 字符串

属性名称
$checkVars 布尔值

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

属性是否可读

 

                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 字符串

属性名称
$checkVars 布尔值

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

属性是否可写

 

                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 ( )
返回值 字符串

此类的完全限定名称。

 

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

定义于： yii\base\Behavior::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() 公共方法

定义于： yii\base\Behavior::events()

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

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

当行为附加到所有者时，回调将附加到 $owner 的事件；当行为从组件分离时，它们将从事件中分离。

回调可以是以下任何一种：

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

以下是一个示例

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

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

 

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

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

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

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

public boolean hasMethod ( $name )
$name 字符串

方法名称
返回值 布尔值

方法是否已定义

 

                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 字符串

属性名称
$checkVars 布尔值

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

属性是否已定义

 

                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()
{
}