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

Class: Swift_KeyCache

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/KeyCache.php

Interface Overview


Provides a mechanism for storing data using two keys.


Author(s):

  • Chris Corbyn

Constants

Methods



Class Details

[line 16]
Provides a mechanism for storing data using two keys.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method clearAll [line 104]

void clearAll( string $nsKey)

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



Tags:

access:  public


Parameters:

string   $nsKey  

[ Top ]

method clearKey [line 97]

void clearKey( string $nsKey, string $itemKey)

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



Tags:

access:  public


Parameters:

string   $nsKey  
string   $itemKey  

[ Top ]

method exportToByteStream [line 79]

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

Get data back out of the cache as a ByteStream.



Tags:

access:  public


Parameters:

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

[ Top ]

method getInputByteStream [line 60]

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.




Tags:

access:  public


Parameters:

string   $nsKey  
string   $itemKey  
Swift_InputByteStream   $is   optional input stream

[ Top ]

method getString [line 70]

string getString( string $nsKey, string $itemKey)

Get data back out of the cache as a string.



Tags:

access:  public


Parameters:

string   $nsKey  
string   $itemKey  

[ Top ]

method hasKey [line 89]

bool hasKey( string $nsKey, string $itemKey)

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



Tags:

access:  public


Parameters:

string   $nsKey  
string   $itemKey  

[ Top ]

method importFromByteStream [line 46]

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

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



Tags:



Parameters:

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

[ Top ]

method setString [line 34]

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

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



Tags:



Parameters:

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

[ Top ]


Class Constants

MODE_APPEND =  2

[line 22]

Mode for appending data to the end of existing cached data


[ Top ]

MODE_WRITE =  1

[line 19]

Mode for replacing existing cached data


[ Top ]



Documentation generated on Sun, 02 Oct 2016 07:51:07 +0000 by phpDocumentor 1.4.3