Class FileEngine
File Storage engine for cache
- Object
-
CacheEngine
-
FileEngine
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: cache/file.php
Properties summary
-
$__FilepublicInstance of File class -
$__activepublicbooleanSet to true if FileEngine::init(); and FileEngine::__active(); do not fail. -
$__initpublicbooleanTrue unless FileEngine::__active(); fails -
$settingspublicarraysettings path = absolute path to cache directory, default => CACHE prefix = string prefix for filename, default => cake_ lock = enable file locking on write, default => false serialize = serialize the data, default => true
Inherited Properties
Method Summary
-
__active() public
Determine is cache directory is writable -
__setKey() public
Get absolute file for a given key -
clear() public
Delete all values from the cache -
delete() public
Delete a key from the cache -
gc() public
Garbage collection. Permanently remove all expired and deleted data -
init() public
Initialize the Cache Engine -
read() public
Read a key from the cache -
write() public
Write data for key into cache
Method Detail
__setKey() public ¶
__setKey( string $key )
Get absolute file for a given key
Parameters
- string $key
- The key
Returns
Absolute cache file for the given key or false if erroneous
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 succesfully cleared, false otherwise
Overrides
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
Overrides
gc() public ¶
gc( )
Garbage collection. Permanently remove all expired and deleted data
Returns
True if garbage collection was succesful, false on failure
Overrides
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()
- $setting array of setting for the engine
Returns
True if the engine has been successfully initialized, false if not
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
Overrides
write() public ¶
write( string $key , mixed $data , mixed $duration )
Write data for key into cache
Parameters
- string $key
- Identifier for the data
- mixed $data
- Data to be cached
- mixed $duration
- How long to cache the data, in seconds
Returns
True if the data was succesfully cached, false on failure
Overrides
Methods inherited from CacheEngine
Methods inherited from Object
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
dispatchMethod() public ¶
dispatchMethod( string $method , array $params = array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
API for logging events.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class