WatermarkedPeer Class Reference
[Application-wide cache subsystem]

Watermark's all cache activity to avoid namespace collisions. More...

Inheritance diagram for WatermarkedPeer:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 __construct (CachePeer $peer, $watermark="Single onPHP's project")
 setWatermark ($watermark)
 getWatermark ()
 getActualWatermark ()
 setClassMap ($map)
 associative array, className -> watermark
 mark ($className)
 
Returns:
CachePeer

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

 isAlive ()

Static Public Member Functions

static create (CachePeer $peer, $watermark="Single onPHP's project")
 
Returns:
WatermarkedPeer


Protected Member Functions

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

Private Attributes

 $peer = null
 $watermark = null
 $map = null
 map class -> watermark


Detailed Description

Watermark's all cache activity to avoid namespace collisions.

Definition at line 18 of file WatermarkedPeer.class.php.


Constructor & Destructor Documentation

WatermarkedPeer::__construct ( CachePeer peer,
watermark = "Single onPHP's project" 
)

Definition at line 37 of file WatermarkedPeer.class.php.

References $watermark, and setWatermark().

Here is the call graph for this function:


Member Function Documentation

static WatermarkedPeer::create ( CachePeer peer,
watermark = "Single onPHP's project" 
) [static]

Returns:
WatermarkedPeer

Definition at line 29 of file WatermarkedPeer.class.php.

References $watermark.

WatermarkedPeer::setWatermark ( watermark  ) 

Definition at line 46 of file WatermarkedPeer.class.php.

References $watermark.

Referenced by __construct().

WatermarkedPeer::getWatermark (  ) 

Definition at line 53 of file WatermarkedPeer.class.php.

WatermarkedPeer::getActualWatermark (  ) 

Definition at line 58 of file WatermarkedPeer.class.php.

Referenced by delete(), get(), mark(), and store().

WatermarkedPeer::setClassMap ( map  ) 

associative array, className -> watermark

Returns:
WatermarkedPeer

Definition at line 74 of file WatermarkedPeer.class.php.

References SelectivePeer::$className, $map, and $watermark.

WatermarkedPeer::mark ( className  ) 

Returns:
CachePeer

Reimplemented from SelectivePeer.

Definition at line 87 of file WatermarkedPeer.class.php.

References SelectivePeer::$className, and getActualWatermark().

Here is the call graph for this function:

WatermarkedPeer::get ( key  ) 

Reimplemented from CachePeer.

Definition at line 96 of file WatermarkedPeer.class.php.

References getActualWatermark().

Here is the call graph for this function:

WatermarkedPeer::delete ( key  ) 

Reimplemented from CachePeer.

Definition at line 101 of file WatermarkedPeer.class.php.

References getActualWatermark().

Here is the call graph for this function:

WatermarkedPeer::clean (  ) 

Returns:
CachePeer

Reimplemented from CachePeer.

Definition at line 109 of file WatermarkedPeer.class.php.

WatermarkedPeer::isAlive (  ) 

Reimplemented from CachePeer.

Definition at line 116 of file WatermarkedPeer.class.php.

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

Reimplemented from CachePeer.

Definition at line 121 of file WatermarkedPeer.class.php.

References getActualWatermark().

Here is the call graph for this function:


Member Data Documentation

WatermarkedPeer::$peer = null [private]

Definition at line 20 of file WatermarkedPeer.class.php.

WatermarkedPeer::$watermark = null [private]

Definition at line 21 of file WatermarkedPeer.class.php.

Referenced by __construct(), create(), setClassMap(), and setWatermark().

WatermarkedPeer::$map = null [private]

map class -> watermark

Definition at line 24 of file WatermarkedPeer.class.php.

Referenced by setClassMap().


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