0 关注者

类 yii\caching\ApcCache

继承关系yii\caching\ApcCache » yii\caching\Cache » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\caching\CacheInterface
版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/caching/ApcCache.php

ApcCache 提供了基于 APC 的缓存机制,以应用程序组件的形式实现。

要使用此应用程序组件,必须加载 APC PHP 扩展。或者,可以通过将 useApcu 设置为 true 来使用 APCu PHP 扩展。为了在 CLI 中启用 APC 或 APCu,您应该在您的 php.ini 中添加 "apc.enable_cli = 1"。

有关 ApcCache 支持的常用缓存操作,请参见 yii\caching\Cache

有关缓存的更多详细信息和使用信息,请参见 缓存指南

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$defaultDuration integer 缓存条目过期之前的默认持续时间,以秒为单位。 yii\caching\Cache
$keyPrefix string 添加到每个缓存键的字符串前缀,以确保其在整个缓存存储中全局唯一。 yii\caching\Cache
$serializer array|null|false 用于序列化和反序列化缓存数据的函数。 yii\caching\Cache
$useApcu boolean 是否使用 apcu 或 apc 作为底层缓存扩展。如果为 true,则使用 apcu。如果为 false,则使用 apc。默认值为 false。 yii\caching\ApcCache

公共方法

隐藏继承的方法

方法 描述 定义于
__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
add() 如果缓存不包含此键,则将标识为键的值存储到缓存中。 yii\caching\Cache
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现出的行为列表。 yii\base\Component
buildKey() 从给定的键构建规范化的缓存键。 yii\caching\Cache
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
delete() 从缓存中删除具有指定键的值。 yii\caching\Cache
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
exists() 检查指定的键是否存在于缓存中。 yii\caching\ApcCache
flush() 删除缓存中的所有值。 yii\caching\Cache
get() 使用指定键从缓存中检索值。 yii\caching\Cache
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getOrSet() 该方法结合了 set()get() 方法来检索标识为 $key 的值,或者如果 $key 没有可用的缓存,则存储 $callable 执行的结果。 yii\caching\Cache
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示是否定义了方法。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化此应用程序组件。 yii\caching\ApcCache
madd() 将多项存储在缓存中。每个项目都包含标识为键的值。 yii\caching\Cache
mget() 使用指定的键从缓存中检索多个值。 yii\caching\Cache
mset() 将多项存储在缓存中。每个项目都包含标识为键的值。 yii\caching\Cache
multiAdd() 将多项存储在缓存中。每个项目都包含标识为键的值。 yii\caching\Cache
multiGet() 使用指定的键从缓存中检索多个值。 yii\caching\Cache
multiSet() 将多项存储在缓存中。每个项目都包含标识为键的值。 yii\caching\Cache
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
offsetExists() 返回是否有一个具有指定键的缓存条目。 yii\caching\Cache
offsetGet() 使用指定键从缓存中检索值。 yii\caching\Cache
offsetSet() 将标识为键的值存储到缓存中。 yii\caching\Cache
offsetUnset() 从缓存中删除具有指定键的值 此方法是接口 ArrayAccess 所必需的。 yii\caching\Cache
on() 将事件处理程序附加到事件。 yii\base\Component
set() 将标识为键的值存储到缓存中。 yii\caching\Cache
trigger() 触发事件。 yii\base\Component

受保护的方法

隐藏继承的方法

方法 描述 定义于
addValue() 如果缓存不包含此键,则将标识为键的值存储到缓存中。 yii\caching\ApcCache
addValues() 将多个键值对添加到缓存中。 yii\caching\ApcCache
deleteValue() 从缓存中删除具有指定键的值 这是父类中声明的方法的实现。 yii\caching\ApcCache
flushValues() 删除缓存中的所有值。 yii\caching\ApcCache
getValue() 使用指定键从缓存中检索值。 yii\caching\ApcCache
getValues() 使用指定的键从缓存中检索多个值。 yii\caching\ApcCache
setValue() 将标识为键的值存储到缓存中。 yii\caching\ApcCache
setValues() 将多个键值对存储在缓存中。 yii\caching\ApcCache

属性详情

隐藏继承的属性

$useApcu 公共属性 (自版本 2.0.7 起可用)

是否使用 apcu 或 apc 作为底层缓存扩展。如果为 true,则使用 apcu。如果为 false,则使用 apc。默认值为 false。

public boolean $useApcu false

方法详情

隐藏继承的方法

__call() 公共方法

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

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

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

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

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

方法名称

$params 数组

方法参数

return 混合类型

方法返回值

throws 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 数组

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

                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

属性名称

return 混合类型

属性值或行为属性的值

throws yii\base\UnknownPropertyException

如果属性未定义

throws 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

属性名称或事件名称

return 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 混合类型

属性值

throws yii\base\UnknownPropertyException

如果属性未定义

throws 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

属性名称

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

            
add() 公共方法

定义于: yii\caching\Cache::add()

如果缓存不包含此键,则将标识为键的值存储到缓存中。

如果缓存中已经包含该键,则不会执行任何操作。

public 布尔型 add ( $key, $value, $duration 0, $dependency null )
$key 混合类型

用于标识要缓存的值的键。它可以是一个简单的字符串,也可以是一个包含表示键的因素的复杂数据结构。

$value 混合类型

要缓存的值

$duration integer

缓存值将过期的秒数。0 表示永不过期。

$dependency yii\caching\Dependency|null

缓存项的依赖关系。如果依赖关系发生变化,当通过 get() 获取相应值时,缓存中的对应值将失效。如果 $serializer 为 false,则忽略此参数。

return boolean

值是否成功存储到缓存中

                public function add($key, $value, $duration = 0, $dependency = null)
{
    if ($dependency !== null && $this->serializer !== false) {
        $dependency->evaluateDependency($this);
    }
    if ($this->serializer === null) {
        $value = serialize([$value, $dependency]);
    } elseif ($this->serializer !== false) {
        $value = call_user_func($this->serializer[0], [$value, $dependency]);
    }
    $key = $this->buildKey($key);
    return $this->addValue($key, $value, $duration);
}

            
addValue() 受保护方法

如果缓存不包含此键,则将标识为键的值存储到缓存中。

这是在父类中声明的方法的实现。

protected 布尔型 addValue ( $key, $value, $duration )
$key string

用于标识要缓存的值的键

$value 混合类型

要缓存的值。通常是字符串。如果您禁用了 $serializer,它可能是其他东西。

$duration integer

缓存值将过期的秒数。0 表示永不过期。

return boolean

如果值成功存储到缓存中则为 true,否则为 false

                protected function addValue($key, $value, $duration)
{
    return $this->useApcu ? apcu_add($key, $value, $duration) : apc_add($key, $value, $duration);
}

            
addValues() protected method

将多个键值对添加到缓存中。

protected array addValues ( $data, $duration )
$data 数组

键对应缓存键,值是存储的值的数组

$duration integer

缓存值将过期的秒数。0 表示永不过期。

return 数组

失败键的数组

                protected function addValues($data, $duration)
{
    $result = $this->useApcu ? apcu_add($data, null, $duration) : apc_add($data, null, $duration);
    return is_array($result) ? array_keys($result) : [];
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

将行为附加到此组件。

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

另请参见 detachBehavior().

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

行为的名称。

$behavior string|array|yii\base\Behavior

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

return yii\base\Behavior

行为对象

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

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

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

另请参见 attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors 数组

要附加到组件的行为列表

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

            
behaviors() public method

Defined in: yii\base\Component::behaviors()

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

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

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

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

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

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

public array behaviors ( )
return 数组

行为配置。

                public function behaviors()
{
    return [];
}

            
buildKey() public method

Defined in: yii\caching\Cache::buildKey()

从给定的键构建规范化的缓存键。

如果给定的键是仅包含字母数字字符且不超过 32 个字符的字符串,则将返回带 $keyPrefix 前缀的键。否则,将通过序列化给定的键、应用 MD5 哈希和在前面加上 $keyPrefix 生成一个规范化的键。

public string buildKey ( $key )
$key 混合类型

要规范化的键

return string

生成的缓存键

                public function buildKey($key)
{
    if (is_string($key)) {
        $key = ctype_alnum($key) && StringHelper::byteLength($key) <= 32 ? $key : md5($key);
    } else {
        if ($this->_igbinaryAvailable) {
            $serializedKey = igbinary_serialize($key);
        } else {
            $serializedKey = serialize($key);
        }
        $key = md5($serializedKey);
    }
    return $this->keyPrefix . $key;
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

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

如果可以读取属性

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

另请参见 canSetProperty().

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

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

return 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() public method

Defined in: yii\base\Component::canSetProperty()

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

如果可以写入属性

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

另请参见 canGetProperty().

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

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

return 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() public static method
自 2.0.14 起已弃用。在 PHP >=5.5 上,使用 ::class 代替。

Defined in: yii\base\BaseObject::className()

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

public static string className ( )
return string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
delete() public method

Defined in: yii\caching\Cache::delete()

从缓存中删除具有指定键的值。

public boolean delete ( $key )
$key 混合类型

用于标识要从缓存中删除的值的键。这可以是一个简单的字符串,也可以是一个复杂的数据结构,其中包含表示键的因子。

return boolean

如果删除过程中没有发生错误

                public function delete($key)
{
    $key = $this->buildKey($key);
    return $this->deleteValue($key);
}

            
deleteValue() 受保护方法

从缓存中删除具有指定键的值 这是父类中声明的方法的实现。

protected boolean deleteValue ( $key )
$key string

要删除的值的键

return boolean

如果删除过程中没有发生错误

                protected function deleteValue($key)
{
    return $this->useApcu ? apcu_delete($key) : apc_delete($key);
}

            
detachBehavior() 公共方法

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

从组件中分离行为。

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

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

行为的名称。

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

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

            
exists() 公共方法

检查指定的键是否存在于缓存中。

如果数据很大,这可能比从缓存中获取值更快。请注意,此方法不会检查与缓存数据关联的依赖关系(如果有)是否已更改。因此,对 get() 的调用可能会返回 false,而 exists 则返回 true。

public boolean exists ( $key )
$key 混合类型

标识缓存值的键。这可以是一个简单的字符串或一个包含表示键的因子的复杂数据结构。

return boolean

如果缓存中存在值,则为 True;如果缓存中不存在值或已过期,则为 False。

                public function exists($key)
{
    $key = $this->buildKey($key);
    return $this->useApcu ? apcu_exists($key) : apc_exists($key);
}

            
flush() 公共方法

定义于: yii\caching\Cache::flush()

删除缓存中的所有值。

如果缓存由多个应用程序共享,请谨慎执行此操作。

public boolean flush ( )
return boolean

刷新操作是否成功。

                public function flush()
{
    return $this->flushValues();
}

            
flushValues() 受保护方法

删除缓存中的所有值。

这是在父类中声明的方法的实现。

protected boolean flushValues ( )
return boolean

刷新操作是否成功。

                protected function flushValues()
{
    return $this->useApcu ? apcu_clear_cache() : apc_clear_cache('user');
}

            
get() 公共方法

定义于: yii\caching\Cache::get()

使用指定键从缓存中检索值。

public mixed get ( $key )
$key 混合类型

标识缓存值的键。这可以是一个简单的字符串或一个包含表示键的因子的复杂数据结构。

return 混合类型

存储在缓存中的值,如果值不在缓存中、已过期或与缓存数据关联的依赖关系已更改,则为 false。

                public function get($key)
{
    $key = $this->buildKey($key);
    $value = $this->getValue($key);
    if ($value === false || $this->serializer === false) {
        return $value;
    } elseif ($this->serializer === null) {
        $value = unserialize((string)$value);
    } else {
        $value = call_user_func($this->serializer[1], $value);
    }
    if (is_array($value) && !($value[1] instanceof Dependency && $value[1]->isChanged($this))) {
        return $value[0];
    }
    return false;
}

            
getBehavior() 公共方法

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

返回命名的行为对象。

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

行为名称

return 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 ( )
return yii\base\Behavior[]

附加到此组件的行为列表

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

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

定义于: yii\caching\Cache::getOrSet()

该方法结合了 set()get() 方法来检索标识为 $key 的值,或者如果 $key 没有可用的缓存,则存储 $callable 执行的结果。

用法示例

public function getTopProducts($count = 10) {
    $cache = $this->cache; // Could be Yii::$app->cache
    return $cache->getOrSet(['top-n-products', 'n' => $count], function () use ($count) {
        return Products::find()->mostPopular()->limit($count)->all();
    }, 1000);
}
public mixed getOrSet ( $key, $callable, $duration null, $dependency null )
$key 混合类型

用于标识要缓存的值的键。它可以是一个简单的字符串,也可以是一个包含表示键的因素的复杂数据结构。

$callable callable|Closure

将用于生成要缓存的值的可调用对象或闭包。如果您使用可以返回 false 的 $callable,那么请记住 getOrSet() 可能无法有效地工作,因为 yii\caching\Cache::get() 方法使用 false 返回值来指示数据项在缓存中未找到。因此,false 值的缓存会导致不必要的内部调用。

$duration integer|null

缓存过期前的默认持续时间(以秒为单位)。如果未设置,将使用 $defaultDuration 值。

$dependency yii\caching\Dependency|null

缓存项的依赖关系。如果依赖关系发生更改,则通过 get() 获取缓存中的相应值将被失效。如果 $serializerfalse,则忽略此参数。

return 混合类型

$callable 执行的结果

                public function getOrSet($key, $callable, $duration = null, $dependency = null)
{
    if (($value = $this->get($key)) !== false) {
        return $value;
    }
    $value = call_user_func($callable, $this);
    if (!$this->set($key, $value, $duration, $dependency)) {
        Yii::warning('Failed to set cache value for key ' . json_encode($key), __METHOD__);
    }
    return $value;
}

            
getValue() 受保护方法

使用指定键从缓存中检索值。

这是在父类中声明的方法的实现。

protected mixed|false getValue ( $key )
$key string

标识缓存值的唯一键

return mixed|false

存储在缓存中的值,如果值不在缓存中或已过期,则为 false。

                protected function getValue($key)
{
    return $this->useApcu ? apcu_fetch($key) : apc_fetch($key);
}

            
getValues() protected method

使用指定的键从缓存中检索多个值。

protected array getValues ( $keys )
$keys 数组

用于识别缓存值的键列表

return 数组

以键为索引的缓存值列表

                protected function getValues($keys)
{
    $values = $this->useApcu ? apcu_fetch($keys) : apc_fetch($keys);
    return is_array($values) ? $values : [];
}

            
hasEventHandlers() public method

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

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

public boolean hasEventHandlers ( $name )
$name string

事件名称

return 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() public method

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

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

方法被定义,如果

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

属性名称

$checkBehaviors boolean

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

return 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() public method

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

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

属性被定义,如果

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

另见

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

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

return boolean

该属性是否已定义

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

            
init() public method

初始化此应用程序组件。

它检查是否加载了所需扩展。

public void init ( )

                public function init()
{
    parent::init();
    $extension = $this->useApcu ? 'apcu' : 'apc';
    if (!extension_loaded($extension)) {
        throw new InvalidConfigException("ApcCache requires PHP $extension extension to be loaded.");
    }
}

            
madd() public method
已弃用 此方法是 multiAdd() 的别名,将在 2.1.0 中删除。

定义在: yii\caching\Cache::madd()

将多项存储在缓存中。每个项目都包含标识为键的值。

如果缓存中已经包含这样的键,则将保留现有的值和过期时间。

public array madd ( $items, $duration 0, $dependency null )
$items 数组

要缓存的项目,以键值对形式表示。

$duration integer

缓存值将过期的默认秒数。0 表示永不过期。

$dependency yii\caching\Dependency|null

缓存项目的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为假,则忽略此参数。

return 数组

失败键的数组

                public function madd($items, $duration = 0, $dependency = null)
{
    return $this->multiAdd($items, $duration, $dependency);
}

            
mget() public method
已弃用 此方法是 multiGet() 的别名,将在 2.1.0 中删除。

定义在: yii\caching\Cache::mget()

使用指定的键从缓存中检索多个值。

某些缓存(如 memcache、apc)允许同时检索多个缓存值,这可能会提高性能。如果缓存本身不支持此功能,则此方法将尝试模拟它。

public array mget ( $keys )
$keys string[]

识别缓存值的字符串键列表

return 数组

与指定键相对应的缓存值列表。数组以(键,值)对的形式返回。如果值未缓存或已过期,则相应的数组值将为假。

                public function mget($keys)
{
    return $this->multiGet($keys);
}

            
mset() public method
已弃用 此方法是 multiSet() 的别名,将在 2.1.0 中删除。

定义在: yii\caching\Cache::mset()

将多项存储在缓存中。每个项目都包含标识为键的值。

如果缓存中已经包含这样的键,则现有的值和过期时间将分别被替换为新的值。

public array mset ( $items, $duration null, $dependency null )
$items 数组

要缓存的项目,以键值对形式表示。

$duration integer|null

缓存过期前的默认持续时间(以秒为单位)。如果未设置,则使用默认的 $defaultDuration 值。

$dependency yii\caching\Dependency|null

缓存项目的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为假,则忽略此参数。

return 数组

失败键的数组

                public function mset($items, $duration = null, $dependency = null)
{
    return $this->multiSet($items, $duration, $dependency);
}

            
multiAdd() public method (available since version 2.0.7)

定义在: yii\caching\Cache::multiAdd()

将多项存储在缓存中。每个项目都包含标识为键的值。

如果缓存中已经包含这样的键,则将保留现有的值和过期时间。

public array multiAdd ( $items, $duration 0, $dependency null )
$items 数组

要缓存的项目,以键值对形式表示。

$duration integer

缓存值将过期的默认秒数。0 表示永不过期。

$dependency yii\caching\Dependency|null

缓存项目的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为假,则忽略此参数。

return 数组

失败键的数组

                public function multiAdd($items, $duration = 0, $dependency = null)
{
    $data = $this->prepareCacheData($items, $dependency);
    return $this->addValues($data, $duration);
}

            
multiGet() public method (available since version 2.0.7)

定义在: yii\caching\Cache::multiGet()

使用指定的键从缓存中检索多个值。

某些缓存(如 memcache、apc)允许同时检索多个缓存值,这可能会提高性能。如果缓存本身不支持此功能,则此方法将尝试模拟它。

public array multiGet ( $keys )
$keys string[]

识别缓存值的字符串键列表

return 数组

与指定键相对应的缓存值列表。数组以(键,值)对的形式返回。如果值未缓存或已过期,则相应的数组值将为假。

                public function multiGet($keys)
{
    $keyMap = [];
    foreach ($keys as $key) {
        $keyMap[$key] = $this->buildKey($key);
    }
    $values = $this->getValues(array_values($keyMap));
    $results = [];
    foreach ($keyMap as $key => $newKey) {
        $results[$key] = false;
        if (isset($values[$newKey])) {
            if ($this->serializer === false) {
                $results[$key] = $values[$newKey];
            } else {
                $value = $this->serializer === null ? unserialize($values[$newKey])
                    : call_user_func($this->serializer[1], $values[$newKey]);
                if (is_array($value) && !($value[1] instanceof Dependency && $value[1]->isChanged($this))) {
                    $results[$key] = $value[0];
                }
            }
        }
    }
    return $results;
}

            
multiSet() public method (available since version 2.0.7)

定义在: yii\caching\Cache::multiSet()

将多项存储在缓存中。每个项目都包含标识为键的值。

如果缓存中已经包含这样的键,则现有的值和过期时间将分别被替换为新的值。

public array multiSet ( $items, $duration null, $dependency null )
$items 数组

要缓存的项目,以键值对形式表示。

$duration integer|null

缓存过期前的默认持续时间(以秒为单位)。如果未设置,则使用默认的 $defaultDuration 值。

$dependency yii\caching\Dependency|null

缓存项目的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为假,则忽略此参数。

return 数组

失败键的数组

                public function multiSet($items, $duration = null, $dependency = null)
{
    if ($duration === null) {
        $duration = $this->defaultDuration;
    }
    $data = $this->prepareCacheData($items, $dependency);
    return $this->setValues($data, $duration);
}

            
off() 公共方法

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

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

此方法与 on() 相反。

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

另请参见 on()

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

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

return 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;
}

            
offsetExists() 公共方法

定义于: yii\caching\Cache::offsetExists()

返回是否有一个具有指定键的缓存条目。

此方法是接口 ArrayAccess 所需的方法。

public boolean offsetExists ( $key )
$key string

标识缓存值的键

                #[\ReturnTypeWillChange]
public function offsetExists($key)
{
    return $this->get($key) !== false;
}

            
offsetGet() 公共方法

定义于: yii\caching\Cache::offsetGet()

使用指定键从缓存中检索值。

此方法是接口 ArrayAccess 所需的方法。

public mixed offsetGet ( $key )
$key string

标识缓存值的键

return 混合类型

存储在缓存中的值,如果值不在缓存中或已过期,则为 false。

                #[\ReturnTypeWillChange]
public function offsetGet($key)
{
    return $this->get($key);
}

            
offsetSet() 公共方法

定义于: yii\caching\Cache::offsetSet()

将标识为键的值存储到缓存中。

如果缓存中已存在此键,则现有值将被替换为新值。要添加过期时间和依赖项,请使用 set() 方法。此方法是接口 ArrayAccess 所需的方法。

public void offsetSet ( $key, $value )
$key string

用于标识要缓存的值的键

$value 混合类型

要缓存的值

                #[\ReturnTypeWillChange]
public function offsetSet($key, $value)
{
    $this->set($key, $value);
}

            
offsetUnset() 公共方法

定义于: yii\caching\Cache::offsetUnset()

从缓存中删除具有指定键的值 此方法是接口 ArrayAccess 所必需的。

public void offsetUnset ( $key )
$key string

要删除的值的键

                #[\ReturnTypeWillChange]
public function offsetUnset($key)
{
    $this->delete($key);
}

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

public 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]);
    }
}

            
set() 公共方法

定义于: yii\caching\Cache::set()

将标识为键的值存储到缓存中。

如果缓存中已经包含这样的键,则现有的值和过期时间将分别被替换为新的值。

public boolean set ( $key, $value, $duration null, $dependency null )
$key 混合类型

用于标识要缓存的值的键。它可以是一个简单的字符串,也可以是一个包含表示键的因素的复杂数据结构。

$value 混合类型

要缓存的值

$duration integer|null

缓存过期前的默认持续时间(以秒为单位)。如果未设置,则使用默认的 $defaultDuration 值。

$dependency yii\caching\Dependency|null

缓存项的依赖关系。如果依赖关系发生变化,当通过 get() 获取相应值时,缓存中的对应值将失效。如果 $serializer 为 false,则忽略此参数。

return boolean

值是否成功存储到缓存中

                public function set($key, $value, $duration = null, $dependency = null)
{
    if ($duration === null) {
        $duration = $this->defaultDuration;
    }
    if ($dependency !== null && $this->serializer !== false) {
        $dependency->evaluateDependency($this);
    }
    if ($this->serializer === null) {
        $value = serialize([$value, $dependency]);
    } elseif ($this->serializer !== false) {
        $value = call_user_func($this->serializer[0], [$value, $dependency]);
    }
    $key = $this->buildKey($key);
    return $this->setValue($key, $value, $duration);
}

            
setValue() 受保护方法

将标识为键的值存储到缓存中。

这是在父类中声明的方法的实现。

protected boolean setValue ( $key, $value, $duration )
$key string

用于标识要缓存的值的键

$value 混合类型

要缓存的值。通常是字符串。如果您禁用了 $serializer,它可能是其他东西。

$duration integer

缓存值将过期的秒数。0 表示永不过期。

return boolean

如果值成功存储到缓存中,则为 true,否则为 false。

                protected function setValue($key, $value, $duration)
{
    return $this->useApcu ? apcu_store($key, $value, $duration) : apc_store($key, $value, $duration);
}

            
setValues() 受保护方法

将多个键值对存储在缓存中。

protected array setValues ( $data, $duration )
$data 数组

数组,其中键对应于缓存键,而值

$duration integer

缓存值将过期的秒数。0 表示永不过期。

return 数组

失败键的数组

                protected function setValues($data, $duration)
{
    $result = $this->useApcu ? apcu_store($data, null, $duration) : apc_store($data, null, $duration);
    return is_array($result) ? array_keys($result) : [];
}

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