Swift_KeyCache_NullKeyCache Class Reference

Inheritance diagram for Swift_KeyCache_NullKeyCache:

Public Member Functions
	setString ($nsKey, $itemKey, $string, $mode)
	importFromByteStream ($nsKey, $itemKey, Swift_OutputByteStream $os, $mode)
	getInputByteStream ($nsKey, $itemKey, Swift_InputByteStream $writeThrough=null)
	getString ($nsKey, $itemKey)
	exportToByteStream ($nsKey, $itemKey, Swift_InputByteStream $is)
	hasKey ($nsKey, $itemKey)
	clearKey ($nsKey, $itemKey)
	clearAll ($nsKey)

Additional Inherited Members
Public Attributes inherited from Swift_KeyCache
const	MODE_WRITE = 1
const	MODE_APPEND = 2

Detailed Description

A null KeyCache that does not cache at all.

Author

Chris Corbyn

Definition at line 16 of file NullKeyCache.php.

Member Function Documentation

clearAll

(

$nsKey

)

Clear all data in the namespace $nsKey if it exists.

Parameters

string

$nsKey

Implements Swift_KeyCache.

Definition at line 112 of file NullKeyCache.php.

clearKey	(		$nsKey,
			$itemKey
	)

Clear data for $itemKey in the namespace $nsKey if it exists.

Parameters

string	$nsKey
string	$itemKey

Implements Swift_KeyCache.

Definition at line 103 of file NullKeyCache.php.

exportToByteStream	(		$nsKey,
			$itemKey,
		Swift_InputByteStream	$is
	)

Get data back out of the cache as a ByteStream.

Parameters

string	$nsKey
string	$itemKey
Swift_InputByteStream	$is	to write the data to

Implements Swift_KeyCache.

Definition at line 80 of file NullKeyCache.php.

getInputByteStream	(		$nsKey,
			$itemKey,
		Swift_InputByteStream	$writeThrough = null
	)

Provides a ByteStream which when written to, writes data to $itemKey.

NOTE: The stream will always write in append mode.

Parameters

string	$nsKey
string	$itemKey
Swift_InputByteStream	$writeThrough

Returns

Swift_InputByteStream

Implements Swift_KeyCache.

Definition at line 57 of file NullKeyCache.php.

getString	(		$nsKey,
			$itemKey
	)

Get data back out of the cache as a string.

Parameters

string	$nsKey
string	$itemKey

Returns

string

Implements Swift_KeyCache.

Definition at line 69 of file NullKeyCache.php.

hasKey	(		$nsKey,
			$itemKey
	)

Check if the given $itemKey exists in the namespace $nsKey.

Parameters

string	$nsKey
string	$itemKey

Returns

bool

Implements Swift_KeyCache.

Definition at line 92 of file NullKeyCache.php.

importFromByteStream	(		$nsKey,
			$itemKey,
		Swift_OutputByteStream	$os,
			$mode
	)

Set a ByteStream into the cache under $itemKey for the namespace $nsKey.

See Also

MODE_WRITE, MODE_APPEND

Parameters

string	$nsKey
string	$itemKey
Swift_OutputByteStream	$os
int	$mode

Implements Swift_KeyCache.

Definition at line 42 of file NullKeyCache.php.

setString	(		$nsKey,
			$itemKey,
			$string,
			$mode
	)

Set a string into the cache under $itemKey for the namespace $nsKey.

See Also

MODE_WRITE, MODE_APPEND

Parameters

string	$nsKey
string	$itemKey
string	$string
int	$mode

Implements Swift_KeyCache.

Definition at line 28 of file NullKeyCache.php.