class SQLite3Cache in Zircon Profile 8

SQLite3 cache provider.

@since 1.4 @author Jake Bell <[e-mail]>

Hierarchy

• class \Doctrine\Common\Cache\CacheProvider implements Cache, ClearableCache, FlushableCache, MultiGetCache
  • class \Doctrine\Common\Cache\SQLite3Cache

1 file declares its use of SQLite3Cache

SQLite3CacheTest.php in vendor/doctrine/cache/tests/Doctrine/Tests/Common/Cache/SQLite3CacheTest.php

File

vendor/doctrine/cache/lib/Doctrine/Common/Cache/SQLite3Cache.php, line 31

Namespace

Doctrine\Common\Cache

class SQLite3Cache extends CacheProvider {

  /**
   * The ID field will store the cache key.
   */
  const ID_FIELD = 'k';

  /**
   * The data field will store the serialized PHP value.
   */
  const DATA_FIELD = 'd';

  /**
   * The expiration field will store a date value indicating when the
   * cache entry should expire.
   */
  const EXPIRATION_FIELD = 'e';

  /**
   * @var SQLite3
   */
  private $sqlite;

  /**
   * @var string
   */
  private $table;

  /**
   * Constructor.
   *
   * Calling the constructor will ensure that the database file and table
   * exist and will create both if they don't.
   *
   * @param SQLite3 $sqlite
   * @param string $table
   */
  public function __construct(SQLite3 $sqlite, $table) {
    $this->sqlite = $sqlite;
    $this->table = (string) $table;
    list($id, $data, $exp) = $this
      ->getFields();
    return $this->sqlite
      ->exec(sprintf('CREATE TABLE IF NOT EXISTS %s(%s TEXT PRIMARY KEY NOT NULL, %s BLOB, %s INTEGER)', $table, $id, $data, $exp));
  }

  /**
   * {@inheritdoc}
   */
  protected function doFetch($id) {
    if ($item = $this
      ->findById($id)) {
      return unserialize($item[self::DATA_FIELD]);
    }
    return false;
  }

  /**
   * {@inheritdoc}
   */
  protected function doContains($id) {
    return (bool) $this
      ->findById($id, false);
  }

  /**
   * {@inheritdoc}
   */
  protected function doSave($id, $data, $lifeTime = 0) {
    $statement = $this->sqlite
      ->prepare(sprintf('INSERT OR REPLACE INTO %s (%s) VALUES (:id, :data, :expire)', $this->table, implode(',', $this
      ->getFields())));
    $statement
      ->bindValue(':id', $id);
    $statement
      ->bindValue(':data', serialize($data), SQLITE3_BLOB);
    $statement
      ->bindValue(':expire', $lifeTime > 0 ? time() + $lifeTime : null);
    return $statement
      ->execute() instanceof SQLite3Result;
  }

  /**
   * {@inheritdoc}
   */
  protected function doDelete($id) {
    list($idField) = $this
      ->getFields();
    $statement = $this->sqlite
      ->prepare(sprintf('DELETE FROM %s WHERE %s = :id', $this->table, $idField));
    $statement
      ->bindValue(':id', $id);
    return $statement
      ->execute() instanceof SQLite3Result;
  }

  /**
   * {@inheritdoc}
   */
  protected function doFlush() {
    return $this->sqlite
      ->exec(sprintf('DELETE FROM %s', $this->table));
  }

  /**
   * {@inheritdoc}
   */
  protected function doGetStats() {

    // no-op.
  }

  /**
   * Find a single row by ID.
   *
   * @param mixed $id
   * @param boolean $includeData
   *
   * @return array|null
   */
  private function findById($id, $includeData = true) {
    list($idField) = $fields = $this
      ->getFields();
    if (!$includeData) {
      $key = array_search(static::DATA_FIELD, $fields);
      unset($fields[$key]);
    }
    $statement = $this->sqlite
      ->prepare(sprintf('SELECT %s FROM %s WHERE %s = :id LIMIT 1', implode(',', $fields), $this->table, $idField));
    $statement
      ->bindValue(':id', $id, SQLITE3_TEXT);
    $item = $statement
      ->execute()
      ->fetchArray(SQLITE3_ASSOC);
    if ($item === false) {
      return null;
    }
    if ($this
      ->isExpired($item)) {
      $this
        ->doDelete($id);
      return null;
    }
    return $item;
  }

  /**
   * Gets an array of the fields in our table.
   *
   * @return array
   */
  private function getFields() {
    return array(
      static::ID_FIELD,
      static::DATA_FIELD,
      static::EXPIRATION_FIELD,
    );
  }

  /**
   * Check if the item is expired.
   *
   * @param array $item
   * @return boolean
   */
  private function isExpired(array $item) {
    return isset($item[static::EXPIRATION_FIELD]) && $item[self::EXPIRATION_FIELD] !== null && $item[self::EXPIRATION_FIELD] < time();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Cache::STATS_HITS		constant
Cache::STATS_MEMORY_AVAILABLE		constant
Cache::STATS_MEMORY_AVAILIABLE		constant	Only for backward compatibility (may be removed in next major release)
Cache::STATS_MEMORY_USAGE		constant
Cache::STATS_MISSES		constant
Cache::STATS_UPTIME		constant
CacheProvider::$namespace	private	property	The namespace to prefix all cache ids with.
CacheProvider::$namespaceVersion	private	property	The namespace version.
CacheProvider::contains	public	function	Tests if an entry exists in the cache. Overrides Cache::contains
CacheProvider::delete	public	function	Deletes a cache entry. Overrides Cache::delete
CacheProvider::deleteAll	public	function	Deletes all cache entries in the current cache namespace. Overrides ClearableCache::deleteAll
CacheProvider::DOCTRINE_NAMESPACE_CACHEKEY		constant
CacheProvider::doFetchMultiple	protected	function	Default implementation of doFetchMultiple. Each driver that supports multi-get should owerwrite it.	4
CacheProvider::fetch	public	function	Fetches an entry from the cache. Overrides Cache::fetch
CacheProvider::fetchMultiple	public	function	Returns an associative array of values for keys is found in cache. Overrides MultiGetCache::fetchMultiple
CacheProvider::flushAll	public	function	Flushes all cache entries, globally. Overrides FlushableCache::flushAll
CacheProvider::getNamespace	public	function	Retrieves the namespace that prefixes all cache ids.
CacheProvider::getNamespaceCacheKey	private	function	Returns the namespace cache key.
CacheProvider::getNamespacedId	private	function	Prefixes the passed id with the configured namespace value.
CacheProvider::getNamespaceVersion	private	function	Returns the namespace version.
CacheProvider::getStats	public	function	Retrieves cached information from the data store. Overrides Cache::getStats
CacheProvider::save	public	function	Puts data into the cache. Overrides Cache::save
CacheProvider::setNamespace	public	function	Sets the namespace to prefix all cache ids with.	1
SQLite3Cache::$sqlite	private	property
SQLite3Cache::$table	private	property
SQLite3Cache::DATA_FIELD		constant	The data field will store the serialized PHP value.
SQLite3Cache::doContains	protected	function	Tests if an entry exists in the cache. Overrides CacheProvider::doContains
SQLite3Cache::doDelete	protected	function	Deletes a cache entry. Overrides CacheProvider::doDelete
SQLite3Cache::doFetch	protected	function	Fetches an entry from the cache. Overrides CacheProvider::doFetch
SQLite3Cache::doFlush	protected	function	Flushes all cache entries. Overrides CacheProvider::doFlush
SQLite3Cache::doGetStats	protected	function	Retrieves cached information from the data store. Overrides CacheProvider::doGetStats
SQLite3Cache::doSave	protected	function	Puts data into the cache. Overrides CacheProvider::doSave
SQLite3Cache::EXPIRATION_FIELD		constant	The expiration field will store a date value indicating when the cache entry should expire.
SQLite3Cache::findById	private	function	Find a single row by ID.
SQLite3Cache::getFields	private	function	Gets an array of the fields in our table.
SQLite3Cache::ID_FIELD		constant	The ID field will store the cache key.
SQLite3Cache::isExpired	private	function	Check if the item is expired.
SQLite3Cache::__construct	public	function	Constructor.