ICanBoogie/Storage 2.1.x
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Storage
      • Codec
      • Storage

Classes

  • APCStorage
  • CacheCollection
  • FileStorage
  • FileStorageIterator
  • RedisStorage
  • RunTimeStorage
  • StorageCollection

Interfaces

  • Cache
  • Codec
  • Storage
 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 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Storage;

/**
 * An interface for classes implementing storage capabilities.
 */
interface Storage extends Cache
{
    /**
     * Stores a variable.
     *
     * @param string $key Store the variable using this name. keys are cache-unique, so storing
     * a second value with the same key will overwrite the original value.
     * @param mixed $value The value to store.
     * @param string $ttl Time To Live; store `value` in the cache for `ttl` seconds. After the
     * `ttl` has passed, the stored value won't be available for the next request. If no `ttl` is
     * supplied (or if the `ttl` is empty), the value will persist until it is removed from the
     * cache manually, or otherwise fails to exist in the cache.
     */
    public function store($key, $value, $ttl = null);

    /**
     * Removes a value and its key.
     *
     * @param string $key
     */
    public function eliminate($key);

    /**
     * Clears the cache.
     */
    public function clear();
}
ICanBoogie/Storage 2.1.x API documentation generated by ApiGen