Docs For Class Swift_KeyCache

Swift_KeyCache_DiskKeyCache __construct(
Swift_KeyCache_KeyCacheInputStream
$stream, string
$path)

Create a new DiskKeyCache with the given $stream for cloning to make InputByteStreams, and the given $path to save to.

Tags:

access:

public

Parameters:

Swift_KeyCache_KeyCacheInputStream	$stream
string	$path	to save to

[ Top ]

void __destruct(
)

Destructor.

Tags:

access:

public

[ Top ]

void clearAll(
string
$nsKey)

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

Tags:

access:

public

Implementation of:

Swift_KeyCache::clearAll(): Clear all data in the namespace $nsKey if it exists.

Parameters:

string

$nsKey

[ Top ]

void clearKey(
string
$nsKey, string
$itemKey)

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

Tags:

access:

public

Implementation of:

Swift_KeyCache::clearKey(): Clear data for $itemKey in the namespace $nsKey if it exists.

Parameters:

string	$nsKey
string	$itemKey

[ Top ]

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

Get data back out of the cache as a ByteStream.

Tags:

access:

public

Implementation of:

Swift_KeyCache::exportToByteStream(): Get data back out of the cache as a ByteStream.

Parameters:

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

[ Top ]

Swift_InputByteStream getInputByteStream(
string
$nsKey, string
$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.

Tags:

access:

public

Implementation of:

Swift_KeyCache::getInputByteStream(): Provides a ByteStream which when written to, writes data to $itemKey.

Parameters:

string	$nsKey
string	$itemKey
Swift_InputByteStream	$writeThrough

[ Top ]

string getString(
string
$nsKey, string
$itemKey)

Get data back out of the cache as a string.

Tags:

throws:	Swift_IoException
access:	public

Implementation of:

Swift_KeyCache::getString(): Get data back out of the cache as a string.

Parameters:

string	$nsKey
string	$itemKey

[ Top ]

boolean hasKey(
string
$nsKey, string
$itemKey)

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

Tags:

access:

public

Implementation of:

Swift_KeyCache::hasKey(): Check if the given $itemKey exists in the namespace $nsKey.

Parameters:

string	$nsKey
string	$itemKey

[ Top ]

void importFromByteStream(
string
$nsKey, string
$itemKey, Swift_OutputByteStream
$os, int
$mode)

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

Tags:

see:	MODE_WRITE, MODE_APPEND
throws:	Swift_IoException
access:	public

Implementation of:

Swift_KeyCache::importFromByteStream(): Set a ByteStream into the cache under $itemKey for the namespace $nsKey.

Parameters:

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

[ Top ]

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

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

Tags:

see:	MODE_WRITE, MODE_APPEND
throws:	Swift_IoException
access:	public

Implementation of:

Swift_KeyCache::setString(): Set a string into the cache under $itemKey for the namespace $nsKey.

Parameters:

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

[ Top ]

Class: Swift_KeyCache_DiskKeyCache

Class Overview

Author(s):

Constants

Methods

Class Details

Tags:

Class Methods

constructor __construct [line 67]

Tags:

Parameters:

destructor __destruct [line 308]

Tags:

method clearAll [line 246]

Tags:

Parameters:

method clearKey [line 231]

Tags:

Parameters:

method exportToByteStream [line 195]

Tags:

Parameters:

method getInputByteStream [line 145]

Tags:

Parameters:

method getString [line 166]

Tags:

Parameters:

method hasKey [line 221]

Tags:

Parameters:

method importFromByteStream [line 113]

Tags:

Parameters:

method setString [line 83]

Tags:

Parameters:

Class Constants

POSITION_END = 1

POSITION_START = 0