WatermarkedPeer Class Reference
[Application-wide cache subsystem]

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

Inheritance diagram for WatermarkedPeer:

[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)
	increment ($key, $value)
	decrement ($key, $value)
	getList ($indexes)
	get ($key)
	delete ($key)
	clean ()
	isAlive ()
	append ($key, $data)
Static Public Member Functions
static	create (CachePeer $peer, $watermark="Single onPHP's project")
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, and ONPHP_VERSION.

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 append(), decrement(), delete(), get(), getList(), increment(), 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, $watermark, and ONPHP_VERSION.

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::increment	(	$	key,
		$	value
	)

Reimplemented from CachePeer.

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

References getActualWatermark().

Here is the call graph for this function:

WatermarkedPeer::decrement	(	$	key,
		$	value
	)

Reimplemented from CachePeer.

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

References getActualWatermark().

Here is the call graph for this function:

WatermarkedPeer::getList

(

$

indexes

)

Reimplemented from CachePeer.

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

References getActualWatermark().

Here is the call graph for this function:

WatermarkedPeer::get

(

$

key

)

Reimplemented from CachePeer.

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

References getActualWatermark().

Here is the call graph for this function:

WatermarkedPeer::delete

(

$

key

)

Reimplemented from CachePeer.

Definition at line 125 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 133 of file WatermarkedPeer.class.php.

WatermarkedPeer::isAlive

(

)

Reimplemented from CachePeer.

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

WatermarkedPeer::append	(	$	key,
		$	data
	)

Reimplemented from CachePeer.

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

References getActualWatermark().

Here is the call graph for this function:

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

Reimplemented from CachePeer.

Definition at line 150 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:

• core/Cache/WatermarkedPeer.class.php