Classes List

Swift_KeyCache

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
<?php

/* * This file is part of SwiftMailer. * (c) 2004-2009 Chris Corbyn * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


/** * Provides a mechanism for storing data using two keys. * * @author Chris Corbyn */
interface Swift_KeyCache
{
    /** Mode for replacing existing cached data */
    const MODE_WRITE = 1;

    /** Mode for appending data to the end of existing cached data */
    const MODE_APPEND = 2;

    /** * Set a string into the cache under $itemKey for the namespace $nsKey. * * @see MODE_WRITE, MODE_APPEND * * @param string $nsKey * @param string $itemKey * @param string $string * @param int $mode */
    public function setString($nsKey$itemKey$string$mode);

    /** * Set a ByteStream into the cache under $itemKey for the namespace $nsKey. * * @see MODE_WRITE, MODE_APPEND * * @param string $nsKey * @param string $itemKey * @param int $mode */
    public function importFromByteStream($nsKey$itemKeySwift_OutputByteStream $os$mode);

    /** * 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. * * @param string $nsKey * @param string $itemKey * @param Swift_InputByteStream $is optional input stream * * @return Swift_InputByteStream */
    public function getInputByteStream($nsKey$itemKeySwift_InputByteStream $is = null);

    /** * Get data back out of the cache as a string. * * @param string $nsKey * @param string $itemKey * * @return string */
    public function getString($nsKey$itemKey);

    /** * Get data back out of the cache as a ByteStream. * * @param string $nsKey * @param string $itemKey * @param Swift_InputByteStream $is stream to write the data to */
    public function exportToByteStream($nsKey$itemKeySwift_InputByteStream $is);

    /** * Check if the given $itemKey exists in the namespace $nsKey. * * @param string $nsKey * @param string $itemKey * * @return bool */
    public function hasKey($nsKey$itemKey);

    /** * Clear data for $itemKey in the namespace $nsKey if it exists. * * @param string $nsKey * @param string $itemKey */
    public function clearKey($nsKey$itemKey);

    /** * Clear all data in the namespace $nsKey if it exists. * * @param string $nsKey */
    public function clearAll($nsKey);
}