Class Swift_KeyCache_DiskKeyCache

A KeyCache which streams to and from disk.

Swift_KeyCache_DiskKeyCache implements Swift_KeyCache

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

Methods summary
`public`	# `__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. Create a new DiskKeyCache with the given $stream for cloning to make InputByteStreams, and the given $path to save to. Parameters `$stream` `$path` to save to
`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` `$itemKey` `$string` `$mode` Throws `Swift_IoException` 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` `$itemKey` `$os` `$mode` Throws `Swift_IoException` 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` `$itemKey` `$writeThrough` $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` `$itemKey` Returns string Throws `Swift_IoException` 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` `$itemKey` `$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` `$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` `$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` 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`
`private resource`	# `_getHandle( string $nsKey, string $itemKey, integer $position )` Get a file handle on the cache item. Get a file handle on the cache item. Parameters `$nsKey` `$itemKey` `$position` Returns resource
`private`	# `_freeHandle( $nsKey, $itemKey )`
`public`	# `__destruct( )` Destructor. Destructor.

Constants summary
`integer`	`POSITION_START` Signal to place pointer at start of file Signal to place pointer at start of file	# `0`
`integer`	`POSITION_END` Signal to place pointer at end of file Signal to place pointer at end of file	# `1`
`integer`	`POSITION_CURRENT` Signal to leave pointer in whatever position it currently is Signal to leave pointer in whatever position it currently is	# `2`

Constants inherited from Swift_KeyCache
`MODE_APPEND, MODE_WRITE`

Properties summary
`private Swift_KeyCache_KeyCacheInputStream`	`$_stream` An InputStream for cloning. An InputStream for cloning.	#
`private string`	`$_path` A path to write to. A path to write to.	#
`private array`	`$_keys` Stored keys. Stored keys.	# `array()`
`private boolean`	`$_quotes` Will be true if magic_quotes_runtime is turned on. Will be true if magic_quotes_runtime is turned on.	# `false`