Class FileEngine
File Storage engine for cache. Filestorage is the slowest cache storage to read and write. However, it is good for servers that don't have other storage engine available, or have content which is not performance sensitive.
You can configure a FileEngine cache, using Cache::config()
- CacheEngine
-
FileEngine
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Cache/Engine/FileEngine.php
Properties summary
Inherited Properties
Method Summary
-
_active() protected
Determine is cache directory is writable -
_clearDirectory() protected
Used to clear a directory of matching files. -
_setKey() protected
Sets the current cache key this class is managing, and creates a writable SplFileObject for the cache file the key is referring to.
-
add() public
Write data for key into cache if it doesn't exist already. If it already exists, it fails and returns false.
-
clear() public
Delete all values from the cache -
clearGroup() public
Recursively deletes all files under any directory named as $group -
decrement() public
Not implemented -
delete() public
Delete a key from the cache -
gc() public
Garbage collection. Permanently remove all expired and deleted data -
increment() public
Not implemented -
init() public
Initialize the Cache Engine -
key() public
Generates a safe key for use with cache engine storage engines. -
read() public
Read a key from the cache -
write() public
Write data for key into cache
Method Detail
_clearDirectory() protected ¶
_clearDirectory( string $path , integer $now , integer $threshold )
Used to clear a directory of matching files.
Parameters
- string $path
- The path to search.
- integer $now
- The current timestamp
- integer $threshold
- Any file not modified after this value will be deleted.
_setKey() protected ¶
_setKey( string $key , boolean $createKey = false )
Sets the current cache key this class is managing, and creates a writable SplFileObject for the cache file the key is referring to.
Parameters
- string $key
- The key
- boolean $createKey optional false
- Whether the key should be created if it doesn't exists, or not
Returns
true if the cache key could be set, false otherwise
add() public ¶
add( string $key , mixed $value , integer $duration )
Write data for key into cache if it doesn't exist already. If it already exists, it fails and returns false.
Parameters
- string $key
- Identifier for the data.
- mixed $value
- Data to be cached.
- integer $duration
- How long to cache the data, in seconds.
Returns
True if the data was successfully cached, false on failure.
Overrides
clear() public ¶
clear( boolean $check )
Delete all values from the cache
Parameters
- boolean $check
- Optional - only delete expired cache items
Returns
True if the cache was successfully cleared, false otherwise
clearGroup() public ¶
clearGroup( string $group )
Recursively deletes all files under any directory named as $group
Parameters
- string $group
- The group to clear.
Returns
success
Overrides
decrement() public ¶
decrement( string $key , integer $offset = 1 )
Not implemented
Parameters
- string $key
- The key to decrement
- integer $offset optional 1
- The number to offset
Throws
delete() public ¶
delete( string $key )
Delete a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
True if the value was successfully deleted, false if it didn't exist or couldn't be removed
gc() public ¶
gc( integer $expires = null )
Garbage collection. Permanently remove all expired and deleted data
Parameters
- integer $expires optional null
- [optional] An expires timestamp, invalidating all data before.
Returns
True if garbage collection was successful, false on failure
Overrides
increment() public ¶
increment( string $key , integer $offset = 1 )
Not implemented
Parameters
- string $key
- The key to decrement
- integer $offset optional 1
- The number to offset
Throws
init() public ¶
init( array $settings = array() )
Initialize the Cache Engine
Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
Parameters
- array $settings optional array()
- array of setting for the engine
Returns
True if the engine has been successfully initialized, false if not
Overrides
key() public ¶
key( string $key )
Generates a safe key for use with cache engine storage engines.
Parameters
- string $key
- the key passed over
Returns
string $key or false
Overrides
read() public ¶
read( string $key )
Read a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
write() public ¶
write( string $key , mixed $data , integer $duration )
Write data for key into cache
Parameters
- string $key
- Identifier for the data
- mixed $data
- Data to be cached
- integer $duration
- How long to cache the data, in seconds
Returns
True if the data was successfully cached, false on failure