CachePeer Class Reference
[Application-wide cache subsystem]

Abstract cache peer base class. More...

Inheritance diagram for CachePeer:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 get ($key)
 delete ($key)
 clean ()
 
Returns:
CachePeer

 set ($key, &$value, $expires=Cache::EXPIRES_MEDIUM)
 add ($key, &$value, $expires=Cache::EXPIRES_MEDIUM)
 replace ($key, &$value, $expires=Cache::EXPIRES_MEDIUM)
 isAlive ()
 mark ($className)
 
Returns:
CachePeer

 enableCompression ()
 
Returns:
CachePeer

 disableCompression ()
 
Returns:
CachePeer


Public Attributes

const TIME_SWITCH = 2592000

Protected Member Functions

 store ($action, $key, &$value, $expires=Cache::EXPIRES_MEDIUM)

Protected Attributes

 $alive = false
 $compress = false


Detailed Description

Abstract cache peer base class.

Definition at line 100 of file CachePeer.class.php.


Member Function Documentation

CachePeer::get ( key  )  [abstract]

Reimplemented in AggregateCache, Memcached, PeclMemcached, ReferencePool, RubberFileSystem, RuntimeMemory, SharedMemory, and WatermarkedPeer.

CachePeer::delete ( key  )  [abstract]

Reimplemented in AggregateCache, PeclMemcached, ReferencePool, RubberFileSystem, RuntimeMemory, SharedMemory, and WatermarkedPeer.

CachePeer::clean (  ) 

Returns:
CachePeer

Reimplemented in AggregateCache, Memcached, PeclMemcached, ReferencePool, RubberFileSystem, RuntimeMemory, SharedMemory, and WatermarkedPeer.

Definition at line 113 of file CachePeer.class.php.

References Singleton::getAllInstances().

Here is the call graph for this function:

CachePeer::store ( action,
key,
&$  value,
expires = Cache::EXPIRES_MEDIUM 
) [abstract, protected]

Reimplemented in AggregateCache, Memcached, PeclMemcached, ReferencePool, RubberFileSystem, RuntimeMemory, SharedMemory, and WatermarkedPeer.

Referenced by add(), replace(), and set().

CachePeer::set ( key,
&$  value,
expires = Cache::EXPIRES_MEDIUM 
) [final]

Definition at line 126 of file CachePeer.class.php.

References store().

Here is the call graph for this function:

CachePeer::add ( key,
&$  value,
expires = Cache::EXPIRES_MEDIUM 
) [final]

Definition at line 131 of file CachePeer.class.php.

References store().

Here is the call graph for this function:

CachePeer::replace ( key,
&$  value,
expires = Cache::EXPIRES_MEDIUM 
) [final]

Definition at line 136 of file CachePeer.class.php.

References store().

Referenced by RuntimeMemory::store(), and RubberFileSystem::store().

Here is the call graph for this function:

CachePeer::isAlive (  ) 

Reimplemented in ReferencePool, RubberFileSystem, RuntimeMemory, SharedMemory, and WatermarkedPeer.

Definition at line 141 of file CachePeer.class.php.

Referenced by AggregateCache::addPeer(), AggregateCache::checkAlive(), AggregateCache::delete(), AggregateCache::get(), and AggregateCache::store().

CachePeer::mark ( className  ) 

Returns:
CachePeer

Reimplemented in ReferencePool, SelectivePeer, and WatermarkedPeer.

Definition at line 149 of file CachePeer.class.php.

CachePeer::enableCompression (  ) 

Returns:
CachePeer

Definition at line 157 of file CachePeer.class.php.

CachePeer::disableCompression (  ) 

Returns:
CachePeer

Definition at line 166 of file CachePeer.class.php.


Member Data Documentation

const CachePeer::TIME_SWITCH = 2592000

Definition at line 102 of file CachePeer.class.php.

CachePeer::$alive = false [protected]

Definition at line 104 of file CachePeer.class.php.

CachePeer::$compress = false [protected]

Definition at line 105 of file CachePeer.class.php.


The documentation for this class was generated from the following file:
Generated on Sun Dec 9 21:57:00 2007 for onPHP by  doxygen 1.5.4