Class Swift_KeyCache_ArrayKeyCache

A basic KeyCache backed by an array.

Swift_KeyCache_ArrayKeyCache implements Swift_KeyCache

Package: Swift\KeyCache
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/KeyCache/ArrayKeyCache.php

Methods summary

`public`	# `__construct( Swift_KeyCache_KeyCacheInputStream $stream )` Create a new ArrayKeyCache with the given $stream for cloning to make InputByteStreams. Create a new ArrayKeyCache with the given $stream for cloning to make InputByteStreams. Parameters `$stream` `Swift_KeyCache_KeyCacheInputStream` $stream
`public`	# `setString( string $nsKey, string $itemKey, string $string, integer $mode )` Set a string into the cache under $itemKey for the namespace $nsKey. Set a string into the cache under $itemKey for the namespace $nsKey. Parameters `$nsKey` `string` $nsKey `$itemKey` `string` $itemKey `$string` `string` $string `$mode` `integer` $mode See `Swift_KeyCache::MODE_WRITE`, `Swift_KeyCache::MODE_APPEND` Implementation of `Swift_KeyCache::setString()`
`public`	# `importFromByteStream( string $nsKey, string $itemKey, Swift_OutputByteStream $os, integer $mode )` Set a ByteStream into the cache under $itemKey for the namespace $nsKey. Set a ByteStream into the cache under $itemKey for the namespace $nsKey. Parameters `$nsKey` `string` $nsKey `$itemKey` `string` $itemKey `$os` `Swift_OutputByteStream` $os `$mode` `integer` $mode See `Swift_KeyCache::MODE_WRITE`, `Swift_KeyCache::MODE_APPEND` Implementation of `Swift_KeyCache::importFromByteStream()`
`public 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. Provides a ByteStream which when written to, writes data to $itemKey. NOTE: The stream will always write in append mode. Parameters `$nsKey` `string` $nsKey `$itemKey` `string` $itemKey `$writeThrough` `Swift_InputByteStream` $is, optional Returns `Swift_InputByteStream` Implementation of `Swift_KeyCache::getInputByteStream()`
`public string`	# `getString( string $nsKey, string $itemKey )` Get data back out of the cache as a string. Get data back out of the cache as a string. Parameters `$nsKey` `string` $nsKey `$itemKey` `string` $itemKey Returns `string` Implementation of `Swift_KeyCache::getString()`
`public`	# `exportToByteStream( string $nsKey, string $itemKey, Swift_InputByteStream $is )` Get data back out of the cache as a ByteStream. Get data back out of the cache as a ByteStream. Parameters `$nsKey` `string` $nsKey `$itemKey` `string` $itemKey `$is` `Swift_InputByteStream` $is to write the data to Implementation of `Swift_KeyCache::exportToByteStream()`
`public boolean`	# `hasKey( string $nsKey, string $itemKey )` Check if the given $itemKey exists in the namespace $nsKey. Check if the given $itemKey exists in the namespace $nsKey. Parameters `$nsKey` `string` $nsKey `$itemKey` `string` $itemKey Returns `boolean` Implementation of `Swift_KeyCache::hasKey()`
`public`	# `clearKey( string $nsKey, string $itemKey )` Clear data for $itemKey in the namespace $nsKey if it exists. Clear data for $itemKey in the namespace $nsKey if it exists. Parameters `$nsKey` `string` $nsKey `$itemKey` `string` $itemKey Implementation of `Swift_KeyCache::clearKey()`
`public`	# `clearAll( string $nsKey )` Clear all data in the namespace $nsKey if it exists. Clear all data in the namespace $nsKey if it exists. Parameters `$nsKey` `string` $nsKey Implementation of `Swift_KeyCache::clearAll()`
`private`	# `_prepareCache( string $nsKey )` Initialize the namespace of $nsKey if needed. Initialize the namespace of $nsKey if needed. Parameters `$nsKey` `string` $nsKey

Magic methods summary

Constants summary

Constants inherited from Swift_KeyCache

MODE_APPEND, MODE_WRITE

Properties summary

`private array`	`$_contents`	# Cache contents. Cache contents.
`private Swift_KeyCache_KeyCacheInputStream`	`$_stream`	# An InputStream for cloning. An InputStream for cloning.