Class Swift_KeyCache_ArrayKeyCache

(line 23)

Description


Located in File: /vendors/swiftMailer/classes/Swift/KeyCache/ArrayKeyCache.php

A basic KeyCache backed by an array.


Class Variables

Summary:

Class Constants

Summary:

Method Detail

Summary:
Swift_KeyCache_ArrayKeyCache __construct (Swift_KeyCache_KeyCacheInputStream $stream)
void clearAll (string $nsKey)
void clearKey (string $nsKey, string $itemKey)
void exportToByteStream (string $nsKey, string $itemKey, Swift_InputByteStream $is)
Swift_InputByteStream getInputByteStream (string $nsKey, string $itemKey, [Swift_InputByteStream $writeThrough = null])
string getString (string $nsKey, string $itemKey)
boolean hasKey (string $nsKey, string $itemKey)
void importFromByteStream (string $nsKey, string $itemKey, Swift_OutputByteStream $os, int $mode)
void setString (string $nsKey, string $itemKey, string $string, int $mode)

Constructor __construct (line 45)

Swift_KeyCache_ArrayKeyCache __construct( Swift_KeyCache_KeyCacheInputStream $stream)

Create a new ArrayKeyCache with the given $stream for cloning to make InputByteStreams.

Parameters

Info

  • access - public

Method clearAll (line 189)

void clearAll( string $nsKey)


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

Parameters

  • string $nsKey:

Info

  • access - public

Method clearKey (line 180)

void clearKey( string $nsKey, string $itemKey)


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

Parameters

  • string $nsKey:
  • string $itemKey:

Info

  • access - public

Method exportToByteStream (line 157)

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


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

Parameters

Info

  • access - public

Method getInputByteStream (line 122)

Swift_InputByteStream getInputByteStream( string $nsKey, string $itemKey, [Swift_InputByteStream $writeThrough = null])


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

NOTE: The stream will always write in append mode.

Parameters

Info

  • access - public

Method getString (line 142)

string getString( string $nsKey, string $itemKey)


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

Parameters

  • string $nsKey:
  • string $itemKey:

Info

  • access - public

Method hasKey (line 169)

boolean hasKey( string $nsKey, string $itemKey)


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

Parameters

  • string $nsKey:
  • string $itemKey:

Info

  • access - public

Method importFromByteStream (line 89)

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


Implementation of:
Swift_KeyCache::importFromByteStream()
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

Info

  • see - MODE_WRITE, MODE_APPEND
  • access - public

Method setString (line 58)

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


Implementation of:
Swift_KeyCache::setString()
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

  • string $nsKey:
  • string $itemKey:
  • string $string:
  • int $mode:

Info

  • see - MODE_WRITE, MODE_APPEND
  • access - public

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary


Documentation generated on Fri, 12 Nov 2010 20:45:12 +0000 by phpDocumentor 1.4.3