Class yii\caching\FileCache

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

FileCache implements a cache component using files.

For each data value being cached, FileCache will store it in a separate file. The cache files are placed under $cachePath. FileCache will perform garbage collection automatically to remove expired cache files.

Please refer to yii\caching\Cache for common cache operations that are supported by FileCache.

For more details and usage information on Cache, see the guide article on caching.

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$cacheFileSuffix string Cache file suffix. yii\caching\FileCache
$cachePath string The directory to store cache files. yii\caching\FileCache
$defaultDuration integer Default duration in seconds before a cache entry will expire. yii\caching\Cache
$dirMode integer The permission to be set for newly created directories. yii\caching\FileCache
$directoryLevel integer The level of sub-directories to store cache files. yii\caching\FileCache
$fileMode integer The permission to be set for newly created cache files. yii\caching\FileCache
$gcProbability integer The probability (parts per million) that garbage collection (GC) should be performed when storing a piece of data in the cache. yii\caching\FileCache
$keyPrefix string A string prefixed to every cache key. yii\caching\FileCache
$serializer null|array|false The functions used to serialize and unserialize cached data. 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() Stores a value identified by a key into cache if the cache does not contain this key. yii\caching\Cache
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
buildKey() Builds a normalized cache key from a given key. yii\caching\Cache
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
delete() Deletes a value with the specified key from cache. yii\caching\Cache
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
exists() Checks whether a specified key exists in the cache. yii\caching\FileCache
flush() Deletes all values from cache. yii\caching\Cache
gc() Removes expired cache files. yii\caching\FileCache
get() Retrieves a value from cache with a specified key. yii\caching\Cache
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getOrSet() Method combines both set() and get() methods to retrieve value identified by a $key, or to store the result of $callable execution if there is no cache available for the $key. yii\caching\Cache
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() Initializes this component by ensuring the existence of the cache path. yii\caching\FileCache
madd() Stores multiple items in cache. Each item contains a value identified by a key. yii\caching\Cache
mget() Retrieves multiple values from cache with the specified keys. yii\caching\Cache
mset() Stores multiple items in cache. Each item contains a value identified by a key. yii\caching\Cache
multiAdd() Stores multiple items in cache. Each item contains a value identified by a key. yii\caching\Cache
multiGet() Retrieves multiple values from cache with the specified keys. yii\caching\Cache
multiSet() Stores multiple items in cache. Each item contains a value identified by a key. yii\caching\Cache
off() 从该组件分离现有的事件处理程序. yii\base\Component
offsetExists() Returns whether there is a cache entry with a specified key. yii\caching\Cache
offsetGet() Retrieves the value from cache with a specified key. yii\caching\Cache
offsetSet() Stores the value identified by a key into cache. yii\caching\Cache
offsetUnset() Deletes the value with the specified key from cache This method is required by the interface ArrayAccess. yii\caching\Cache
on() 将事件处理程序附加到事件. yii\base\Component
set() Stores a value identified by a key into cache. yii\caching\Cache
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
addValue() Stores a value identified by a key into cache if the cache does not contain this key. yii\caching\FileCache
addValues() Adds multiple key-value pairs to cache. yii\caching\Cache
deleteValue() Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class. yii\caching\FileCache
flushValues() Deletes all values from cache. yii\caching\FileCache
gcRecursive() Recursively removing expired cache files under a directory. yii\caching\FileCache
getCacheFile() Returns the cache file path given the normalized cache key. yii\caching\FileCache
getValue() Retrieves a value from cache with a specified key. yii\caching\FileCache
getValues() Retrieves multiple values from cache with the specified keys. yii\caching\Cache
setValue() Stores a value identified by a key in cache. yii\caching\FileCache
setValues() Stores multiple key-value pairs in cache. yii\caching\Cache

属性详情

$cacheFileSuffix public 属性

Cache file suffix. Defaults to '.bin'.

public string $cacheFileSuffix '.bin'
$cachePath public 属性

The directory to store cache files. You may use path alias here. If not set, it will use the "cache" subdirectory under the application runtime path.

public string $cachePath '@runtime/cache'
$dirMode public 属性

The permission to be set for newly created directories. This value will be used by PHP chmod() function. No umask will be applied. Defaults to 0775, meaning the directory is read-writable by owner and group, but read-only for other users.

public integer $dirMode 0775
$directoryLevel public 属性

The level of sub-directories to store cache files. Defaults to 1. If the system has huge number of cache files (e.g. one million), you may use a bigger value (usually no bigger than 3). Using sub-directories is mainly to ensure the file system is not over burdened with a single directory having too many files.

$fileMode public 属性

The permission to be set for newly created cache files. This value will be used by PHP chmod() function. No umask will be applied. If not set, the permission will be determined by the current environment.

public integer $fileMode null
$gcProbability public 属性

The probability (parts per million) that garbage collection (GC) should be performed when storing a piece of data in the cache. Defaults to 10, meaning 0.001% chance. This number should be between 0 and 1000000. A value 0 means no GC will be performed at all.

public integer $gcProbability 10
$keyPrefix public 属性

A string prefixed to every cache key. This is needed when you store cache data under the same $cachePath for different applications to avoid conflict.

To ensure interoperability, only alphanumeric characters should be used.

public string $keyPrefix ''

方法详情

addValue() protected 方法

Stores a value identified by a key into cache if the cache does not contain this key.

This is the implementation of the method declared in the parent class.

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

The key identifying the value to be cached

$value string

The value to be cached. Other types (if you have disabled $serializer) unable to get is correct in getValue().

$duration integer

The number of seconds in which the cached value will expire. 0 means never expire.

return boolean

True if the value is successfully stored into cache, false otherwise

deleteValue() protected 方法

Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.

protected boolean deleteValue ( $key )
$key string

The key of the value to be deleted

return boolean

If no error happens during deletion

exists() public 方法

Checks whether a specified key exists in the cache.

This can be faster than getting the value from the cache if the data is big. Note that this method does not check whether the dependency associated with the cached data, if there is any, has changed. So a call to get() may return false while exists returns true.

public boolean exists ( $key )
$key mixed

A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key.

return boolean

True if a value exists in cache, false if the value is not in the cache or expired.

flushValues() protected 方法

Deletes all values from cache.

This is the implementation of the method declared in the parent class.

protected boolean flushValues ( )
return boolean

Whether the flush operation was successful.

gc() public 方法

Removes expired cache files.

public void gc ( $force false, $expiredOnly true )
$force boolean

Whether to enforce the garbage collection regardless of $gcProbability. Defaults to false, meaning the actual deletion happens with the probability as specified by $gcProbability.

$expiredOnly boolean

Whether to removed expired cache files only. If false, all cache files under $cachePath will be removed.

gcRecursive() protected 方法

Recursively removing expired cache files under a directory.

This method is mainly used by gc().

protected void gcRecursive ( $path, $expiredOnly )
$path string

The directory under which expired cache files are removed.

$expiredOnly boolean

Whether to only remove expired cache files. If false, all files under $path will be removed.

getCacheFile() protected 方法

Returns the cache file path given the normalized cache key.

protected string getCacheFile ( $normalizedKey )
$normalizedKey string

Normalized cache key by buildKey() method

return string

The cache file path

getValue() protected 方法

Retrieves a value from cache with a specified key.

This is the implementation of the method declared in the parent class.

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

A unique key identifying the cached value

return string|false

The value stored in cache, false if the value is not in the cache or expired.

init() public 方法

Initializes this component by ensuring the existence of the cache path.

public void init ( )
setValue() protected 方法

Stores a value identified by a key in cache.

This is the implementation of the method declared in the parent class.

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

The key identifying the value to be cached

$value string

The value to be cached. Other types (If you have disabled $serializer) unable to get is correct in getValue().

$duration integer

The number of seconds in which the cached value will expire. 0 means never expire.

return boolean

True if the value is successfully stored into cache, false otherwise