0 关注者

类 yii\caching\DummyCache

继承关系yii\caching\DummyCache » 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/DummyCache.php

DummyCache 是一个占位符缓存组件。

DummyCache 不会缓存任何内容。它提供是为了能够始终配置一个 'cache' 应用组件,并节省检查 \Yii::$app->cache 是否存在的步骤。通过用其他缓存组件替换 DummyCache,可以快速地在非缓存模式和缓存模式之间切换。

有关 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

公共方法

隐藏继承方法

方法 描述 定义于
__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\Cache
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\Cache
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\DummyCache
addValues() 将多个键值对添加到缓存。 yii\caching\Cache
deleteValue() 从缓存中删除指定键的值 这是在父类中声明的方法的实现。 yii\caching\DummyCache
flushValues() 删除缓存中的所有值。 yii\caching\DummyCache
getValue() 使用指定的键从缓存中检索值。 yii\caching\DummyCache
getValues() 使用指定的键从缓存中检索多个值。 yii\caching\Cache
setValue() 将由键标识的值存储到缓存中。 yii\caching\DummyCache
setValues() 将多个键值对存储到缓存中。 yii\caching\Cache

方法详情

隐藏继承方法

__call() 公共方法

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

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

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

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

public mixed __call ( $name, $params )
$name string

方法名

$params array

方法参数

返回值 mixed

方法返回值

抛出异常 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 mixed __get ( $name )
$name string

属性名称

返回值 mixed

属性值或行为属性的值

抛出异常 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 boolean __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 mixed

属性值

抛出异常 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);
}

            
add() 公共方法

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

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

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

public boolean add ( $key, $value, $duration 0, $dependency null )
$key mixed

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

$value mixed

要缓存的值

$duration integer

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

$dependency yii\caching\Dependency|null

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

返回值 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 boolean addValue ( $key, $value, $duration )
$key string

标识要缓存的值的键

$value mixed

要缓存的值

$duration integer

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

返回值 boolean

如果值已成功存储到缓存中,则为 True,否则为 False

                protected function addValue($key, $value, $duration)
{
    return true;
}

            
addValues() 受保护方法

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

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

默认实现多次调用 addValue(),逐个添加值。如果底层缓存存储支持多添加,则应重写此方法以利用该功能。

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

其中键对应于缓存键,而值是存储的值的数组。

$duration integer

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

返回值 array

失败键的数组

                protected function addValues($data, $duration)
{
    $failedKeys = [];
    foreach ($data as $key => $value) {
        if ($this->addValue($key, $value, $duration) === false) {
            $failedKeys[] = $key;
        }
    }
    return $failedKeys;
}

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

            
behaviors() 公共方法

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

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

子类可以重写此方法来指定它们希望表现出的行为。

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

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

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

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

public 数组 behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
buildKey() 公共方法

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

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

如果给定的键是仅包含字母数字字符且不超过 32 个字符的字符串,则该键将被返回并以 $keyPrefix 为前缀。否则,将通过序列化给定的键、应用 MD5 哈希并以 $keyPrefix 为前缀来生成规范化的键。

public 字符串 buildKey ( $key )
$key mixed

要规范化的键

返回值 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() 公共方法

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

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

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

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

另请参阅 canSetProperty()

public 布尔值 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 布尔值 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 字符串 className ( )
返回值 string

此类的完全限定名称。

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

            
delete() 公共方法

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

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

public 布尔值 delete ( $key )
$key mixed

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

返回值 boolean

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

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

            
deleteValue() 受保护的方法

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

protected 布尔值 deleteValue ( $key )
$key string

要删除的值的键

返回值 boolean

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

                protected function deleteValue($key)
{
    return true;
}

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

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

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

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

如果数据量很大,此方法可能比从缓存中获取值更快。如果缓存本身不支持此功能,则此方法会尝试模拟它,但不会比获取值带来任何性能提升。请注意,此方法不会检查与缓存数据关联的依赖项(如果有)是否已更改。因此,调用 get() 可能会返回 false,而 exists 返回 true。

public boolean exists ( $key )
$key mixed

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

返回值 boolean

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

                public function exists($key)
{
    $key = $this->buildKey($key);
    $value = $this->getValue($key);
    return $value !== false;
}

            
flush() 公共方法

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

删除缓存中的所有值。

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

public boolean flush ( )
返回值 boolean

刷新操作是否成功。

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

            
flushValues() 受保护方法

删除缓存中的所有值。

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

protected boolean flushValues ( )
返回值 boolean

刷新操作是否成功。

                protected function flushValues()
{
    return true;
}

            
get() 公共方法

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

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

public mixed get ( $key )
$key mixed

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

返回值 mixed

存储在缓存中的值,如果值不在缓存中、已过期或与缓存数据关联的依赖项已更改,则返回 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

行为名称

返回值 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;
}

            
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 mixed

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

$callable callable|Closure

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

$duration integer|null

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

$dependency yii\caching\Dependency|null

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

返回值 mixed

$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

标识缓存值的唯一键

返回值 mixed|false

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

                protected function getValue($key)
{
    return false;
}

            
getValues() 受保护方法

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

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

默认实现多次调用 getValue() 以逐个检索缓存的值。如果底层缓存存储支持多获取,则应覆盖此方法以利用该功能。

protected array getValues ( $keys )
$keys array

标识缓存值的键列表

返回值 array

由键索引的缓存值列表

                protected function getValues($keys)
{
    $results = [];
    foreach ($keys as $key) {
        $results[$key] = $this->getValue($key);
    }
    return $results;
}

            
hasEventHandlers() 公共方法

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

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

public 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 时)。
public 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 时)。

另请参阅

public 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() 公有方法

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

初始化对象。

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

public void init ( )

                public function init()
{
    parent::init();
    $this->_igbinaryAvailable = \extension_loaded('igbinary');
}

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

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

将多个项目存储到缓存中。每个项目包含由键标识的值。

如果缓存中已存在此键,则将保留现有值和过期时间。

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

要缓存的项,作为键值对。

$duration integer

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

$dependency yii\caching\Dependency|null

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

返回值 array

失败键的数组

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

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

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

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

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

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

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

返回值 array

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

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

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

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

将多个项目存储到缓存中。每个项目包含由键标识的值。

如果缓存中已存在此键,则分别使用新值和过期时间替换现有值和过期时间。

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

要缓存的项,作为键值对。

$duration integer|null

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

$dependency yii\caching\Dependency|null

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

返回值 array

失败键的数组

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

            
multiAdd() 公有方法 (自版本 2.0.7 起可用)

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

将多个项目存储到缓存中。每个项目包含由键标识的值。

如果缓存中已存在此键,则将保留现有值和过期时间。

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

要缓存的项,作为键值对。

$duration integer

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

$dependency yii\caching\Dependency|null

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

返回值 array

失败键的数组

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

            
multiGet() 公有方法 (自版本 2.0.7 起可用)

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

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

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

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

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

返回值 array

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

                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() 公有方法 (自版本 2.0.7 起可用)

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

将多个项目存储到缓存中。每个项目包含由键标识的值。

如果缓存中已存在此键,则分别使用新值和过期时间替换现有值和过期时间。

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

要缓存的项,作为键值对。

$duration integer|null

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

$dependency yii\caching\Dependency|null

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

返回值 array

失败键的数组

                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,则会移除附加到命名事件的所有处理程序。

返回值 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

标识缓存值的键

返回值 mixed

存储在缓存中的值,如果值不在缓存中或已过期,则返回 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 mixed

要缓存的值

                #[\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)

其中$eventyii\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 可调用

事件处理程序

$data mixed

触发事件时传递给事件处理程序的数据。当调用事件处理程序时,可以通过 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 mixed

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

$value mixed

要缓存的值

$duration integer|null

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

$dependency yii\caching\Dependency|null

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

返回值 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 mixed

要缓存的值

$duration integer

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

返回值 boolean

如果值已成功存储到缓存中,则为 True,否则为 False

                protected function setValue($key, $value, $duration)
{
    return true;
}

            
setValues() 受保护的方法

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

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

默认实现多次调用 setValue() 以逐个存储值。如果底层缓存存储支持多设置,则应覆盖此方法以利用该功能。

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

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

$duration integer

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

返回值 array

失败键的数组

                protected function setValues($data, $duration)
{
    $failedKeys = [];
    foreach ($data as $key => $value) {
        if ($this->setValue($key, $value, $duration) === false) {
            $failedKeys[] = $key;
        }
    }
    return $failedKeys;
}

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