ApcEngine Class Info:

Class Declaration:
class ApcEngine extends CacheEngine
File name:
cake/libs/cache/apc.php
Summary:
APC storage engine for cache
Class Inheritance

CacheEngine Object

package
cake
subpackage
cake.cake.libs.cache

Properties:

Show/Hide parent properties
protected _log Log object
public settings settings of current engine instance

Method Summary:

Show/Hide parent methods
public cakeError( $method, $messages = array ( ) )
public clear( )
public __construct( )
public delete( $key )
public dispatchMethod( $method, $params = array ( ) )
public gc( )
public init( $settings = array ( ) )
public key( $key )
public log( $msg, $type = 2 )
public Object( )
protected _persist( $name, $return, $object, $type = NULL )
public read( $key )
public requestAction( $url, $extra = array ( ) )
protected _savePersistent( $name, $object )
protected _set( $properties = array ( ) )
public settings( )
public _stop( $status = 0 )
public toString( )
public write( $key, $value, $duration )

cakeError

top
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:
$method string Method to be called in the error class (AppError or ErrorHandler classes) required (no default)
$messages array Message that is to be displayed by the error class optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 189
return
error message
access
public

clear

top
Delete all keys from the cache
Method defined in class:
ApcEngine
Method defined in file:
cake/libs/cache/apc.php on line 93
return
boolean True if the cache was succesfully cleared, false otherwise
access
public

__construct

top
Class constructor, overridden in descendant classes.
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 63

delete

top
Delete a key from the cache
Parameters:
$key string Identifier for the data required (no default)
Method defined in class:
ApcEngine
Method defined in file:
cake/libs/cache/apc.php on line 84
return
boolean True if the value was succesfully deleted, false if it didn't exist or couldn't be removed
access
public

dispatchMethod

top
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:
$method string Name of the method to call required (no default)
$params array Parameter list to use when calling $method optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 113
return
mixed Returns the result of the method call
access
public

gc

top
Garbage collection Permanently remove all expired and deleted data
Method defined in class:
CacheEngine
Method defined in file:
cake/libs/cache.php on line 440
access
public

init

top
Initialize the Cache Engine Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
Parameters:
$settings optional array ( )
Method defined in class:
ApcEngine
Method defined in file:
cake/libs/cache/apc.php on line 44
return
boolean True if the engine has been successfully initialized, false if not
see
CacheEngine::__defaults
access
public

key

top
generates a safe key
Parameters:
$key string the key passed over required (no default)
Method defined in class:
CacheEngine
Method defined in file:
cake/libs/cache.php on line 498
return
mixed string $key or false
access
public

log

top
API for logging events.
Parameters:
$msg string Log message required (no default)
$type integer Error type constant. Defined in app/config/core.php. optional 2
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 150
return
boolean Success of log write
access
public

Object

top
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()
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 53
return
Object

_persist

top
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:
$name string name of the class to persist required (no default)
$return required (no default)
$object string the object to persist required (no default)
$type optional NULL
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 219
return
boolean Success
access
protected
todo
add examples to manual

read

top
Read a key from the cache
Parameters:
$key string Identifier for the data required (no default)
Method defined in class:
ApcEngine
Method defined in file:
cake/libs/cache/apc.php on line 69
return
mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
access
public

requestAction

top
Calls a controller's method from any location.
Parameters:
$url mixed String or array-based url. required (no default)
$extra array if array includes the key "return" it sets the AutoRender to true. optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 86
return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
access
public

_savePersistent

top
You should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters:
$name string name used for object to cache required (no default)
$object object the object to persist required (no default)
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 247
return
boolean true on save, throws error if file can not be created
access
protected

_set

top
Allows setting of multiple properties of the object in a single line of code.
Parameters:
$properties array An associative array containing properties and corresponding values. optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 169
return
void
access
protected

settings

top
Cache Engine settings
Method defined in class:
CacheEngine
Method defined in file:
cake/libs/cache.php on line 488
return
array settings
access
public

_stop

top
Stop execution of the current script
Parameters:
$status optional 0
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 139
return
void
access
public

toString

top
Object-to-string conversion. Each class can override this method as necessary.
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 73
return
string The name of this class
access
public

write

top
Write data for key into cache
Parameters:
$key string Identifier for the data required (no default)
$value mixed Data to be cached required (no default)
$duration integer How long to cache the data, in seconds required (no default)
Method defined in class:
ApcEngine
Method defined in file:
cake/libs/cache/apc.php on line 57
return
boolean True if the data was succesfully cached, false on failure
access
public