Db.php 6.05 KB
Newer Older
zYne's avatar
zYne committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
<?php
/*
 *  $Id$
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
 * <http://www.phpdoctrine.com>.
 */

/**
jepso's avatar
jepso committed
23
 * Doctrine_Cache_Db
zYne's avatar
zYne committed
24 25
 *
 * @package     Doctrine
26
 * @subpackage  Cache
zYne's avatar
zYne committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link        www.phpdoctrine.com
 * @since       1.0
 * @version     $Revision$
 * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
 */
class Doctrine_Cache_Db extends Doctrine_Cache_Driver implements Countable
{
    /**
     * constructor
     *
     * @param array $_options      an array of options
     */
    public function __construct($options) 
    {
42
        if ( ! isset($options['connection']) || 
zYne's avatar
zYne committed
43 44
             ! ($options['connection'] instanceof Doctrine_Connection)) {

45
            throw new Doctrine_Cache_Exception('Connection option not set.');
46 47 48 49 50 51 52
        }
        
        if ( ! isset($options['tableName']) ||
             ! is_string($options['tableName'])) {
             
             throw new Doctrine_Cache_Exception('Table name option not set.');
        }
53
        
zYne's avatar
zYne committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77

        $this->_options = $options;
    }
    /**
     * getConnection
     * returns the connection object associated with this cache driver
     *
     * @return Doctrine_Connection      connection object
     */
    public function getConnection() 
    {
        return $this->_options['connection'];
    }
    /**
     * Test if a cache is available for the given id and (if yes) return it (false else)
     *
     * Note : return value is always "string" (unserialization is done by the core not by the backend)
     *
     * @param string $id cache id
     * @param boolean $testCacheValidity        if set to false, the cache validity won't be tested
     * @return string cached datas (or false)
     */
    public function fetch($id, $testCacheValidity = true)
    {
78
        $sql = 'SELECT data, expire FROM ' . $this->_options['tableName']
jepso's avatar
jepso committed
79
             . ' WHERE id = ?';
zYne's avatar
zYne committed
80 81 82 83 84

        if ($testCacheValidity) {
            $sql .= ' AND (expire=0 OR expire > ' . time() . ')';
        }

zYne's avatar
zYne committed
85
        $result = $this->getConnection()->fetchAssoc($sql, array($id));
86 87 88 89 90
        
        if ( ! isset($result[0])) {
            return false;
        }
        
jepso's avatar
jepso committed
91
        return unserialize($result[0]['data']);
zYne's avatar
zYne committed
92 93 94 95 96 97 98 99 100
    }
    /**
     * Test if a cache is available or not (for the given id)
     *
     * @param string $id cache id
     * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record
     */
    public function contains($id) 
    {
101
        $sql = 'SELECT expire FROM ' . $this->_options['tableName']
jepso's avatar
jepso committed
102
             . ' WHERE id = ? AND (expire=0 OR expire > ' . time() . ')';
zYne's avatar
zYne committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117

        return $this->getConnection()->fetchOne($sql, array($id));
    }
    /**
     * Save some string datas into a cache record
     *
     * Note : $data is always saved as a string
     *
     * @param string $data      data to cache
     * @param string $id        cache id
     * @param int $lifeTime     if != false, set a specific lifetime for this cache record (null => infinite lifeTime)
     * @return boolean true if no problem
     */
    public function save($data, $id, $lifeTime = false)
    {
118
        $sql = 'INSERT INTO ' . $this->_options['tableName']
jepso's avatar
jepso committed
119
             . ' (id, data, expire) VALUES (?, ?, ?)';
120 121 122 123 124 125 126
        
        if ($lifeTime) {
            $expire = time() + $lifeTime;
        } else {
            $expire = 0;
        }
        
jepso's avatar
jepso committed
127
        $params = array($id, serialize($data), $expire);
zYne's avatar
zYne committed
128 129 130 131 132 133 134 135 136 137 138

        return (bool) $this->getConnection()->exec($sql, $params);
    }
    /**
     * Remove a cache record
     * 
     * @param string $id cache id
     * @return boolean true if no problem
     */
    public function delete($id) 
    {
jepso's avatar
jepso committed
139
        $sql = 'DELETE FROM ' . $this->_options['tableName'] . ' WHERE id = ?';
zYne's avatar
zYne committed
140 141

        return (bool) $this->getConnection()->exec($sql, array($id));
142 143 144 145 146 147 148 149 150 151 152 153 154
    }
    
    /**
     * Removes all cache records
     *
     * $return bool true on success, false on failure
     */
    public function deleteAll()
    {
        $sql = 'DELETE FROM ' . $this->_options['tableName'];
        
        return (bool) $this->getConnection()->exec($sql);
    }
jepso's avatar
jepso committed
155
    
zYne's avatar
zYne committed
156 157 158 159 160 161 162
    /**
     * count
     * returns the number of cached elements
     *
     * @return integer
     */
    public function count()
163 164
    {
        $sql = 'SELECT COUNT(*) FROM ' . $this->_options['tableName'];
jepso's avatar
jepso committed
165 166
        
        return (int) $this->getConnection()->fetchOne($sql);
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
    }
    
    /**
     * Creates the cache table.
     */
    public function createTable()
    {
        $name = $this->_options['tableName'];
        
        $fields = array(
            'id' => array(
                'type'   => 'string',
                'length' => 255
            ),
            'data' => array(
                'type'    => 'blob'
            ),
            'expire' => array(
                'type'    => 'timestamp'
            )
        );
        
        $options = array(
            'primary' => array('id')
        );
        
        $this->getConnection()->export->createTable($name, $fields, $options);
zYne's avatar
zYne committed
194 195
    }
}