Class ArrayStore

A key-value store backed by a PHP array.

The contents of the store are lost when the store is released from memory.

Webmozart\KeyValueStore\ArrayStore implements Webmozart\KeyValueStore\Api\SortableStore, Webmozart\KeyValueStore\Api\CountableStore

Direct known subclasses

Webmozart\KeyValueStore\SerializingArrayStore

Namespace: Webmozart\KeyValueStore
Since: 1.0
Author: Bernhard Schussek bschussek@gmail.com
Located at ArrayStore.php

Methods summary
`public`	# `__construct( array $array = array(), $flags = 0 )` Creates a new store. Creates a new store. Parameters `$array` The values to set initially in the store. `$flags`
`public`	# `set( integer\|string $key, mixed $value )` Sets the value for a key in the store. Sets the value for a key in the store. Parameters `$key` The key to set. `$value` The value to set for the key. Throws WriteException If the store cannot be written. InvalidKeyException If the key is not a string or integer. SerializationFailedException If the value cannot be serialized. UnsupportedValueException If the value is not supported by the implementation. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::set()`
`public mixed`	# `get( integer\|string $key, mixed $default = null )` Returns the value of a key in the store. Returns the value of a key in the store. Parameters `$key` The key to get. `$default` The default value to return if the key does not exist. Returns mixed The value of the key or the default value if the key does not exist. Throws ReadException If the store cannot be read. InvalidKeyException If the key is not a string or integer. UnserializationFailedException If the stored value cannot be unserialized. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::get()`
`public mixed`	# `getOrFail( integer\|string $key )` Returns the value of a key in the store. Returns the value of a key in the store. Parameters `$key` The key to get. Returns mixed The value of the key. Throws ReadException If the store cannot be read. `Webmozart\KeyValueStore\Api\NoSuchKeyException` If the key was not found. InvalidKeyException If the key is not a string or integer. UnserializationFailedException If the stored value cannot be unserialized. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::getOrFail()`
`public array`	# `getMultiple( array $keys, mixed $default = null )` Returns the values of multiple keys in the store. Returns the values of multiple keys in the store. Parameters `$keys` The keys to get. The keys must be strings or integers. `$default` The default value to return for keys that are not found. Returns array The values of the passed keys, indexed by the keys. Throws ReadException If the store cannot be read. InvalidKeyException If a key is not a string or integer. UnserializationFailedException If a stored value cannot be unserialized. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::getMultiple()`
`public array`	# `getMultipleOrFail( array $keys )` Returns the values of multiple keys in the store. Returns the values of multiple keys in the store. Parameters `$keys` The keys to get. The keys must be strings or integers. Returns array The values of the passed keys, indexed by the keys. Throws ReadException If the store cannot be read. `Webmozart\KeyValueStore\Api\NoSuchKeyException` If a key was not found. InvalidKeyException If a key is not a string or integer. UnserializationFailedException If a stored value cannot be unserialized. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::getMultipleOrFail()`
`public boolean`	# `remove( integer\|string $key )` Removes a key from the store. Removes a key from the store. Parameters `$key` The key to remove. Returns boolean Returns `true` if a key was removed from the store. Throws WriteException If the store cannot be written. InvalidKeyException If the key is not a string or integer. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::remove()`
`public boolean`	# `exists( integer\|string $key )` Returns whether a key exists. Returns whether a key exists. Parameters `$key` The key to test. Returns boolean Whether the key exists in the store. Throws ReadException If the store cannot be read. InvalidKeyException If the key is not a string or integer. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::exists()`
`public`	# `clear( )` Removes all keys from the store. Removes all keys from the store. Throws WriteException If the store cannot be written. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::clear()`
`public array`	# `keys( )` Returns all keys currently stored in the store. Returns all keys currently stored in the store. Returns array The keys stored in the store. Each key is either a string or an integer. The order of the keys is undefined. Throws ReadException If the store cannot be read. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::keys()`
`public array`	# `toArray( )` Returns the contents of the store as array. Returns the contents of the store as array. Returns array The keys and values in the store.
`public`	# `sort( integer $flags = SORT_REGULAR )` Sort the store by its keys. Sort the store by its keys. Parameters `$flags` Sorting type flags (from the standard PHP sort flags). Throws ReadException If the store cannot be read. WriteException If the store cannot be written. Implementation of `Webmozart\KeyValueStore\Api\SortableStore::sort()`
`public`	# `count( )` Count the number of keys in the store. Count the number of keys in the store. Throws ReadException If the store cannot be read. Implementation of `Webmozart\KeyValueStore\Api\CountableStore::count()`

Constants summary
`integer`	`SERIALIZE` Flag: Enable serialization. Flag: Enable serialization.	# `1`

Namespaces

Classes

Class ArrayStore

Direct known subclasses

Parameters

Parameters

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Throws

Implementation of

Returns

Throws

Implementation of

Returns

Parameters

Throws

Implementation of

Throws

Implementation of