0 关注者

类 yii\widgets\FragmentCache

继承关系yii\widgets\FragmentCache » yii\base\Widget » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable, yii\base\DynamicContentAwareInterface, yii\base\ViewContextInterface
使用 Traitsyii\base\DynamicContentAwareTrait
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/widgets/FragmentCache.php

FragmentCache 用于 yii\base\View 提供页面片段缓存。

公有属性

隐藏继承属性

属性 类型 描述 定义于
$autoIdPrefix string 自动生成的部件 ID 的前缀。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$cache yii\caching\CacheInterface|数组|字符串 缓存对象或缓存对象的应用程序组件 ID。 yii\widgets\FragmentCache
$cachedContent 字符串|布尔值 false 缓存的内容。 yii\widgets\FragmentCache
$dependency 数组|yii\caching\Dependency 缓存内容依赖的依赖项。 yii\widgets\FragmentCache
$duration integer 数据在缓存中保持有效的时间(秒)。 yii\widgets\FragmentCache
$dynamicPlaceholders array 占位符列表。 yii\base\DynamicContentAwareTrait
$enabled boolean 是否启用片段缓存。 yii\widgets\FragmentCache
$id 字符串|null 部件的 ID。 yii\base\Widget
$variations 字符串[]|字符串 导致缓存内容变化的因素列表。 yii\widgets\FragmentCache
$view yii\web\View 可用于渲染视图或视图文件的视图对象。 yii\base\Widget
$viewPath string 包含此部件视图文件的目录。 yii\base\Widget

公有方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即已定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
addDynamicPlaceholder() 添加动态内容的占位符。 yii\base\DynamicContentAwareTrait
afterRun() 此方法在部件执行后立即调用。 yii\base\Widget
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
beforeRun() 此方法在部件执行前立即调用。 yii\base\Widget
begin() 开始一个部件。 yii\base\Widget
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
end() 结束一个部件。 yii\base\Widget
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getCachedContent() 如果可用,则返回缓存的内容。 yii\widgets\FragmentCache
getDynamicPlaceholders() 返回动态内容的占位符列表。此方法用于在内部实现内容缓存功能。 yii\base\DynamicContentAwareTrait
getId() 返回部件的 ID。 yii\base\Widget
getViewPath() 返回包含此部件视图文件的目录。 yii\base\Widget
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化 FragmentCache 对象。 yii\widgets\FragmentCache
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
render() 渲染视图。 yii\base\Widget
renderFile() 渲染视图文件。 yii\base\Widget
run() 标记要缓存的内容的结尾。 yii\widgets\FragmentCache
setDynamicPlaceholders() 设置动态内容的占位符列表。此方法用于在内部实现内容缓存功能。 yii\base\DynamicContentAwareTrait
setId() 设置部件的 ID。 yii\base\Widget
setView() 设置此部件要使用的视图对象。 yii\base\Widget
trigger() 触发事件。 yii\base\Component
widget() 创建部件实例并运行它。 yii\base\Widget

保护方法

隐藏继承方法

方法 描述 定义于
calculateKey() 生成用于将内容存储在缓存中的唯一键。 yii\widgets\FragmentCache
getView() 返回可用于使用动态内容渲染视图或视图文件的视图对象。 yii\base\DynamicContentAwareTrait
updateDynamicContent() 用已评估的动态语句的结果替换 $content 中的占位符。 yii\base\DynamicContentAwareTrait

事件

隐藏继承事件

事件 类型 描述 定义于
EVENT_AFTER_RUN yii\base\WidgetEvent 在执行部件后立即引发的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在执行部件前立即引发的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_INIT yii\base\Event 通过 init() 初始化部件时触发的事件。(自版本 2.0.11 起可用) yii\base\Widget

属性详情

隐藏继承属性

$cache 公有属性

缓存对象或缓存对象的应用程序组件 ID。创建 FragmentCache 对象后,如果要更改此属性,则应仅将其分配给缓存对象。从版本 2.0.2 开始,这也可以是用于创建对象的配置数组。

$cachedContent 公共属性

缓存的内容。如果在缓存中找不到有效内容,则返回 false。

$dependency 公共属性

缓存内容所依赖的依赖项。这可以是 yii\caching\Dependency 对象或用于创建依赖项对象的配置数组。例如,

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

将使输出缓存依赖于所有帖子的最后修改时间。如果任何帖子的修改时间发生变化,则缓存的内容将失效。

$duration 公共属性

数据在缓存中保持有效的时间(秒)。使用 0 表示缓存数据永不过期。

public 整数 $duration 60
$enabled 公共属性

是否启用片段缓存。您可以使用此属性根据特定设置打开和关闭片段缓存(例如,仅对 GET 请求启用片段缓存)。

public 布尔值 $enabled true
$variations 公共属性

导致缓存内容变化的因素列表。每个因素都是一个表示变化的字符串(例如语言、GET 参数)。以下变化设置将导致内容根据当前应用程序语言缓存到不同的版本中

[
    Yii::$app->language,
]

方法详情

隐藏继承方法

__call() 公共方法

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

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

此方法将检查任何附加的行为是否具有指定名称的方法,如果可用则执行它。

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

public 混合类型 __call ( $name, $params )
$name string

方法名

$params array

方法参数

返回值 混合类型

方法返回值

抛出异常 yii\base\UnknownMethodException

调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后被调用。

它删除所有行为,因为它们附加到旧对象上。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__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\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地采取行动

  • 由 getter 定义的属性:返回 getter 的结果
  • 行为的属性:返回行为属性值

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

另请参见 __set()

public 混合类型 __get ( $name )
$name string

属性名称

返回值 混合类型

属性值或行为属性的值

抛出异常 yii\base\UnknownPropertyException

如果未定义属性

抛出异常 yii\base\InvalidCallException

如果属性为只写。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (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\Component::__isset()

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

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性返回 false

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

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

public 布尔值 __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

指定的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:设置属性值
  • “on xyz”格式的事件:将处理程序附加到事件“xyz”

  • 以 "as xyz" 格式表示的行为:附加名为 "xyz" 的行为。
  • 行为的属性:设置行为属性值。

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

另请参阅 __get()

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value 混合类型

属性值。

抛出异常 yii\base\UnknownPropertyException

如果未定义属性

抛出异常 yii\base\InvalidCallException

如果属性为只读。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:将属性值设置为 null。
  • 行为的属性:将属性值设置为 null。

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($component->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);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addDynamicPlaceholder() 公共方法

定义于: yii\base\DynamicContentAwareTrait::addDynamicPlaceholder()

添加动态内容的占位符。

此方法用于内部实现内容缓存功能。

public void addDynamicPlaceholder ( $name, $statements )
$name string

占位符名称。

$statements string

用于生成动态内容的 PHP 语句。

                public function addDynamicPlaceholder($name, $statements)
{
    $this->_dynamicPlaceholders[$name] = $statements;
}

            
afterRun() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::afterRun()

此方法在部件执行后立即调用。

此方法将触发 EVENT_AFTER_RUN 事件。此方法的返回值将用作小部件的返回值。

如果覆盖此方法,则代码应如下所示

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
public mixed afterRun ( $result )
$result 混合类型

小部件返回结果。

返回值 混合类型

已处理的小部件结果。

                public function afterRun($result)
{
    $event = new WidgetEvent();
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_RUN, $event);
    return $event->result;
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参阅 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior 字符串|数组|yii\base\Behavior

行为配置。可以是以下之一:

返回值 yii\base\Behavior

行为对象。

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引,并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或一个用于创建行为的配置数组。

另请参阅 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表。

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeRun() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::beforeRun()

此方法在部件执行前立即调用。

此方法将触发 EVENT_BEFORE_RUN 事件。此方法的返回值将确定小部件是否应继续运行。

覆盖此方法时,请确保调用父实现,如下所示

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}
public 布尔值 beforeRun ( )
返回值 boolean

小部件是否应继续执行。

                public function beforeRun()
{
    $event = new WidgetEvent();
    $this->trigger(self::EVENT_BEFORE_RUN, $event);
    return $event->isValid;
}

            
begin() 公共静态方法

定义于: yii\base\Widget::begin()

开始一个部件。

此方法创建调用类的实例。它将配置应用于创建的实例。稍后应调用匹配的 end() 调用。由于某些小部件可能使用输出缓冲,因此应在同一视图中进行 end() 调用,以避免破坏输出缓冲的嵌套。

另请参阅 end()

public static static begin ( $config = [] )
$config array

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

返回值 yii\base\Widget

新创建的小部件实例。

                public static function begin($config = [])
{
    $config['class'] = get_called_class();
    /* @var $widget Widget */
    $widget = Yii::createObject($config);
    self::$stack[] = $widget;
    return $widget;
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以覆盖此方法以指定它们希望表现为的行为。

此方法的返回值应为行为对象或配置的数组,由行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当数组键使用名称时,使用此名称,稍后可以使用 getBehavior() 检索行为,或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

在此方法中声明的行为将自动附加到组件(按需)。

public 数组 behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
calculateKey() 受保护的方法

生成用于将内容存储在缓存中的唯一键。

生成的键取决于 $id$variations

protected mixed calculateKey ( )
返回值 混合类型

一个有效的缓存键。

                protected function calculateKey()
{
    return array_merge([__CLASS__, $this->getId()], (array)$this->variations);
}

            
canGetProperty() 公有方法

定义于: yii\base\Component::canGetProperty()

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

如果属性可读,则满足以下条件:

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

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

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公有方法

定义于: yii\base\Component::canSetProperty()

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

如果属性可写,则满足以下条件:

  • 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

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

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

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

            
detachBehavior() 公有方法

定义于: yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公有方法

定义于: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
end() 公有静态方法

定义于: yii\base\Widget::end()

结束一个部件。

请注意,小部件的渲染结果会直接输出。

另请参阅 begin()

public static static end ( )
返回值 yii\base\Widget

结束的小部件实例。

抛出异常 yii\base\InvalidCallException

如果 begin()end() 调用未正确嵌套

                public static function end()
{
    if (!empty(self::$stack)) {
        $widget = array_pop(self::$stack);
        $calledClass = get_called_class();
        if (Yii::$container->has($calledClass) && isset(Yii::$container->getDefinitions()[$calledClass]['class'])) {
            $calledClass = Yii::$container->getDefinitions()[$calledClass]['class'];
        }
        if (get_class($widget) === $calledClass) {
            /* @var $widget Widget */
            if ($widget->beforeRun()) {
                $result = $widget->run();
                $result = $widget->afterRun($result);
                echo $result;
            }
            return $widget;
        }
        throw new InvalidCallException('Expecting end() of ' . get_class($widget) . ', found ' . get_called_class());
    }
    throw new InvalidCallException('Unexpected ' . get_called_class() . '::end() call. A matching begin() is not found.');
}

            
ensureBehaviors() 公有方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() 公有方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在,则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公有方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getCachedContent() 公有方法

如果可用,则返回缓存的内容。

public string|false getCachedContent ( )
返回值 字符串|布尔值 false

缓存的内容。如果在缓存中找不到有效内容,则返回 false。

                public function getCachedContent()
{
    if ($this->_content !== null) {
        return $this->_content;
    }
    $this->_content = false;
    if (!($this->cache instanceof CacheInterface)) {
        return $this->_content;
    }
    $key = $this->calculateKey();
    $data = $this->cache->get($key);
    if (!is_array($data) || count($data) !== 2) {
        return $this->_content;
    }
    list($this->_content, $placeholders) = $data;
    if (!is_array($placeholders) || count($placeholders) === 0) {
        return $this->_content;
    }
    $this->_content = $this->updateDynamicContent($this->_content, $placeholders, true);
    return $this->_content;
}

            
getDynamicPlaceholders() 公有方法

定义于: yii\base\DynamicContentAwareTrait::getDynamicPlaceholders()

返回动态内容的占位符列表。此方法用于在内部实现内容缓存功能。

public array getDynamicPlaceholders ( )
返回值 array

占位符列表。

                public function getDynamicPlaceholders()
{
    return $this->_dynamicPlaceholders;
}

            
getId() 公有方法

定义于: yii\base\Widget::getId()

返回部件的 ID。

public string|null getId ( $autoGenerate true )
$autoGenerate boolean

是否在之前未设置 ID 时生成 ID

返回值 字符串|null

部件的 ID。

                public function getId($autoGenerate = true)
{
    if ($autoGenerate && $this->_id === null) {
        $this->_id = static::$autoIdPrefix . static::$counter++;
    }
    return $this->_id;
}

            
getView() 受保护的抽象方法

定义于: yii\base\DynamicContentAwareTrait::getView()

返回可用于使用动态内容渲染视图或视图文件的视图对象。

受保护的抽象 yii\base\View getView ( )
返回值 yii\base\View

可用于渲染视图或视图文件的视图对象。

                abstract protected function getView();

            
getViewPath() 公共方法

定义于: yii\base\Widget::getViewPath()

返回包含此部件视图文件的目录。

默认实现返回包含小部件类文件的目录下的“views”子目录。

公共的 string getViewPath ( )
返回值 string

包含此部件视图文件的目录。

                public function getViewPath()
{
    $class = new ReflectionClass($this);
    return dirname($class->getFileName()) . DIRECTORY_SEPARATOR . 'views';
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名的事件。

公共的 boolean hasEventHandlers ( $name )
$name string

事件名称

返回值 boolean

是否存在任何附加到事件的处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

定义于: yii\base\Component::hasMethod()

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

如果定义了方法

  • 该类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当$checkBehaviors为 true 时)。
公共的 boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

返回值 boolean

方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

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

返回一个值,指示是否为此组件定义了属性。

如果定义了属性

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当$checkBehaviors为 true 时)。

另请参阅

公共的 boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() 公共方法

初始化 FragmentCache 对象。

公共的 void init ( )

                public function init()
{
    parent::init();
    $this->cache = $this->enabled ? Instance::ensure($this->cache, 'yii\caching\CacheInterface') : null;
    if ($this->cache instanceof CacheInterface && $this->getCachedContent() === false) {
        $this->getView()->pushDynamicContent($this);
        ob_start();
        ob_implicit_flush(false);
    }
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件中分离现有的事件处理程序。

此方法与on()相反。

注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

公共的 boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

要删除的事件处理程序。如果为 null,则将删除附加到命名事件的所有处理程序。

返回值 boolean

如果找到并分离了处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中$event是一个yii\base\Event对象,其中包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()

公共的 void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler callable

事件处理程序

$data 混合类型

触发事件时要传递给事件处理程序的数据。当调用事件处理程序时,可以通过yii\base\Event::$data访问此数据。

$append boolean

是否将新的事件处理程序附加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
render() 公共方法

定义于: yii\base\Widget::render()

渲染视图。

要渲染的视图可以以下列格式之一指定

  • 路径别名(例如,“@app/views/site/index”);
  • 应用程序内的绝对路径(例如,“//site/index”):视图名称以双斜杠开头。实际的视图文件将在应用程序的视图路径下查找。
  • 模块内的绝对路径(例如,“/site/index”):视图名称以单个斜杠开头。实际的视图文件将在当前活动模块的视图路径下查找。
  • 相对路径(例如,“index”):实际的视图文件将在$viewPath下查找。

如果视图名称不包含文件扩展名,则将使用默认扩展名.php

公共的 string render ( $view, $params = [] )
$view string

视图名称。

$params array

应在视图中提供的参数(名称-值对)。

返回值 string

渲染结果。

抛出异常 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function render($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
renderFile() 公共方法

定义于: yii\base\Widget::renderFile()

渲染视图文件。

公共的 string renderFile ( $file, $params = [] )
$file string

要渲染的视图文件。这可以是文件路径或路径别名

$params array

应在视图中提供的参数(名称-值对)。

返回值 string

渲染结果。

抛出异常 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
run() 公共方法

标记要缓存的内容的结尾。

在此方法调用之前和 init() 之后显示的内容将被捕获并保存到缓存中。如果缓存中已找到有效内容,则此方法不执行任何操作。

public void run ( )

                public function run()
{
    if (($content = $this->getCachedContent()) !== false) {
        echo $content;
    } elseif ($this->cache instanceof CacheInterface) {
        $this->getView()->popDynamicContent();
        $content = ob_get_clean();
        if ($content === false || $content === '') {
            return;
        }
        if (is_array($this->dependency)) {
            $this->dependency = Yii::createObject($this->dependency);
        }
        $data = [$content, $this->getDynamicPlaceholders()];
        $this->cache->set($this->calculateKey(), $data, $this->duration, $this->dependency);
        echo $this->updateDynamicContent($content, $this->getDynamicPlaceholders());
    }
}

            
setDynamicPlaceholders() 公共方法

定义于: yii\base\DynamicContentAwareTrait::setDynamicPlaceholders()

设置动态内容的占位符列表。此方法用于在内部实现内容缓存功能。

public void setDynamicPlaceholders ( $placeholders )
$placeholders array

占位符列表。

                public function setDynamicPlaceholders($placeholders)
{
    $this->_dynamicPlaceholders = $placeholders;
}

            
setId() 公共方法

定义于: yii\base\Widget::setId()

设置部件的 ID。

public void setId ( $value )
$value string

小部件的 ID。

                public function setId($value)
{
    $this->_id = $value;
}

            
setView() 公共方法

定义于: yii\base\Widget::setView()

设置此部件要使用的视图对象。

public void setView ( $view )
$view yii\base\View

可用于渲染视图或视图文件的视图对象。

                public function setView($view)
{
    $this->_view = $view;
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
updateDynamicContent() 受保护方法

定义于: yii\base\DynamicContentAwareTrait::updateDynamicContent()

用已评估的动态语句的结果替换 $content 中的占位符。

protected string updateDynamicContent ( $content, $placeholders, $isRestoredFromCache false )
$content string

要解析的内容。

$placeholders string[]

占位符及其值。

$isRestoredFromCache boolean

内容是否将从缓存中恢复。

返回值 string

最终内容。

                protected function updateDynamicContent($content, $placeholders, $isRestoredFromCache = false)
{
    if (empty($placeholders) || !is_array($placeholders)) {
        return $content;
    }
    if (count($this->getView()->getDynamicContents()) === 0) {
        // outermost cache: replace placeholder with dynamic content
        foreach ($placeholders as $name => $statements) {
            $placeholders[$name] = $this->getView()->evaluateDynamicContent($statements);
        }
        $content = strtr($content, $placeholders);
    }
    if ($isRestoredFromCache) {
        $view = $this->getView();
        foreach ($placeholders as $name => $statements) {
            $view->addDynamicPlaceholder($name, $statements);
        }
    }
    return $content;
}

            
widget() 公共静态方法

定义于: yii\base\Widget::widget()

创建部件实例并运行它。

此方法返回小部件的渲染结果。

public static string widget ( $config = [] )
$config array

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

返回值 string

小部件的渲染结果。

抛出异常 可抛出异常

                public static function widget($config = [])
{
    ob_start();
    ob_implicit_flush(false);
    try {
        /* @var $widget Widget */
        $config['class'] = get_called_class();
        $widget = Yii::createObject($config);
        $out = '';
        if ($widget->beforeRun()) {
            $result = $widget->run();
            $out = $widget->afterRun($result);
        }
    } catch (\Exception $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    } catch (\Throwable $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    }
    return ob_get_clean() . $out;
}