Docs For Class xPDOCache

Description

An abstract class that defines the methods a cache provider must implement.

abstract:

Located in /xpdo/cache/xpdocachemanager.class.php (line 698)

Direct descendents

Class	Description
xPDOAPCCache	Provides an APC-powered xPDOCache implementation.
xPDOFileCache	A simple file-based caching implementation using executable PHP.
xPDOMemCache	Provides a memcache-powered xPDOCache implementation.
xPDOWinCache	Provides a wincache-powered xPDOCache implementation.

Variable Summary

mixed $initialized

mixed $key

mixed $options

mixed $xpdo

Method Summary

xPDOCache __construct ( &$xpdo, [ $options = array()])

boolean add (string $key, string $var, [integer $expire = 0], [array $options = array()])

boolean delete (string $key, [array $options = array()])

boolean flush ([array $options = array()])

mixed get (string $key, [array $options = array()])

string getCacheKey (string $key, [array $options = array()])

mixed getOption (string $key, [array $options = array()], [mixed $default = null])

boolean isInitialized ()

boolean replace (string $key, string $var, [integer $expire = 0], [array $options = array()])

boolean set (string $key, string $var, [integer $expire = 0], [array $options = array()])

Variables

mixed $initialized = false (line 702)

access: protected

mixed $key = '' (line 701)

access: protected

mixed $options = array() (line 700)

access: protected

mixed $xpdo = null (line 699)

access: public

Methods

Constructor __construct (line 704)

access: public

xPDOCache __construct ( &$xpdo, [ $options = array()])

&$xpdo
$options

Redefined in descendants as:

add (line 774)

Adds a value to the cache.

return: True if successful
abstract:
access: public

boolean add (string $key, string $var, [integer $expire = 0], [array $options = array()])

string $key: A unique key identifying the item being set.
string $var: A reference to the PHP variable representing the item.
integer $expire: The amount of seconds for the variable to expire in.
array $options: Additional options for the operation.

Redefined in descendants as:

delete (line 808)

Deletes a value from the cache.

return: True if successful
abstract:
access: public

boolean delete (string $key, [array $options = array()])

string $key: A unique key identifying the item being deleted.
array $options: Additional options for the operation.

Redefined in descendants as:

flush (line 827)

Flush all values from the cache.

return: True if successful.
abstract:
access: public

boolean flush ([array $options = array()])

array $options: Additional options for the operation.

Redefined in descendants as:

get (line 818)

Gets a value from the cache.

return: The value retrieved from the cache.
access: public

mixed get (string $key, [array $options = array()])

string $key: A unique key identifying the item to fetch.
array $options: Additional options for the operation.

Redefined in descendants as:

getCacheKey (line 758)

Get the actual cache key the implementation will use.

return: The identifier with any implementation specific prefixes or other transformations applied.
access: public

string getCacheKey (string $key, [array $options = array()])

string $key: The identifier the application uses.
array $options: Additional options for the operation.

Redefined in descendants as:

xPDOFileCache::getCacheKey()

getOption (line 728)

Get an option from supplied options, the cache options, or the xpdo config.

return: The value of the option.
access: public

mixed getOption (string $key, [array $options = array()], [mixed $default = null])

string $key: Unique identifier for the option.
array $options: A set of explicit options to override those from xPDO or the xPDOCache implementation.
mixed $default: An optional default value to return if no value is found.

isInitialized (line 715)

Indicates if this xPDOCache instance has been properly initialized.

return: true if the implementation was initialized successfully.
access: public

boolean isInitialized ()

replace (line 798)

Replaces a value in the cache.

return: True if successful
abstract:
access: public

boolean replace (string $key, string $var, [integer $expire = 0], [array $options = array()])

string $key: A unique key identifying the item being set.
string $var: A reference to the PHP variable representing the item.
integer $expire: The amount of seconds for the variable to expire in.
array $options: Additional options for the operation.

Redefined in descendants as:

set (line 786)

Sets a value in the cache.

return: True if successful
abstract:
access: public

boolean set (string $key, string $var, [integer $expire = 0], [array $options = array()])

string $key: A unique key identifying the item being set.
string $var: A reference to the PHP variable representing the item.
integer $expire: The amount of seconds for the variable to expire in.
array $options: Additional options for the operation.

Redefined in descendants as: