类 yii\caching\FileCache
FileCache 使用文件实现缓存组件。
对于每个被缓存的数据值,FileCache 会将其存储在一个单独的文件中。缓存文件放置在 $cachePath 下。FileCache 会自动执行垃圾回收以删除过期的缓存文件。
有关 FileCache 支持的常见缓存操作,请参阅 yii\caching\Cache。
有关缓存的更多详细信息和使用信息,请参阅 缓存指南文章。
公共属性
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
$behaviors | yii\base\Behavior[] | 附加到此组件的行为列表。 | yii\base\Component |
$cacheFileSuffix | string | 缓存文件后缀。 | yii\caching\FileCache |
$cachePath | string | 存储缓存文件的目录。 | yii\caching\FileCache |
$defaultDuration | integer | 缓存条目过期前的默认时长(秒)。 | yii\caching\Cache |
$dirMode | integer | 新创建目录的权限。 | yii\caching\FileCache |
$directoryLevel | integer | 存储缓存文件的子目录级别。 | yii\caching\FileCache |
$fileMode | integer|null | 新创建缓存文件的权限。 | yii\caching\FileCache |
$gcProbability | integer | 在缓存中存储数据时执行垃圾回收 (GC) 的概率(百万分率)。 | yii\caching\FileCache |
$keyPrefix | string | 每个缓存键的前缀字符串。 | yii\caching\FileCache |
$serializer | array|null|false | 用于序列化和反序列化缓存数据的函数。 | yii\caching\Cache |
公共方法
受保护方法
方法 | 描述 | 定义于 |
---|---|---|
addValue() | 如果缓存不包含此键,则将由键标识的值存储到缓存中。 | yii\caching\FileCache |
addValues() | 将多个键值对添加到缓存。 | yii\caching\Cache |
deleteValue() | 从缓存中删除指定键的值 这是在父类中声明的方法的实现。 | yii\caching\FileCache |
flushValues() | 删除缓存中的所有值。 | yii\caching\FileCache |
gcRecursive() | 递归删除目录下的过期缓存文件。 | yii\caching\FileCache |
getCacheFile() | 根据规范化的缓存键返回缓存文件路径。 | yii\caching\FileCache |
getValue() | 使用指定的键从缓存中检索值。 | yii\caching\FileCache |
getValues() | 使用指定的键从缓存中检索多个值。 | yii\caching\Cache |
setValue() | 将由键标识的值存储到缓存中。 | yii\caching\FileCache |
setValues() | 在缓存中存储多个键值对。 | yii\caching\Cache |
属性详情
存储缓存文件的目录。您可以在此处使用 路径别名。如果未设置,它将使用应用程序运行时路径下的“cache”子目录。
为新创建的目录设置的权限。此值将由 PHP chmod() 函数使用。不会应用 umask。默认为 0775,这意味着该目录对所有者和组可读写,但对其他用户只读。
存储缓存文件的子目录级别。默认为 1。如果系统有大量缓存文件(例如一百万个),您可以使用更大的值(通常不大于 3)。使用子目录主要是为了确保文件系统不会因单个目录包含过多文件而过载。
为新创建的缓存文件设置的权限。此值将由 PHP chmod() 函数使用。不会应用 umask。如果未设置,则权限将由当前环境确定。
在缓存中存储数据时应执行垃圾回收 (GC) 的概率(百万分率)。默认为 10,表示 0.001% 的几率。此数字应介于 0 和 1000000 之间。值为 0 表示根本不会执行 GC。
每个缓存键的前缀字符串。当您在同一 $cachePath 下为不同的应用程序存储缓存数据以避免冲突时,需要此项。
为了确保互操作性,应仅使用字母数字字符。
方法详情
定义于: yii\base\Component::__call()
调用不是类方法的命名方法。
此方法将检查任何附加的行为是否具有指定的方法,如果可用则执行它。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名称 |
$params | 数组 |
方法参数 |
返回值 | 混合类型 |
方法返回值 |
---|---|---|
抛出异常 | 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()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定义于: 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();
}
定义于: yii\base\Component::__get()
返回组件属性的值。
此方法将按以下顺序检查并相应地采取行动
- 由 getter 定义的属性:返回 getter 结果
- 行为的属性:返回行为属性值
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->property;
时会隐式调用。
另请参阅 __set()。
public mixed __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);
}
定义于: yii\base\Component::__isset()
检查属性是否已设置,即是否已定义且不为 null。
此方法将按以下顺序检查并相应地采取行动
- 由 setter 定义的属性:返回属性是否已设置
- 行为的属性:返回属性是否已设置
- 对于不存在的属性,返回
false
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($component->property)
时会隐式调用。
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
返回值 | 布尔值 |
指定的属性是否已设置 |
---|
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;
}
定义于: 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);
}
定义于: yii\base\Component::__unset()
将组件属性设置为 null。
此方法将按以下顺序检查并相应地采取行动
- 由 setter 定义的属性:将属性值设置为 null。
- 行为的属性:将属性值设置为 null。
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($component->property)
时会被隐式调用。
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);
}
public boolean add ( $key, $value, $duration = 0, $dependency = null ) | ||
$key | 混合类型 |
标识要缓存的值的键。这可以是简单的字符串或由表示键的因素组成的复杂数据结构。 |
$value | 混合类型 |
要缓存的值。 |
$duration | integer |
缓存值将过期的秒数。0 表示永不过期。 |
$dependency | yii\caching\Dependency|null |
缓存项的依赖项。如果依赖项发生更改,则通过 get() 获取缓存中的相应值时,该值将失效。如果 $serializer 为 false,则忽略此参数。 |
返回值 | 布尔值 |
值是否已成功存储到缓存中。 |
---|
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);
}
如果缓存不包含此键,则将由键标识的值存储到缓存中。
这是在父类中声明的方法的实现。
protected boolean addValue ( $key, $value, $duration ) | ||
$key | string |
标识要缓存的值的键。 |
$value | string |
要缓存的值。其他类型(如果您已禁用 $serializer)无法在 getValue() 中获得正确的值。 |
$duration | integer |
缓存值将过期的秒数。0 表示永不过期。 |
返回值 | 布尔值 |
如果值已成功存储到缓存中,则返回 true,否则返回 false。 |
---|
protected function addValue($key, $value, $duration)
{
$cacheFile = $this->getCacheFile($key);
if (@filemtime($cacheFile) > time()) {
return false;
}
return $this->setValue($key, $value, $duration);
}
定义于: yii\caching\Cache::addValues()
将多个键值对添加到缓存。
默认实现多次调用 addValue() 来逐个添加值。如果底层缓存存储支持多添加,则应覆盖此方法以利用该功能。
protected array addValues ( $data, $duration ) | ||
$data | 数组 |
数组,其中键对应于缓存键,而值是存储的值。 |
$duration | integer |
缓存值将过期的秒数。0 表示永不过期。 |
返回值 | 数组 |
失败的键的数组。 |
---|
protected function addValues($data, $duration)
{
$failedKeys = [];
foreach ($data as $key => $value) {
if ($this->addValue($key, $value, $duration) === false) {
$failedKeys[] = $key;
}
}
return $failedKeys;
}
定义于: yii\base\Component::attachBehavior()
将行为附加到此组件。
此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。
另请参阅 detachBehavior()。
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
行为的名称。 |
$behavior | string|array|yii\base\Behavior |
行为配置。这可以是以下之一:
|
返回值 | yii\base\Behavior |
行为对象。 |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
定义于: 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);
}
}
定义于: yii\base\Component::behaviors()
返回此组件应表现为的行为列表。
子类可以重写此方法以指定它们希望表现为的行为。
此方法的返回值应该是一个行为对象或配置的数组,这些对象或配置由行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组:
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当数组键使用名称时,使用此名称,行为以后可以使用 getBehavior() 检索或使用 detachBehavior() 分离。匿名行为无法检索或分离。
在此方法中声明的行为将自动(按需)附加到组件。
public array behaviors ( ) | ||
返回值 | 数组 |
行为配置。 |
---|
public function behaviors()
{
return [];
}
定义于: yii\caching\Cache::buildKey()
根据给定键构建规范化的缓存键。
如果给定的键是仅包含字母数字字符且不超过 32 个字符的字符串,则该键将以 $keyPrefix 为前缀返回。否则,将通过序列化给定的键、应用 MD5 哈希以及以 $keyPrefix 为前缀来生成规范化的键。
public string buildKey ( $key ) | ||
$key | 混合类型 |
要被规范化的键 |
返回值 | 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;
}
定义于: yii\base\Component::canGetProperty()
返回一个值,指示是否可以读取属性。
如果可以读取属性,则
- 该类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 该类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的可读属性(当
$checkBehaviors
为 true 时)。
另请参阅 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为此组件的属性 |
返回值 | 布尔值 |
属性是否可读 |
---|
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;
}
定义于: yii\base\Component::canSetProperty()
返回一个值,指示是否可以设置属性。
如果可以写入属性,则
- 该类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 该类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的可写属性(当
$checkBehaviors
为 true 时)。
另请参阅 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为此组件的属性 |
返回值 | 布尔值 |
属性是否可写 |
---|
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;
}
::class
。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名称。
public static string className ( ) | ||
返回值 | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
定义于: yii\caching\Cache::delete()
从缓存中删除指定键的值。
public boolean delete ( $key ) | ||
$key | 混合类型 |
用于标识要从缓存中删除的值的键。这可以是简单的字符串或由表示键的因子组成的复杂数据结构。 |
返回值 | 布尔值 |
如果删除过程中没有发生错误 |
---|
public function delete($key)
{
$key = $this->buildKey($key);
return $this->deleteValue($key);
}
从缓存中删除指定键的值 这是在父类中声明的方法的实现。
protected boolean deleteValue ( $key ) | ||
$key | string |
要删除的值的键 |
返回值 | 布尔值 |
如果删除过程中没有发生错误 |
---|
protected function deleteValue($key)
{
$cacheFile = $this->getCacheFile($key);
return @unlink($cacheFile);
}
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;
}
定义于: yii\base\Component::detachBehaviors()
从组件中分离所有行为。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定义于: 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);
}
}
}
检查缓存中是否存在指定的键。
如果数据量很大,这可能比从缓存中获取值更快。请注意,此方法不检查与缓存数据关联的依赖项(如果有)是否已更改。因此,调用 get() 可能会返回 false,而 exists 返回 true。
public boolean exists ( $key ) | ||
$key | 混合类型 |
用于标识缓存值的键。这可以是简单的字符串或由表示键的因子组成的复杂数据结构。 |
返回值 | 布尔值 |
如果缓存中存在值,则为 true;如果缓存中没有值或已过期,则为 false。 |
---|
public function exists($key)
{
$cacheFile = $this->getCacheFile($this->buildKey($key));
return @filemtime($cacheFile) > time();
}
删除缓存中的所有值。
这是在父类中声明的方法的实现。
protected boolean flushValues ( ) | ||
返回值 | 布尔值 |
刷新操作是否成功。 |
---|
protected function flushValues()
{
$this->gc(true, false);
return true;
}
删除过期的缓存文件。
public void gc ( $force = false, $expiredOnly = true ) | ||
$force | 布尔值 |
是否强制执行垃圾回收,而不管 $gcProbability。默认为 false,这意味着实际删除发生的概率与 $gcProbability 指定的概率相同。 |
$expiredOnly | 布尔值 |
是否只删除过期的缓存文件。如果为 false,则将删除 $cachePath 下的所有缓存文件。 |
public function gc($force = false, $expiredOnly = true)
{
if ($force || random_int(0, 1000000) < $this->gcProbability) {
$this->gcRecursive($this->cachePath, $expiredOnly);
}
}
递归删除目录下的过期缓存文件。
此方法主要由 gc() 使用。
protected void gcRecursive ( $path, $expiredOnly ) | ||
$path | string |
删除过期缓存文件的目录。 |
$expiredOnly | 布尔值 |
是否仅删除过期缓存文件。如果为 false,则将删除 |
protected function gcRecursive($path, $expiredOnly)
{
if (($handle = opendir($path)) !== false) {
while (($file = readdir($handle)) !== false) {
if (strncmp($file, '.', 1) === 0) {
continue;
}
$fullPath = $path . DIRECTORY_SEPARATOR . $file;
if (is_dir($fullPath)) {
$this->gcRecursive($fullPath, $expiredOnly);
if (!$expiredOnly) {
if (!@rmdir($fullPath)) {
$error = error_get_last();
Yii::warning("Unable to remove directory '{$fullPath}': {$error['message']}", __METHOD__);
}
}
} elseif (!$expiredOnly || $expiredOnly && @filemtime($fullPath) < time()) {
if (!@unlink($fullPath)) {
$error = error_get_last();
Yii::warning("Unable to remove file '{$fullPath}': {$error['message']}", __METHOD__);
}
}
}
closedir($handle);
}
}
使用指定的键从缓存中检索值。
public mixed get ( $key ) | ||
$key | 混合类型 |
用于标识缓存值的键。这可以是简单的字符串或由表示键的因子组成的复杂数据结构。 |
返回值 | 混合类型 |
存储在缓存中的值,如果值不在缓存中、已过期或与缓存数据关联的依赖项已更改,则返回 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;
}
定义于: 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;
}
定义于: yii\base\Component::getBehaviors()
返回附加到此组件的所有行为。
public yii\base\Behavior[] getBehaviors ( ) | ||
返回值 | yii\base\Behavior[] |
附加到此组件的行为列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
根据规范化的缓存键返回缓存文件路径。
protected string getCacheFile ( $normalizedKey ) | ||
$normalizedKey | string |
由 buildKey() 方法规范化的缓存键 |
返回值 | string |
缓存文件路径 |
---|
protected function getCacheFile($normalizedKey)
{
$cacheKey = $normalizedKey;
if ($this->keyPrefix !== '') {
// Remove key prefix to avoid generating constant directory levels
$lenKeyPrefix = strlen($this->keyPrefix);
$cacheKey = substr_replace($normalizedKey, '', 0, $lenKeyPrefix);
}
$cachePath = $this->cachePath;
if ($this->directoryLevel > 0) {
for ($i = 0; $i < $this->directoryLevel; ++$i) {
if (($subDirectory = substr($cacheKey, $i + $i, 2)) !== false) {
$cachePath .= DIRECTORY_SEPARATOR . $subDirectory;
}
}
}
return $cachePath . DIRECTORY_SEPARATOR . $normalizedKey . $this->cacheFileSuffix;
}
定义于: 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 |
将用于生成要缓存的值的可调用对象或闭包。如果您使用 $callable,它可以返回 |
$duration | integer|null |
缓存过期前的默认持续时间(以秒为单位)。如果未设置,则将使用 $defaultDuration 值。 |
$dependency | yii\caching\Dependency|null |
缓存项的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为 |
返回值 | 混合类型 |
$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;
}
使用指定的键从缓存中检索值。
这是在父类中声明的方法的实现。
protected string|false getValue ( $key ) | ||
$key | string |
一个唯一键,用于标识缓存的值 |
返回值 | string|false |
存储在缓存中的值,如果值不在缓存中或已过期,则返回 false。 |
---|
protected function getValue($key)
{
$cacheFile = $this->getCacheFile($key);
if (@filemtime($cacheFile) > time()) {
$fp = @fopen($cacheFile, 'r');
if ($fp !== false) {
@flock($fp, LOCK_SH);
$cacheValue = @stream_get_contents($fp);
@flock($fp, LOCK_UN);
@fclose($fp);
return $cacheValue;
}
}
return false;
}
定义于: yii\caching\Cache::getValues()
使用指定的键从缓存中检索多个值。
默认实现多次调用 getValue() 以逐个检索缓存的值。如果底层缓存存储支持多获取,则应覆盖此方法以利用该功能。
protected array getValues ( $keys ) | ||
$keys | 数组 |
标识缓存值的键列表 |
返回值 | 数组 |
由键索引的缓存值列表 |
---|
protected function getValues($keys)
{
$results = [];
foreach ($keys as $key) {
$results[$key] = $this->getValue($key);
}
return $results;
}
定义于: yii\base\Component::hasEventHandlers()
返回一个值,指示是否有任何处理程序附加到命名的事件。
public boolean hasEventHandlers ( $name ) | ||
$name | string |
事件名称 |
返回值 | 布尔值 |
事件是否附加了任何处理程序。 |
---|
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);
}
定义于: yii\base\Component::hasMethod()
返回一个值,指示方法是否已定义。
如果满足以下条件,则定义了方法
- 类具有指定名称的方法
- 附加的行为具有给定名称的方法(当
$checkBehaviors
为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkBehaviors | 布尔值 |
是否将行为的方法视为此组件的方法 |
返回值 | 布尔值 |
方法是否已定义 |
---|
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;
}
定义于: yii\base\Component::hasProperty()
返回一个值,指示是否为此组件定义了属性。
如果满足以下条件,则属性被定义
- 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
- 该类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的属性(当
$checkBehaviors
为 true 时)。
另请参阅
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为此组件的属性 |
返回值 | 布尔值 |
属性是否已定义 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
通过确保缓存路径的存在来初始化此组件。
public void init ( ) |
public function init()
{
parent::init();
$this->cachePath = Yii::getAlias($this->cachePath);
if (!is_dir($this->cachePath)) {
FileHelper::createDirectory($this->cachePath, $this->dirMode, true);
}
}
public array madd ( $items, $duration = 0, $dependency = null ) | ||
$items | 数组 |
要缓存的项,作为键值对。 |
$duration | integer |
缓存值将过期的默认秒数。0 表示永不过期。 |
$dependency | yii\caching\Dependency|null |
缓存项的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为 false,则忽略此参数。 |
返回值 | 数组 |
失败的键的数组。 |
---|
public function madd($items, $duration = 0, $dependency = null)
{
return $this->multiAdd($items, $duration, $dependency);
}
定义于: yii\caching\Cache::mget()
使用指定的键从缓存中检索多个值。
某些缓存(例如 memcache、apc)允许同时检索多个缓存值,这可能会提高性能。如果缓存本身不支持此功能,则此方法将尝试模拟它。
public array mget ( $keys ) | ||
$keys | string[] |
标识缓存值的字符串键列表 |
返回值 | 数组 |
与指定键对应的缓存值列表。该数组以 (键,值) 对的形式返回。如果值未缓存或已过期,则相应的数组值为 false。 |
---|
public function mget($keys)
{
return $this->multiGet($keys);
}
public array mset ( $items, $duration = null, $dependency = null ) | ||
$items | 数组 |
要缓存的项,作为键值对。 |
$duration | integer|null |
缓存过期前的默认持续时间(秒)。如果未设置,则使用默认的 $defaultDuration 值。 |
$dependency | yii\caching\Dependency|null |
缓存项的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为 false,则忽略此参数。 |
返回值 | 数组 |
失败的键的数组。 |
---|
public function mset($items, $duration = null, $dependency = null)
{
return $this->multiSet($items, $duration, $dependency);
}
public array multiAdd ( $items, $duration = 0, $dependency = null ) | ||
$items | 数组 |
要缓存的项,作为键值对。 |
$duration | integer |
缓存值将过期的默认秒数。0 表示永不过期。 |
$dependency | yii\caching\Dependency|null |
缓存项的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为 false,则忽略此参数。 |
返回值 | 数组 |
失败的键的数组。 |
---|
public function multiAdd($items, $duration = 0, $dependency = null)
{
$data = $this->prepareCacheData($items, $dependency);
return $this->addValues($data, $duration);
}
定义于: yii\caching\Cache::multiGet()
使用指定的键从缓存中检索多个值。
某些缓存(例如 memcache、apc)允许同时检索多个缓存值,这可能会提高性能。如果缓存本身不支持此功能,则此方法将尝试模拟它。
public array multiGet ( $keys ) | ||
$keys | string[] |
标识缓存值的字符串键列表 |
返回值 | 数组 |
与指定键对应的缓存值列表。该数组以 (键,值) 对的形式返回。如果值未缓存或已过期,则相应的数组值为 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;
}
public array multiSet ( $items, $duration = null, $dependency = null ) | ||
$items | 数组 |
要缓存的项,作为键值对。 |
$duration | integer|null |
缓存过期前的默认持续时间(秒)。如果未设置,则使用默认的 $defaultDuration 值。 |
$dependency | yii\caching\Dependency|null |
缓存项的依赖项。如果依赖项发生更改,则在通过 get() 获取时,缓存中的相应值将失效。如果 $serializer 为 false,则忽略此参数。 |
返回值 | 数组 |
失败的键的数组。 |
---|
public function multiSet($items, $duration = null, $dependency = null)
{
if ($duration === null) {
$duration = $this->defaultDuration;
}
$data = $this->prepareCacheData($items, $dependency);
return $this->setValues($data, $duration);
}
定义于: yii\base\Component::off()
从此组件中分离现有的事件处理程序。
此方法与 on() 相反。
注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。
另请参阅 on()。
public boolean off ( $name, $handler = null ) | ||
$name | string |
事件名称 |
$handler | callable|null |
要移除的事件处理程序。如果为 null,则将移除附加到命名事件的所有处理程序。 |
返回值 | 布尔值 |
如果找到并分离了一个处理程序 |
---|
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;
}
public boolean offsetExists ( $key ) | ||
$key | string |
标识缓存值的键 |
#[\ReturnTypeWillChange]
public function offsetExists($key)
{
return $this->get($key) !== false;
}
public mixed offsetGet ( $key ) | ||
$key | string |
标识缓存值的键 |
返回值 | 混合类型 |
存储在缓存中的值,如果值不在缓存中或已过期,则返回 false。 |
---|
#[\ReturnTypeWillChange]
public function offsetGet($key)
{
return $this->get($key);
}
定义于: yii\caching\Cache::offsetSet()
将由键标识的值存储到缓存中。
如果缓存中已存在此键,则现有值将被新值替换。要添加过期时间和依赖项,请使用 set() 方法。此方法是接口 ArrayAccess 所必需的。
public void offsetSet ( $key, $value ) | ||
$key | string |
标识要缓存的值的键。 |
$value | 混合类型 |
要缓存的值。 |
#[\ReturnTypeWillChange]
public function offsetSet($key, $value)
{
$this->set($key, $value);
}
定义于: yii\caching\Cache::offsetUnset()
从缓存中删除指定键的值 此方法是 ArrayAccess 接口必需的方法。
public void offsetUnset ( $key ) | ||
$key | string |
要删除的值的键 |
#[\ReturnTypeWillChange]
public function offsetUnset($key)
{
$this->delete($key);
}
将事件处理程序附加到事件。
事件处理程序必须是一个有效的 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 | 可调用 |
事件处理程序 |
$data | 混合类型 |
触发事件时传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。 |
$append | 布尔值 |
是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 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]);
}
}
public boolean set ( $key, $value, $duration = null, $dependency = null ) | ||
$key | 混合类型 |
标识要缓存的值的键。这可以是简单的字符串或由表示键的因素组成的复杂数据结构。 |
$value | 混合类型 |
要缓存的值。 |
$duration | integer|null |
缓存过期前的默认持续时间(秒)。如果未设置,则使用默认的 $defaultDuration 值。 |
$dependency | yii\caching\Dependency|null |
缓存项的依赖项。如果依赖项发生更改,则通过 get() 获取缓存中的相应值时,该值将失效。如果 $serializer 为 false,则忽略此参数。 |
返回值 | 布尔值 |
值是否已成功存储到缓存中。 |
---|
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);
}
将由键标识的值存储到缓存中。
这是在父类中声明的方法的实现。
protected boolean setValue ( $key, $value, $duration ) | ||
$key | string |
标识要缓存的值的键。 |
$value | string |
要缓存的值。其他类型(如果您已禁用 $serializer)无法在 getValue() 中获取正确的值。 |
$duration | integer |
缓存值将过期的秒数。小于或等于 0 表示 1 年的过期时间。 |
返回值 | 布尔值 |
如果值已成功存储到缓存中,则返回 true,否则返回 false。 |
---|
protected function setValue($key, $value, $duration)
{
$this->gc();
$cacheFile = $this->getCacheFile($key);
if ($this->directoryLevel > 0) {
@FileHelper::createDirectory(dirname($cacheFile), $this->dirMode, true);
}
// If ownership differs the touch call will fail, so we try to
// rebuild the file from scratch by deleting it first
// https://github.com/yiisoft/yii2/pull/16120
if (is_file($cacheFile) && function_exists('posix_geteuid') && fileowner($cacheFile) !== posix_geteuid()) {
@unlink($cacheFile);
}
if (@file_put_contents($cacheFile, $value, LOCK_EX) !== false) {
if ($this->fileMode !== null) {
@chmod($cacheFile, $this->fileMode);
}
if ($duration <= 0) {
$duration = 31536000; // 1 year
}
return @touch($cacheFile, $duration + time());
}
$error = error_get_last();
Yii::warning("Unable to write cache file '{$cacheFile}': {$error['message']}", __METHOD__);
return false;
}
定义于: yii\caching\Cache::setValues()
在缓存中存储多个键值对。
默认实现多次调用 setValue() 以逐个存储值。如果底层缓存存储支持多组设置,则应覆盖此方法以利用该功能。
protected array setValues ( $data, $duration ) | ||
$data | 数组 |
数组,其中键对应于缓存键,而值是存储的值 |
$duration | integer |
缓存值将过期的秒数。0 表示永不过期。 |
返回值 | 数组 |
失败的键的数组。 |
---|
protected function setValues($data, $duration)
{
$failedKeys = [];
foreach ($data as $key => $value) {
if ($this->setValue($key, $value, $duration) === false) {
$failedKeys[] = $key;
}
}
return $failedKeys;
}
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);
}
注册 或 登录 以发表评论。