Classes List

Swift_KeyCache_ArrayKeyCache

 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 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
<?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. */


/** * A basic KeyCache backed by an array. * * @author Chris Corbyn */
class Swift_KeyCache_ArrayKeyCache implements Swift_KeyCache
{
    /** * Cache contents. * * @var array */
    private $contents = [];

    /** * An InputStream for cloning. * * @var Swift_KeyCache_KeyCacheInputStream */
    private $stream;

    /** * Create a new ArrayKeyCache with the given $stream for cloning to make * InputByteStreams. */
    public function __construct(Swift_KeyCache_KeyCacheInputStream $stream)
    {
        $this->stream = $stream;
    }

    /** * 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)
    {
        $this->prepareCache($nsKey);
        switch ($mode) {
            case self::MODE_WRITE:
                $this->contents[$nsKey][$itemKey] = $string;
                break;
            case self::MODE_APPEND:
                if (!$this->hasKey($nsKey$itemKey)) {
                    $this->contents[$nsKey][$itemKey] = '';
                }
                $this->contents[$nsKey][$itemKey.= $string;
                break;
            default:
                throw new Swift_SwiftException('Invalid mode ['.$mode.'] used to set nsKey='.$nsKey.', itemKey='.$itemKey);
        }
    }

    /** * 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)
    {
        $this->prepareCache($nsKey);
        switch ($mode) {
            case self::MODE_WRITE:
                $this->clearKey($nsKey$itemKey);
                // no break
            case self::MODE_APPEND:
                if (!$this->hasKey($nsKey$itemKey)) {
                    $this->contents[$nsKey][$itemKey] = '';
                }
                while (false !== $bytes = $os->read(8192)) {
                    $this->contents[$nsKey][$itemKey.= $bytes;
                }
                break;
            default:
                throw new Swift_SwiftException('Invalid mode ['.$mode.'] used to set nsKey='.$nsKey.', itemKey='.$itemKey);
        }
    }

    /** * 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 * * @return Swift_InputByteStream */
    public function getInputByteStream($nsKey$itemKeySwift_InputByteStream $writeThrough = null)
    {
        $is = clone $this->stream;
        $is->setKeyCache($this);
        $is->setNsKey($nsKey);
        $is->setItemKey($itemKey);
        if (isset($writeThrough)) {
            $is->setWriteThroughStream($writeThrough);
        }

        return $is;
    }

    /** * Get data back out of the cache as a string. * * @param string $nsKey * @param string $itemKey * * @return string */
    public function getString($nsKey$itemKey)
    {
        $this->prepareCache($nsKey);
        if ($this->hasKey($nsKey$itemKey)) {
            return $this->contents[$nsKey][$itemKey];
        }
    }

    /** * 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 */
    public function exportToByteStream($nsKey$itemKeySwift_InputByteStream $is)
    {
        $this->prepareCache($nsKey);
        $is->write($this->getString($nsKey$itemKey));
    }

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

        return array_key_exists($itemKey$this->contents[$nsKey]);
    }

    /** * Clear data for $itemKey in the namespace $nsKey if it exists. * * @param string $nsKey * @param string $itemKey */
    public function clearKey($nsKey$itemKey)
    {
        unset($this->contents[$nsKey][$itemKey]);
    }

    /** * Clear all data in the namespace $nsKey if it exists. * * @param string $nsKey */
    public function clearAll($nsKey)
    {
        unset($this->contents[$nsKey]);
    }

    /** * Initialize the namespace of $nsKey if needed. * * @param string $nsKey */
    private function prepareCache($nsKey)
    {
        if (!array_key_exists($nsKey$this->contents)) {
            $this->contents[$nsKey] = [];
        }
    }
}