Swift_KeyCache_SimpleKeyCacheInputStream Class Reference

Inheritance diagram for Swift_KeyCache_SimpleKeyCacheInputStream:

Public Member Functions
	setKeyCache (Swift_KeyCache $keyCache)
	setWriteThroughStream (Swift_InputByteStream $is)
	write ($bytes, Swift_InputByteStream $is=null)
	commit ()
	bind (Swift_InputByteStream $is)
	unbind (Swift_InputByteStream $is)
	flushBuffers ()
	setNsKey ($nsKey)
	setItemKey ($itemKey)
	__clone ()

Private Attributes
	$_keyCache
	$_nsKey
	$_itemKey
	$_writeThrough = null

Detailed Description

Writes data to a KeyCache using a stream.

Author

Chris Corbyn

Definition at line 16 of file SimpleKeyCacheInputStream.php.

Member Function Documentation

__clone

(

)

Any implementation should be cloneable, allowing the clone to access a separate $nsKey and $itemKey.

Implements Swift_KeyCache_KeyCacheInputStream.

Definition at line 123 of file SimpleKeyCacheInputStream.php.

bind

(

Swift_InputByteStream

$is

)

Not used.

Implements Swift_InputByteStream.

Definition at line 79 of file SimpleKeyCacheInputStream.php.

commit

(

)

Not used.

Implements Swift_InputByteStream.

Definition at line 72 of file SimpleKeyCacheInputStream.php.

flushBuffers

(

)

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.

Implements Swift_InputByteStream.

Definition at line 94 of file SimpleKeyCacheInputStream.php.

setItemKey

(

$itemKey

)

Set the itemKey which will be written to.

Parameters

string

$itemKey

Implements Swift_KeyCache_KeyCacheInputStream.

Definition at line 114 of file SimpleKeyCacheInputStream.php.

setKeyCache

(

Swift_KeyCache

$keyCache

)

Set the KeyCache to wrap.

Parameters

Swift_KeyCache

$keyCache

Implements Swift_KeyCache_KeyCacheInputStream.

Definition at line 35 of file SimpleKeyCacheInputStream.php.

setNsKey

(

$nsKey

)

Set the nsKey which will be written to.

Parameters

string

$nsKey

Implements Swift_KeyCache_KeyCacheInputStream.

Definition at line 104 of file SimpleKeyCacheInputStream.php.

setWriteThroughStream

(

Swift_InputByteStream

$is

)

Specify a stream to write through for each write().

Parameters

Swift_InputByteStream

$is

Implements Swift_KeyCache_KeyCacheInputStream.

Definition at line 45 of file SimpleKeyCacheInputStream.php.

unbind

(

Swift_InputByteStream

$is

)

Not used.

Implements Swift_InputByteStream.

Definition at line 86 of file SimpleKeyCacheInputStream.php.

write	(		$bytes,
		Swift_InputByteStream	$is = null
	)

Writes $bytes to the end of the stream.

Parameters

string	$bytes
Swift_InputByteStream	$is	optional

Definition at line 56 of file SimpleKeyCacheInputStream.php.

References Swift_KeyCache\MODE_APPEND.

Member Data Documentation

$_itemKey

private

The itemKey of the KeyCache being written to

Definition at line 25 of file SimpleKeyCacheInputStream.php.

$_keyCache

private

The KeyCache being written to

Definition at line 19 of file SimpleKeyCacheInputStream.php.

$_nsKey

private

The nsKey of the KeyCache being written to

Definition at line 22 of file SimpleKeyCacheInputStream.php.

$_writeThrough = null

private

A stream to write through on each write()

Definition at line 28 of file SimpleKeyCacheInputStream.php.