Interface Swift_KeyCache

Provides a mechanism for storing data using two keys.

Direct known implementers

Swift_KeyCache_ArrayKeyCache, Swift_KeyCache_DiskKeyCache, Swift_KeyCache_DummyKeyCache, Swift_KeyCache_NullKeyCache

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

Methods summary

`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`
`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`
`public Swift_InputByteStream`	# `getInputByteStream( string $nsKey, string $itemKey, Swift_InputByteStream $is = null )` Provides a ByteStream which when written to, writes data to $itemKey. NOTE: The stream will always write in append mode. If the optional third parameter is passed all writes will go through $is. Provides a ByteStream which when written to, writes data to $itemKey. NOTE: The stream will always write in append mode. If the optional third parameter is passed all writes will go through $is. Parameters `$nsKey` `string` $nsKey `$itemKey` `string` $itemKey `$is` `Swift_InputByteStream` $is, optional Returns `Swift_InputByteStream`
`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`
`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
`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`
`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
`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

Magic methods summary

Constants summary

`integer`	`MODE_WRITE`	`1`	# Mode for replacing existing cached data Mode for replacing existing cached data
`integer`	`MODE_APPEND`	`2`	# Mode for appending data to the end of existing cached data Mode for appending data to the end of existing cached data