[ Index ]

MailPress 544

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/Swiftmailer/classes/Swift/KeyCache/ -> DiskKeyCache.php (summary)

(no description)

File Size: 324 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Swift_KeyCache_DiskKeyCache:: (13 methods):
  __construct()
  setString()
  importFromByteStream()
  getInputByteStream()
  getString()
  exportToByteStream()
  hasKey()
  clearKey()
  clearAll()
  _prepareCache()
  _getHandle()
  _freeHandle()
  __destruct()


Class: Swift_KeyCache_DiskKeyCache  - X-Ref

A KeyCache which streams to and from disk.

__construct(Swift_KeyCache_KeyCacheInputStream $stream, $path)   X-Ref
Create a new DiskKeyCache with the given $stream for cloning to make
InputByteStreams, and the given $path to save to.

param: Swift_KeyCache_KeyCacheInputStream $stream
param: string                             $path   to save to

setString($nsKey, $itemKey, $string, $mode)   X-Ref
Set a string into the cache under $itemKey for the namespace $nsKey.

param: string $nsKey
param: string $itemKey
param: string $string
param: int    $mode

importFromByteStream($nsKey, $itemKey, Swift_OutputByteStream $os, $mode)   X-Ref
Set a ByteStream into the cache under $itemKey for the namespace $nsKey.

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

getInputByteStream($nsKey, $itemKey, Swift_InputByteStream $writeThrough = null)   X-Ref
Provides a ByteStream which when written to, writes data to $itemKey.

NOTE: The stream will always write in append mode.

param: string                $nsKey
param: string                $itemKey
param: Swift_InputByteStream $writeThrough
return: Swift_InputByteStream

getString($nsKey, $itemKey)   X-Ref
Get data back out of the cache as a string.

param: string $nsKey
param: string $itemKey
return: string

exportToByteStream($nsKey, $itemKey, Swift_InputByteStream $is)   X-Ref
Get data back out of the cache as a ByteStream.

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

hasKey($nsKey, $itemKey)   X-Ref
Check if the given $itemKey exists in the namespace $nsKey.

param: string $nsKey
param: string $itemKey
return: bool

clearKey($nsKey, $itemKey)   X-Ref
Clear data for $itemKey in the namespace $nsKey if it exists.

param: string $nsKey
param: string $itemKey

clearAll($nsKey)   X-Ref
Clear all data in the namespace $nsKey if it exists.

param: string $nsKey

_prepareCache($nsKey)   X-Ref
Initialize the namespace of $nsKey if needed.

param: string $nsKey

_getHandle($nsKey, $itemKey, $position)   X-Ref
Get a file handle on the cache item.

param: string $nsKey
param: string $itemKey
param: int    $position
return: resource

_freeHandle($nsKey, $itemKey)   X-Ref
No description

__destruct()   X-Ref
Destructor.




Generated: Thu Apr 28 18:38:52 2016 Cross-referenced by PHPXref 0.7.1