Summary

Fully Qualified Name:	Laminas\Cache\Storage\Adapter\BlackHole
Implements:	StorageInterface, AvailableSpaceCapableInterface, ClearByNamespaceInterface, ClearByPrefixInterface, ClearExpiredInterface, FlushableInterface, IterableInterface, OptimizableInterface, TaggableInterface, TotalSpaceCapableInterface

Description

Methods

Name	Description	Defined By
__construct()	Constructor	BlackHole
addItem()	Add an item.	BlackHole
addItems()	Add multiple items.	BlackHole
checkAndSetItem()	Set an item only if token matches	BlackHole
clearByNamespace()	Remove items of given namespace	BlackHole
clearByPrefix()	Remove items matching given prefix	BlackHole
clearByTags()	Remove items matching given tags.	BlackHole
clearExpired()	Remove expired items	BlackHole
decrementItem()	Decrement an item.	BlackHole
decrementItems()	Decrement multiple items.	BlackHole
flush()	Flush the whole storage	BlackHole
getAvailableSpace()	Get available space in bytes	BlackHole
getCapabilities()	Capabilities of this storage	BlackHole
getItem()	Get an item.	BlackHole
getItems()	Get multiple items.	BlackHole
getIterator()	Get the storage iterator	BlackHole
getMetadata()	Get metadata of an item.	BlackHole
getMetadatas()	Get multiple metadata	BlackHole
getOptions()	Get options	BlackHole
getTags()	Get tags of an item by given key	BlackHole
getTotalSpace()	Get total space in bytes	BlackHole
hasItem()	Test if an item exists.	BlackHole
hasItems()	Test multiple items.	BlackHole
incrementItem()	Increment an item.	BlackHole
incrementItems()	Increment multiple items.	BlackHole
optimize()	Optimize the storage	BlackHole
removeItem()	Remove an item.	BlackHole
removeItems()	Remove multiple items.	BlackHole
replaceItem()	Replace an existing item.	BlackHole
replaceItems()	Replace multiple existing items.	BlackHole
setItem()	Store an item.	BlackHole
setItems()	Store multiple items.	BlackHole
setOptions()	Set options.	BlackHole
setTags()	Set tags to an item by given key.	BlackHole
touchItem()	Reset lifetime of an item	BlackHole
touchItems()	Reset lifetime of multiple items.	BlackHole

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	null|array|\Traversable|\AdapterOptions

Returns:

addItem()

Add an item.

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: bool

addItems()

Add multiple items.

Parameter Name	Type	Description
$keyValuePairs	array

Returns: array Array of not stored keys

checkAndSetItem()

Set an item only if token matches

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

Parameter Name	Type	Description
$token	mixed
$key	string
$value	mixed

Returns: bool

clearByNamespace()

Remove items of given namespace

Parameter Name	Type	Description
$namespace	string

Returns: bool

clearByPrefix()

Remove items matching given prefix

Parameter Name	Type	Description
$prefix	string

Returns: bool

clearByTags()

Remove items matching given tags.

If $disjunction only one of the given tags must match else all given tags must match.

Parameter Name	Type	Description
$tags	string[]
$disjunction	bool

Returns: bool

clearExpired()

Remove expired items

Returns: bool

decrementItem()

Decrement an item.

Parameter Name	Type	Description
$key	string
$value	int

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

decrementItems()

Decrement multiple items.

Parameter Name	Type	Description
$keyValuePairs	array

Returns: array Associative array of keys and new values

flush()

Flush the whole storage

Returns: bool

getAvailableSpace()

Get available space in bytes

Returns: int|float

getCapabilities()

Capabilities of this storage

Returns: \Capabilities

getItem()

Get an item.

Parameter Name	Type	Description
$key	string
$success	bool
$casToken	mixed

Returns: mixed Data on success, null on failure

getItems()

Get multiple items.

Parameter Name	Type	Description
$keys	array

Returns: array Associative array of keys and values

getIterator()

Get the storage iterator

Returns: \KeyListIterator

getMetadata()

Get metadata of an item.

Parameter Name	Type	Description
$key	string

Returns: array|bool Metadata on success, false on failure

getMetadatas()

Get multiple metadata

Parameter Name	Type	Description
$keys	array

Returns: array Associative array of keys and metadata

getOptions()

Get options

Returns: \AdapterOptions

getTags()

Get tags of an item by given key

Parameter Name	Type	Description
$key	string

Returns: string[]|bool

getTotalSpace()

Get total space in bytes

Returns: int|float

hasItem()

Test if an item exists.

Parameter Name	Type	Description
$key	string

Returns: bool

hasItems()

Test multiple items.

Parameter Name	Type	Description
$keys	array

Returns: array Array of found keys

incrementItem()

Increment an item.

Parameter Name	Type	Description
$key	string
$value	int

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

incrementItems()

Increment multiple items.

Parameter Name	Type	Description
$keyValuePairs	array

Returns: array Associative array of keys and new values

optimize()

Optimize the storage

Returns: bool

removeItem()

Remove an item.

Parameter Name	Type	Description
$key	string

Returns: bool

removeItems()

Remove multiple items.

Parameter Name	Type	Description
$keys	array

Returns: array Array of not removed keys

replaceItem()

Replace an existing item.

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: bool

replaceItems()

Replace multiple existing items.

Parameter Name	Type	Description
$keyValuePairs	array

Returns: array Array of not stored keys

setItem()

Store an item.

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: bool

setItems()

Store multiple items.

Parameter Name	Type	Description
$keyValuePairs	array

Returns: array Array of not stored keys

setOptions()

Set options.

Parameter Name	Type	Description
$options	array|\Traversable|\AdapterOptions

Returns: \BlackHole Provides a fluent interface

setTags()

Set tags to an item by given key.

An empty array will remove all tags.

Parameter Name	Type	Description
$key	string
$tags	string[]

Returns: bool

touchItem()

Reset lifetime of an item

Parameter Name	Type	Description
$key	string

Returns: bool

touchItems()

Reset lifetime of multiple items.

Parameter Name	Type	Description
$keys	array

Returns: array Array of not updated keys