Class Cache
Caching for CakePHP.
- Object
-
Cache
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: cache.php
Properties summary
Inherited Properties
Method Summary
-
__loadEngine() public
Tries to find and include a file for a cache engine and returns object instance -
clear() public
Delete all keys from the cache -
config() public
Set the cache configuration to use -
delete() public
Delete a key from the cache -
engine() public
Set the cache engine to use or modify settings for one instance -
gc() public
Garbage collection -
getInstance() public
Returns a singleton instance -
isInitialized() public
Check if Cache has initialized a working storage engine -
read() public
Read a key from the cache -
set() public
Temporarily change settings to current config options. if no params are passed, resets settings if needed Cache::write() will reset the configuration changes made
-
settings() public
Return the settings for current cache engine -
write() public
Write data for key into cache
Method Detail
__loadEngine() public ¶
__loadEngine( $name )
Tries to find and include a file for a cache engine and returns object instance
Parameters
- $name
- of the engine (without 'Engine')
Returns
$engine object or null
clear() public ¶
clear( boolean $check = false , string $config = null )
Delete all keys from the cache
Parameters
- boolean $check optional false
- if true will check expiration, otherwise delete all
- string $config optional null
- name of the configuration to use
Returns
True if the cache was succesfully cleared, false otherwise
config() public ¶
config( string $name = null , array $settings = array() )
Set the cache configuration to use
Parameters
- string $name optional null
- Name of the configuration
- array $settings optional array()
- Optional associative array of settings passed to the engine
Returns
settings) on success, false on failure
See
delete() public ¶
delete( string $key , string $config = null )
Delete a key from the cache
Parameters
- string $key
- Identifier for the data
- string $config optional null
- name of the configuration to use
Returns
True if the value was succesfully deleted, false if it didn't exist or couldn't be removed
engine() public ¶
engine( string $name = 'File' , array $settings = array() )
Set the cache engine to use or modify settings for one instance
Parameters
- string $name optional 'File'
- Name of the engine (without 'Engine')
- array $settings optional array()
- Optional associative array of settings passed to the engine
Returns
True on success, false on failure
isInitialized() public ¶
isInitialized( string $engine = null , string $config ,… )
Check if Cache has initialized a working storage engine
Parameters
- string $engine optional null
- Name of the engine
- string $config ,…
- Name of the configuration setting
Returns
read() public ¶
read( string $key , string $config = null )
Read a key from the cache
Parameters
- string $key
- Identifier for the data
- string $config optional null
- name of the configuration to use
Returns
The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
set() public ¶
set( mixed $settings = array() , string $value = null )
Temporarily change settings to current config options. if no params are passed, resets settings if needed Cache::write() will reset the configuration changes made
Parameters
- mixed $settings optional array()
- Optional string for simple name-value pair or array
- string $value optional null
- Optional for a simple name-value pair
Returns
of settings
settings() public ¶
settings( string $engine = null )
Return the settings for current cache engine
Parameters
- string $engine optional null
- Name of the engine
Returns
list of settings for this engine
write() public ¶
write( string $key , mixed $value , string $config = null )
Write data for key into cache
Parameters
- string $key
- Identifier for the data
- mixed $value
- Data to be cached - anything except a resource
- string $config optional null
- Optional - string configuration name
Returns
True if the data was successfully cached, false on failure
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