<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Cache\Storage;
use Traversable;
interface StorageInterface
{
/**
* Set options.
*
* @param array|Traversable|Adapter\AdapterOptions $options
* @return StorageInterface Fluent interface
*/
public function setOptions($options);
/**
* Get options
*
* @return Adapter\AdapterOptions
*/
public function getOptions();
/* reading */
/**
* Get an item.
*
* @param string $key
* @param bool $success
* @param mixed $casToken
* @return mixed Data on success, null on failure
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function getItem($key, & $success = null, & $casToken = null);
/**
* Get multiple items.
*
* @param array $keys
* @return array Associative array of keys and values
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function getItems(array $keys);
/**
* Test if an item exists.
*
* @param string $key
* @return bool
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function hasItem($key);
/**
* Test multiple items.
*
* @param array $keys
* @return array Array of found keys
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function hasItems(array $keys);
/**
* Get metadata of an item.
*
* @param string $key
* @return array|bool Metadata on success, false on failure
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function getMetadata($key);
/**
* Get multiple metadata
*
* @param array $keys
* @return array Associative array of keys and metadata
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function getMetadatas(array $keys);
/* writing */
/**
* Store an item.
*
* @param string $key
* @param mixed $value
* @return bool
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function setItem($key, $value);
/**
* Store multiple items.
*
* @param array $keyValuePairs
* @return array Array of not stored keys
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function setItems(array $keyValuePairs);
/**
* Add an item.
*
* @param string $key
* @param mixed $value
* @return bool
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function addItem($key, $value);
/**
* Add multiple items.
*
* @param array $keyValuePairs
* @return array Array of not stored keys
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function addItems(array $keyValuePairs);
/**
* Replace an existing item.
*
* @param string $key
* @param mixed $value
* @return bool
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function replaceItem($key, $value);
/**
* Replace multiple existing items.
*
* @param array $keyValuePairs
* @return array Array of not stored keys
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function replaceItems(array $keyValuePairs);
/**
* Set an item only if token matches
*
* It uses the token received from getItem() to check if the item has
* changed before overwriting it.
*
* @param mixed $token
* @param string $key
* @param mixed $value
* @return bool
* @throws \Zend\Cache\Exception\ExceptionInterface
* @see getItem()
* @see setItem()
*/
public function checkAndSetItem($token, $key, $value);
/**
* Reset lifetime of an item
*
* @param string $key
* @return bool
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function touchItem($key);
/**
* Reset lifetime of multiple items.
*
* @param array $keys
* @return array Array of not updated keys
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function touchItems(array $keys);
/**
* Remove an item.
*
* @param string $key
* @return bool
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function removeItem($key);
/**
* Remove multiple items.
*
* @param array $keys
* @return array Array of not removed keys
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function removeItems(array $keys);
/**
* Increment an item.
*
* @param string $key
* @param int $value
* @return int|bool The new value on success, false on failure
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function incrementItem($key, $value);
/**
* Increment multiple items.
*
* @param array $keyValuePairs
* @return array Associative array of keys and new values
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function incrementItems(array $keyValuePairs);
/**
* Decrement an item.
*
* @param string $key
* @param int $value
* @return int|bool The new value on success, false on failure
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function decrementItem($key, $value);
/**
* Decrement multiple items.
*
* @param array $keyValuePairs
* @return array Associative array of keys and new values
* @throws \Zend\Cache\Exception\ExceptionInterface
*/
public function decrementItems(array $keyValuePairs);
/* status */
/**
* Capabilities of this storage
*
* @return Capabilities
*/
public function getCapabilities();
}
# |
Change |
User |
Description |
Committed |
|
#1
|
18334 |
Liz Lam |
initial add of jambox |
|
|