Swift
[ class tree: Swift ] [ index: Swift ] [ all elements ]

Class: Swift_KeyCache_NullKeyCache

Source Location: /vendors/swift/classes/Swift/KeyCache/NullKeyCache.php

Class Overview


A null KeyCache that does not cache at all.


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods



Class Details

[line 22]
A null KeyCache that does not cache at all.



Tags:

author:  Chris Corbyn
filesource:  Source Code for this file


[ Top ]


Class Methods


method clearAll [line 106]

void clearAll( string $nsKey)

Clear all data in the namespace $nsKey if it exists.



Tags:

access:  public



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

Parameters:

string   $nsKey  

[ Top ]

method clearKey [line 98]

void clearKey( string $nsKey, string $itemKey)

Clear data for $itemKey in the namespace $nsKey if it exists.



Tags:

access:  public



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

Parameters:

string   $nsKey  
string   $itemKey  

[ Top ]

method exportToByteStream [line 78]

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

Get data back out of the cache as a ByteStream.



Tags:

access:  public



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

Parameters:

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

[ Top ]

method getInputByteStream [line 57]

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.




Tags:

access:  public



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

Parameters:

string   $nsKey  
string   $itemKey  
Swift_InputByteStream   $writeThrough  

[ Top ]

method getString [line 68]

string getString( string $nsKey, string $itemKey)

Get data back out of the cache as a string.



Tags:

access:  public



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

Parameters:

string   $nsKey  
string   $itemKey  

[ Top ]

method hasKey [line 88]

boolean hasKey( string $nsKey, string $itemKey)

Check if the given $itemKey exists in the namespace $nsKey.



Tags:

access:  public



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

Parameters:

string   $nsKey  
string   $itemKey  

[ Top ]

method importFromByteStream [line 45]

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

Set a ByteStream into the cache under $itemKey for the namespace $nsKey.



Tags:

see:  MODE_WRITE, MODE_APPEND
access:  public



Implementation of:
Swift_KeyCache::importFromByteStream()
Set a ByteStream into the cache under $itemKey for the namespace $nsKey.

Parameters:

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

[ Top ]

method setString [line 33]

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

Set a string into the cache under $itemKey for the namespace $nsKey.



Tags:

see:  MODE_WRITE, MODE_APPEND
access:  public



Implementation of:
Swift_KeyCache::setString()
Set a string into the cache under $itemKey for the namespace $nsKey.

Parameters:

string   $nsKey  
string   $itemKey  
string   $string  
int   $mode  

[ Top ]


Documentation generated on Mon, 05 Sep 2011 20:33:51 -0500 by phpDocumentor 1.4.3