StorageInterface Interface Reference

Public Member Functions
	setOptions ($options)
	Set options.
	getOptions ()
	Get options.
	getItem ($key, &$success=null, &$casToken=null)
	Get an item.
	getItems (array $keys)
	Get multiple items.
	hasItem ($key)
	Test if an item exists.
	hasItems (array $keys)
	Test multiple items.
	getMetadata ($key)
	Get metadata of an item.
	getMetadatas (array $keys)
	Get multiple metadata.
	setItem ($key, $value)
	Store an item.
	setItems (array $keyValuePairs)
	Store multiple items.
	addItem ($key, $value)
	Add an item.
	addItems (array $keyValuePairs)
	Add multiple items.
	replaceItem ($key, $value)
	Replace an existing item.
	replaceItems (array $keyValuePairs)
	Replace multiple existing items.
	checkAndSetItem ($token, $key, $value)
	Set an item only if token matches.
	touchItem ($key)
	Reset lifetime of an item.
	touchItems (array $keys)
	Reset lifetime of multiple items.
	removeItem ($key)
	Remove an item.
	removeItems (array $keys)
	Remove multiple items.
	incrementItem ($key, $value)
	Increment an item.
	incrementItems (array $keyValuePairs)
	Increment multiple items.
	decrementItem ($key, $value)
	Decrement an item.
	decrementItems (array $keyValuePairs)
	Decrement multiple items.
	getCapabilities ()
	Capabilities of this storage.

Member Function Documentation

addItem	(		$key,
			$value
	)

Add an item.

Parameters

string	$key
mixed	$value

Returns

bool

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

addItems

(

array

$keyValuePairs

)

Add multiple items.

Parameters

array

$keyValuePairs

Returns

array Array of not stored keys

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

checkAndSetItem	(		$token,
			$key,
			$value
	)

Set an item only if token matches.

It uses the token received from getItem() to check if the item has changed before overwriting it.

Parameters

mixed	$token
string	$key
mixed	$value

Returns

bool

Exceptions

\Zend\Cache\Exception\ExceptionInterface

See Also

getItem()

setItem()

Implemented in AbstractAdapter, Filesystem, and BlackHole.

decrementItem	(		$key,
			$value
	)

Decrement an item.

Parameters

string	$key
int	$value

Returns

int|bool The new value on success, false on failure

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, and BlackHole.

decrementItems

(

array

$keyValuePairs

)

Decrement multiple items.

Parameters

array

$keyValuePairs

Returns

array Associative array of keys and new values

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, and BlackHole.

getCapabilities

(

)

Capabilities of this storage.

Returns

Capabilities

Implemented in AbstractAdapter, and BlackHole.

getItem	(		$key,
		&	$success = null,
		&	$casToken = null
	)

Get an item.

Parameters

string	$key
bool	$success
mixed	$casToken

Returns

mixed Data on success, null on failure

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

getItems

(

array

$keys

)

Get multiple items.

Parameters

array

$keys

Returns

array Associative array of keys and values

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

getMetadata

(

$key

)

Get metadata of an item.

Parameters

string

$key

Returns

array|bool Metadata on success, false on failure

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

getMetadatas

(

array

$keys

)

Get multiple metadata.

Parameters

array

$keys

Returns

array Associative array of keys and metadata

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, and BlackHole.

getOptions

(

)

Get options.

Returns

Adapter

Implemented in AbstractAdapter, Redis, Memcache, Memcached, MongoDb, Dba, BlackHole, XCache, Apc, Filesystem, Apcu, WinCache, Memory, and Session.

hasItem

(

$key

)

Test if an item exists.

Parameters

string

$key

Returns

bool

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

hasItems

(

array

$keys

)

Test multiple items.

Parameters

array

$keys

Returns

array Array of found keys

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

incrementItem	(		$key,
			$value
	)

Increment an item.

Parameters

string	$key
int	$value

Returns

int|bool The new value on success, false on failure

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, and BlackHole.

incrementItems

(

array

$keyValuePairs

)

Increment multiple items.

Parameters

array

$keyValuePairs

Returns

array Associative array of keys and new values

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, and BlackHole.

removeItem

(

$key

)

Remove an item.

Parameters

string

$key

Returns

bool

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, Filesystem, and BlackHole.

removeItems

(

array

$keys

)

Remove multiple items.

Parameters

array

$keys

Returns

array Array of not removed keys

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, Filesystem, and BlackHole.

replaceItem	(		$key,
			$value
	)

Replace an existing item.

Parameters

string	$key
mixed	$value

Returns

bool

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, Filesystem, and BlackHole.

replaceItems

(

array

$keyValuePairs

)

Replace multiple existing items.

Parameters

array

$keyValuePairs

Returns

array Array of not stored keys

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, Filesystem, and BlackHole.

setItem	(		$key,
			$value
	)

Store an item.

Parameters

string	$key
mixed	$value

Returns

bool

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

setItems

(

array

$keyValuePairs

)

Store multiple items.

Parameters

array

$keyValuePairs

Returns

array Array of not stored keys

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in Filesystem, AbstractAdapter, and BlackHole.

setOptions

(

$options

)

Set options.

Parameters

array | Traversable | Adapter\AdapterOptions

$options

Returns

StorageInterface Fluent interface

Implemented in Redis, AbstractAdapter, Memcache, Memcached, MongoDb, Dba, XCache, BlackHole, Apc, Filesystem, Apcu, WinCache, Memory, and Session.

touchItem

(

$key

)

Reset lifetime of an item.

Parameters

string

$key

Returns

bool

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, Filesystem, and BlackHole.

touchItems

(

array

$keys

)

Reset lifetime of multiple items.

Parameters

array

$keys

Returns

array Array of not updated keys

Exceptions

\Zend\Cache\Exception\ExceptionInterface

Implemented in AbstractAdapter, Filesystem, and BlackHole.