---
title: "Phalcon Storage"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Storage
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Storage\AdapterFactory
Class
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.20/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Storage\AdapterFactory`**
`Exception` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Factory\AbstractFactory` · `Phalcon\Storage\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Apcu` · `Phalcon\Storage\Adapter\Libmemcached` · `Phalcon\Storage\Adapter\Memory` · `Phalcon\Storage\Adapter\Redis` · `Phalcon\Storage\Adapter\RedisCluster` · `Phalcon\Storage\Adapter\Stream` · `Phalcon\Storage\Adapter\Weak` · `Throwable`
### Method Summary
AdapterFactory constructor.
Create a new instance of the adapter
Returns the available adapters
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $services = []
);
```
AdapterFactory constructor.
newInstance()
```php
public function newInstance(
string $name,
array $options = []
): AdapterInterface;
```
Create a new instance of the adapter
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
## Storage\Adapter\AbstractAdapter
Abstract
Storage AbstractAdapter
- **`Phalcon\Storage\Adapter\AbstractAdapter`** - implements [`Phalcon\Storage\Adapter\AdapterInterface`](#storageadapteradapterinterface), [`Phalcon\Events\EventsAwareInterface`](/5.20/api/phalcon_events/#eventseventsawareinterface)
- [`Phalcon\Storage\Adapter\Apcu`](#storageadapterapcu)
- [`Phalcon\Storage\Adapter\Libmemcached`](#storageadapterlibmemcached)
- [`Phalcon\Storage\Adapter\Memory`](#storageadaptermemory)
- [`Phalcon\Storage\Adapter\Redis`](#storageadapterredis)
- [`Phalcon\Storage\Adapter\Stream`](#storageadapterstream)
- [`Phalcon\Storage\Adapter\Weak`](#storageadapterweak)
`DateInterval` · `DateTime` · `Exception` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Events\EventsAwareInterface` · `Phalcon\Events\ManagerInterface` · `Phalcon\Events\Traits\EventsAwareTrait` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Storage\Serializer\SerializerInterface` · `Phalcon\Traits\Support\Helper\Arr\GetTrait`
### Method Summary
Flushes/clears the cache
Decrements a stored number
Deletes data from the adapter
Deletes multiple data from the adapter
Reads data from the adapter
Returns the adapter - connects to the storage if not connected
Name of the default serializer class
Returns all the keys stored
Returns the lifetime
Returns the prefix
Get the serializer
Checks if an element exists in the cache
Increments a stored number
Stores data in the adapter. If the TTL is `null` (default) or not defined
AbstractAdapter constructor.
Decrements a stored number
Deletes data from the adapter
Deletes multiple data from the adapter
Checks if an element exists in the cache
Increments a stored number
Stores data in the adapter. If the TTL is `null` (default) or not defined
Filters the keys array based on global and passed prefix
Check if the key has the prefix and remove it, otherwise just return the
Returns the key requested, prefixed
Returns serialized data
Calculates the TTL for a cache item
Returns unserialized data
Initializes the serializer
### Properties
Classes the "php" serializer may instantiate: true, false or a list
of class names (the "allowedClasses" option)
Name of the default serializer class
EventType prefix.
Name of the default TTL (time to live)
Whether a leading prefix is stripped from incoming keys before the
adapter prefix is applied. Disable when keys are externally
generated identifiers that may legitimately start with the prefix
text (e.g. session ids).
### Methods
clear()
```php
abstract public function clear(): bool;
```
Flushes/clears the cache
decrement()
```php
public function decrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number
delete()
```php
public function delete( string $key ): bool;
```
Deletes data from the adapter
deleteMultiple()
```php
public function deleteMultiple( array $keys ): bool;
```
Deletes multiple data from the adapter
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
Reads data from the adapter
getAdapter()
```php
public function getAdapter(): mixed;
```
Returns the adapter - connects to the storage if not connected
getDefaultSerializer()
```php
public function getDefaultSerializer(): string;
```
Name of the default serializer class
getKeys()
```php
abstract public function getKeys( string $prefix = "" ): array;
```
Returns all the keys stored
getLifetime()
```php
public function getLifetime(): int;
```
Returns the lifetime
getPrefix()
```php
public function getPrefix(): string;
```
Returns the prefix
getSerializer()
```php
public function getSerializer(): SerializerInterface|null;
```
Get the serializer
has()
```php
public function has( string $key ): bool;
```
Checks if an element exists in the cache
increment()
```php
public function increment(
string $key,
int $value = 1
): false|int;
```
Increments a stored number
set()
```php
public function set(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
setDefaultSerializer()
```php
public function setDefaultSerializer( string $serializer ): void;
```
__construct()
```php
protected function __construct(
SerializerFactory $serializerFactory,
array $options = []
);
```
AbstractAdapter constructor.
doDecrement()
```php
abstract protected function doDecrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number
doDelete()
```php
abstract protected function doDelete( string $key ): bool;
```
Deletes data from the adapter
doDeleteMultiple()
```php
protected function doDeleteMultiple( array $keys ): bool;
```
Deletes multiple data from the adapter
doGet()
```php
protected function doGet(
string $key,
mixed $defaultValue = null
): mixed;
```
doGetData()
```php
protected function doGetData( string $key ): mixed;
```
doHas()
```php
abstract protected function doHas( string $key ): bool;
```
Checks if an element exists in the cache
doIncrement()
```php
abstract protected function doIncrement(
string $key,
int $value = 1
): false|int;
```
Increments a stored number
doSet()
```php
abstract protected function doSet(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
getFilteredKeys()
```php
protected function getFilteredKeys(
mixed $keys,
string $prefix
): array;
```
Filters the keys array based on global and passed prefix
getKeyWithoutPrefix()
```php
protected function getKeyWithoutPrefix( string $key ): string;
```
Check if the key has the prefix and remove it, otherwise just return the
key unaltered. When the `stripPrefix` option is `false` the key is
always returned unaltered.
getPrefixedKey()
```php
protected function getPrefixedKey( mixed $key ): string;
```
Returns the key requested, prefixed
getSerializedData()
```php
protected function getSerializedData( mixed $content ): mixed;
```
Returns serialized data
getTtl()
```php
protected function getTtl( mixed $ttl ): int;
```
Calculates the TTL for a cache item
getUnserializedData()
```php
protected function getUnserializedData(
mixed $content,
mixed $defaultValue = null
): mixed;
```
Returns unserialized data
initSerializer()
```php
protected function initSerializer(): void;
```
Initializes the serializer
## Storage\Adapter\AdapterInterface
Interface
Interface for Phalcon\Logger adapters
- **`Phalcon\Storage\Adapter\AdapterInterface`**
- [`Phalcon\Cache\Adapter\AdapterInterface`](/5.20/api/phalcon_cache/#cacheadapteradapterinterface)
`DateInterval` · `Phalcon\Contracts\Storage\StorageTypes`
### Method Summary
Flushes/clears the cache
Decrements a stored number
Deletes data from the adapter
Deletes multiple data from the adapter
Reads data from the adapter
Returns the already connected adapter or connects to the backend
Returns all the keys stored
Returns the prefix for the keys
Checks if an element exists in the cache
Increments a stored number
Stores data in the adapter. If the TTL is `null` (default) or not defined
Stores data in the adapter forever. The key needs to be manually deleted
### Methods
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
decrement()
```php
public function decrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number
delete()
```php
public function delete( string $key ): bool;
```
Deletes data from the adapter
deleteMultiple()
```php
public function deleteMultiple( array $keys ): bool;
```
Deletes multiple data from the adapter
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
Reads data from the adapter
getAdapter()
```php
public function getAdapter(): mixed;
```
Returns the already connected adapter or connects to the backend
server(s)
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Returns all the keys stored
getPrefix()
```php
public function getPrefix(): string;
```
Returns the prefix for the keys
has()
```php
public function has( string $key ): bool;
```
Checks if an element exists in the cache
increment()
```php
public function increment(
string $key,
int $value = 1
): false|int;
```
Increments a stored number
set()
```php
public function set(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
setForever()
```php
public function setForever(
string $key,
mixed $data
): bool;
```
Stores data in the adapter forever. The key needs to be manually deleted
from the adapter.
## Storage\Adapter\Apcu
Class
Apcu adapter
Capabilities:
- Counters: native atomic (apcu_inc()/apcu_dec()).
- getKeys(): APCUIterator regex scan over the shared APCu store.
- Serializers: Phalcon-side only; no backend-native serializer.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Apcu`**
- [`Phalcon\Cache\Adapter\Apcu`](/5.20/api/phalcon_cache/#cacheadapterapcu)
`APCUIterator` · `Exception` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Traits\Php\ApcuTrait`
### Method Summary
Apcu constructor.
Flushes/clears the cache
Stores data in the adapter
Stores data in the adapter forever. The key needs to manually deleted
Decrements a stored number
Deletes data from the adapter
Deletes multiple keys from APCu in a single call
Checks if an element exists in the cache
Increments a stored number
Stores data in the adapter. If the TTL is `null` (default) or not defined
### Properties
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $options = []
);
```
Apcu constructor.
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Stores data in the adapter
setForever()
```php
public function setForever(
string $key,
mixed $data
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number
doDelete()
```php
protected function doDelete( string $key ): bool;
```
Deletes data from the adapter
doDeleteMultiple()
```php
protected function doDeleteMultiple( array $keys ): bool;
```
Deletes multiple keys from APCu in a single call
doGetData()
```php
protected function doGetData( string $key ): mixed;
```
doHas()
```php
protected function doHas( string $key ): bool;
```
Checks if an element exists in the cache
doIncrement()
```php
protected function doIncrement(
string $key,
int $value = 1
): false|int;
```
Increments a stored number
doSet()
```php
protected function doSet(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
## Storage\Adapter\Libmemcached
Class
Libmemcached adapter
Capabilities:
- Counters: native atomic (Memcached::increment()/decrement()).
- getKeys(): Memcached::getAllKeys(), which is server-dependent and may be
incomplete or unavailable on modern memcached builds.
- Serializers: Phalcon-side plus libmemcached's own options.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Libmemcached`**
- [`Phalcon\Cache\Adapter\Libmemcached`](/5.20/api/phalcon_cache/#cacheadapterlibmemcached)
`DateInterval` · `Exception` · `Memcached` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Storage\Exception` · `Phalcon\Storage\Exceptions\ConnectionFailed` · `Phalcon\Storage\Exceptions\InvalidConfiguration` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Support\Exception`
### Method Summary
Libmemcached constructor.
Flushes/clears the cache
Returns the already connected adapter or connects to the Memcached
Stores data in the adapter
Stores data in the adapter forever. The key needs to be manually deleted
Decrements a stored number
Deletes data from the adapter
Deletes multiple keys from Memcached using a single deleteMulti call
Checks if an element exists in the cache
Increments a stored number
Stores data in the adapter. If the TTL is `null` (default) or not defined
### Properties
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $options = []
);
```
Libmemcached constructor.
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
getAdapter()
```php
public function getAdapter(): mixed;
```
Returns the already connected adapter or connects to the Memcached
server(s)
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Stores data in the adapter
setForever()
```php
public function setForever(
string $key,
mixed $data
): bool;
```
Stores data in the adapter forever. The key needs to be manually deleted
from the adapter.
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number
doDelete()
```php
protected function doDelete( string $key ): bool;
```
Deletes data from the adapter
doDeleteMultiple()
```php
protected function doDeleteMultiple( array $keys ): bool;
```
Deletes multiple keys from Memcached using a single deleteMulti call
doHas()
```php
protected function doHas( string $key ): bool;
```
Checks if an element exists in the cache
doIncrement()
```php
protected function doIncrement(
string $key,
int $value = 1
): false|int;
```
Increments a stored number
doSet()
```php
protected function doSet(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
## Storage\Adapter\Memory
Class
Memory adapter
Capabilities:
- Scope: per-request, in-process; nothing is shared across requests or
processes and the store is discarded when the request ends.
- Counters: read-modify-write on the in-memory array.
- getKeys(): in-memory array scan (cheap).
- Optional maxItems FIFO cap drops the oldest entry before a new key is set.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Memory`**
- [`Phalcon\Cache\Adapter\Memory`](/5.20/api/phalcon_cache/#cacheadaptermemory)
`Exception` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Storage\SerializerFactory`
### Method Summary
Memory constructor.
Flushes/clears the cache
Stores data in the adapter
Returns the configured store cap (0 = unlimited). See setMaxItems().
Stores data in the adapter forever. The key needs to manually deleted
Caps the number of items retained in the in-memory store.
Decrements a stored number
Deletes data from the adapter
Checks if an element exists in the cache
Increments a stored number
Stores data in the adapter. If the TTL is `null` (default) or not defined
### Properties
Maximum number of items retained in the in-memory store.
0 (default) keeps the original unbounded behavior; a positive
value drops the oldest entry FIFO before a new key is stored.
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $options = []
);
```
Memory constructor.
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Stores data in the adapter
getMaxItems()
```php
public function getMaxItems(): int;
```
Returns the configured store cap (0 = unlimited). See setMaxItems().
setForever()
```php
public function setForever(
string $key,
mixed $data
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
setMaxItems()
```php
public function setMaxItems( int $maxItems ): static;
```
Caps the number of items retained in the in-memory store.
0 disables the cap (the default; preserves the original
unbounded behavior). When the cap is exceeded, the oldest
entry is evicted FIFO before a new key is stored.
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number
doDelete()
```php
protected function doDelete( string $key ): bool;
```
Deletes data from the adapter
doGetData()
```php
protected function doGetData( string $key ): mixed;
```
doHas()
```php
protected function doHas( string $key ): bool;
```
Checks if an element exists in the cache
doIncrement()
```php
protected function doIncrement(
string $key,
int $value = 1
): false|int;
```
Increments a stored number
doSet()
```php
protected function doSet(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
## Storage\Adapter\Redis
Class
Redis adapter
Capabilities:
- Counters: native atomic (incrBy()/decrBy()).
- getKeys(): non-blocking SCAN iteration.
- Serializers: Phalcon-side, or backend-native via OPT_SERIALIZER. Native
serializers change the bytes at rest and are not interchangeable with
Phalcon-side serializers.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Redis`**
- [`Phalcon\Cache\Adapter\Redis`](/5.20/api/phalcon_cache/#cacheadapterredis)
- [`Phalcon\Storage\Adapter\RedisCluster`](#storageadapterrediscluster)
`DateInterval` · `Exception` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Storage\Exception` · `Phalcon\Storage\Exceptions\AuthenticationFailed` · `Phalcon\Storage\Exceptions\ConnectionFailed` · `Phalcon\Storage\Exceptions\DatabaseSelectionFailed` · `Phalcon\Storage\SerializerFactory` · `Redis` · `RedisException`
### Method Summary
Redis constructor.
Flushes/clears the cache
Returns the already connected adapter or connects to the Redis
Returns all the keys stored
Stores data in the adapter forever. The key needs to manually deleted
Decrements a stored number
Deletes data from the adapter
Deletes multiple keys from Redis using a single unlink call
Checks if an element exists in the cache
Increments a stored number
Stores data in the adapter. If the TTL is `null` (default) or not defined
The parameter is the raw, user supplied options array; `RedisCluster`
### Properties
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $options = []
);
```
Redis constructor.
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
getAdapter()
```php
public function getAdapter(): mixed;
```
Returns the already connected adapter or connects to the Redis
server(s)
The return type is deliberately left wide: RedisCluster extends this
adapter and hands back a `RedisCluster` client, which is not a `Redis`.
Callers inside this class narrow it to `RedisService` locally.
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Returns all the keys stored
SCAN replaces the blocking KEYS command. SCAN_NOPREFIX keeps the prefix
handling explicit: the physical prefix is matched and returned unchanged,
so getFilteredKeys() sees exactly what KEYS produced.
setForever()
```php
public function setForever(
string $key,
mixed $data
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number
doDelete()
```php
protected function doDelete( string $key ): bool;
```
Deletes data from the adapter
doDeleteMultiple()
```php
protected function doDeleteMultiple( array $keys ): bool;
```
Deletes multiple keys from Redis using a single unlink call
doHas()
```php
protected function doHas( string $key ): bool;
```
Checks if an element exists in the cache
doIncrement()
```php
protected function doIncrement(
string $key,
int $value = 1
): false|int;
```
Increments a stored number
doSet()
```php
protected function doSet(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
getDefaultOptions()
```php
protected function getDefaultOptions( array $options ): array;
```
The parameter is the raw, user supplied options array; `RedisCluster`
overrides this method with its own set of keys, so the two signatures
have to agree on the wider type.
## Storage\Adapter\RedisCluster
Class
RedisCluster adapter
Capabilities (in addition to Redis):
- Counters: native atomic (incrBy()/decrBy()).
- getKeys(): blocking KEYS across all master nodes (per-node SCAN is left to
the redesign); clear() flushes every master.
- Serializers: Phalcon-side, or backend-native via OPT_SERIALIZER.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Redis`](#storageadapterredis)
- **`Phalcon\Storage\Adapter\RedisCluster`**
- [`Phalcon\Cache\Adapter\RedisCluster`](/5.20/api/phalcon_cache/#cacheadapterrediscluster)
`Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Storage\Exceptions\ClusterConnectionFailed` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Support\Exception` · `Redis` · `RedisCluster` · `Throwable`
### Method Summary
You can create and connect to a cluster either by passing it one or more
Flushes/clears the cache
Returns the already connected adapter or connects to the Redis
Returns all the keys stored
### Properties
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $options = []
);
```
You can create and connect to a cluster either by passing it one or more
'seed' nodes, or by defining these in redis.ini as a 'named' cluster.
If you are connecting with the cluster by offering a name, that is
configured in redis.ini:
```
# In redis.ini
redis.clusters.seeds = "mycluster[]=localhost:7000&test[]=localhost:7001"
redis.clusters.timeout = "mycluster=5"
redis.clusters.read_timeout = "mycluster=10"
redis.clusters.auth = "mycluster=password"
```
you can use `$options = ["name" => "mycluster"]`.
If you don't have cluster seeds configured in your redis.ini,
you should pass hosts as an array,
eg. `$options = ["hosts" => ["a-host:7000", "b-host:7001"]]`.
You can provide authentication data offering a string `user=password`
or array `["user" => "name", "password" => "secret"]`.
The `timeout` is the amount of time library will wait when connecting
or writing to the cluster. `readTimeout` is the amount of time library
will wait for a result from the cluster.
The `context` is an array of values used for ssl/tls stream context
options eg `["verify_peer" => 0, "local_cert" => "file:///path/to/cert.pem"]`
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
getAdapter()
```php
public function getAdapter(): mixed;
```
Returns the already connected adapter or connects to the Redis
server(s)
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Returns all the keys stored
RedisCluster::scan() iterates one node at a time, so the blocking KEYS
command is retained here (phpredis routes it across the masters). The
per-node SCAN migration is left to the storage redesign.
getDefaultOptions()
```php
protected function getDefaultOptions( array $options ): array;
```
## Storage\Adapter\Stream
Class
Stream adapter
Capabilities:
- Counters: read-modify-write (doHas()/doGet()/doSet()); not atomic and racy
across concurrent processes.
- getKeys(): recursive directory traversal; cost grows with the entry count.
- Serializers: Phalcon-side only.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Stream`**
- [`Phalcon\Cache\Adapter\Stream`](/5.20/api/phalcon_cache/#cacheadapterstream)
`FilesystemIterator` · `Iterator` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Storage\Exceptions\InvalidConfiguration` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Traits\Php\FileTrait` · `Phalcon\Traits\Support\Helper\Str\DirFromFileTrait` · `Phalcon\Traits\Support\Helper\Str\DirSeparatorTrait` · `RecursiveDirectoryIterator` · `RecursiveIteratorIterator` · `SplFileInfo`
### Method Summary
Stream constructor.
Flushes/clears the cache
Stores data in the adapter
Stores data in the adapter forever. The key needs to manually deleted
Decrements a stored number
Deletes data from the adapter
Reads data from the adapter
Checks if an element exists in the cache and is not expired
Increments a stored number
Stores data in the adapter. If the TTL is `null` (default) or not defined
### Properties
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $options = []
);
```
Stream constructor.
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Stores data in the adapter
setForever()
```php
public function setForever(
string $key,
mixed $data
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number
doDelete()
```php
protected function doDelete( string $key ): bool;
```
Deletes data from the adapter
doGet()
```php
protected function doGet(
string $key,
mixed $defaultValue = null
): mixed;
```
Reads data from the adapter
doHas()
```php
protected function doHas( string $key ): bool;
```
Checks if an element exists in the cache and is not expired
doIncrement()
```php
protected function doIncrement(
string $key,
int $value = 1
): false|int;
```
Increments a stored number
doSet()
```php
protected function doSet(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
## Storage\Adapter\Weak
Class
Weak Adapter
Capabilities:
- Stores objects only, as WeakReferences; entries vanish when the referenced
object is garbage-collected.
- TTL is ignored; no serializer is used (none/no-op).
- Counters unsupported: increment()/decrement() return false.
- setForever() is equivalent to set(); getKeys() reads the in-memory list.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Weak`**
- [`Phalcon\Cache\Adapter\Weak`](/5.20/api/phalcon_cache/#cacheadapterweak)
`Exception` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Storage\SerializerFactory` · `WeakReference`
### Method Summary
Constructor, there are no options
Flushes/clears the cache
Stores data in the adapter
Will never set a serializer, WeakReference cannot be serialized
For compatiblity only, there is no Forever with WeakReference.
Decrements a stored number - not supported for WeakReference
Deletes data from the adapter
Reads data from the adapter
Checks if an element exists in the cache
Increments a stored number - not supported for WeakReference
Stores data in the adapter. If the TTL is `null` (default) or not defined
### Properties
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $options = []
);
```
Constructor, there are no options
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Stores data in the adapter
setDefaultSerializer()
```php
public function setDefaultSerializer( string $serializer ): void;
```
Will never set a serializer, WeakReference cannot be serialized
setForever()
```php
public function setForever(
string $key,
mixed $data
): bool;
```
For compatiblity only, there is no Forever with WeakReference.
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): false|int;
```
Decrements a stored number - not supported for WeakReference
doDelete()
```php
protected function doDelete( string $key ): bool;
```
Deletes data from the adapter
doGet()
```php
protected function doGet(
string $key,
mixed $defaultValue = null
): mixed;
```
Reads data from the adapter
doHas()
```php
protected function doHas( string $key ): bool;
```
Checks if an element exists in the cache
doIncrement()
```php
protected function doIncrement(
string $key,
int $value = 1
): false|int;
```
Increments a stored number - not supported for WeakReference
doSet()
```php
protected function doSet(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Stores data in the adapter. If the TTL is `null` (default) or not defined
then the default TTL will be used, as set in this adapter. If the TTL
is `0` or a negative number, a `delete()` will be issued, since this
item has expired. If you need to set this key forever, you should use
the `setForever()` method.
## Storage\Exception
Class
Phalcon\Storage\Exception
Exceptions thrown in Phalcon\Storage will use this class
- `\Exception`
- **`Phalcon\Storage\Exception`**
- [`Phalcon\Storage\Exceptions\AuthenticationFailed`](#storageexceptionsauthenticationfailed)
- [`Phalcon\Storage\Exceptions\ClusterConnectionFailed`](#storageexceptionsclusterconnectionfailed)
- [`Phalcon\Storage\Exceptions\ConnectionFailed`](#storageexceptionsconnectionfailed)
- [`Phalcon\Storage\Exceptions\DatabaseSelectionFailed`](#storageexceptionsdatabaseselectionfailed)
- [`Phalcon\Storage\Exceptions\InvalidConfiguration`](#storageexceptionsinvalidconfiguration)
- [`Phalcon\Storage\Exceptions\StorageError`](#storageexceptionsstorageerror)
## Storage\Exceptions\AuthenticationFailed
Class
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\AuthenticationFailed`**
`Phalcon\Storage\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Storage\Exceptions\ClusterConnectionFailed
Class
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\ClusterConnectionFailed`**
`Phalcon\Storage\Exception`
## Storage\Exceptions\ConnectionFailed
Class
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\ConnectionFailed`**
`Phalcon\Storage\Exception`
## Storage\Exceptions\DatabaseSelectionFailed
Class
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\DatabaseSelectionFailed`**
`Phalcon\Storage\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Storage\Exceptions\InvalidConfiguration
Class
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\InvalidConfiguration`**
`Phalcon\Storage\Exception`
## Storage\Exceptions\StorageError
Class
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\StorageError`**
`Phalcon\Storage\Exception`
## Storage\SerializerFactory
Class
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.20/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Storage\SerializerFactory`**
`Exception` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Factory\AbstractFactory` · `Phalcon\Storage\Serializer\Base64` · `Phalcon\Storage\Serializer\Igbinary` · `Phalcon\Storage\Serializer\Json` · `Phalcon\Storage\Serializer\MemcachedIgbinary` · `Phalcon\Storage\Serializer\MemcachedJson` · `Phalcon\Storage\Serializer\MemcachedPhp` · `Phalcon\Storage\Serializer\Msgpack` · `Phalcon\Storage\Serializer\None` · `Phalcon\Storage\Serializer\Php` · `Phalcon\Storage\Serializer\RedisIgbinary` · `Phalcon\Storage\Serializer\RedisJson` · `Phalcon\Storage\Serializer\RedisMsgpack` · `Phalcon\Storage\Serializer\RedisNone` · `Phalcon\Storage\Serializer\RedisPhp` · `Phalcon\Storage\Serializer\SerializerInterface` · `Throwable`
### Method Summary
SerializerFactory constructor.
Returns the available adapters
### Methods
__construct()
```php
public function __construct( array $services = [] );
```
SerializerFactory constructor.
newInstance()
```php
public function newInstance( string $name ): SerializerInterface;
```
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
## Storage\Serializer\AbstractSerializer
Abstract
@property mixed $data
@property bool $isSuccess
- **`Phalcon\Storage\Serializer\AbstractSerializer`** - implements [`Phalcon\Storage\Serializer\SerializerInterface`](#storageserializerserializerinterface)
- [`Phalcon\Storage\Serializer\Base64`](#storageserializerbase64)
- [`Phalcon\Storage\Serializer\Igbinary`](#storageserializerigbinary)
- [`Phalcon\Storage\Serializer\Json`](#storageserializerjson)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- [`Phalcon\Storage\Serializer\Php`](#storageserializerphp)
`Phalcon\Contracts\Storage\StorageTypes`
### Method Summary
AbstractSerializer constructor.
Serialize data
Unserialize data
Returns `true` if the serialize/unserialize operation was successful;
If this returns true, then the data is returned as is
### Properties
### Methods
__construct()
```php
public function __construct( mixed $data = null );
```
AbstractSerializer constructor.
__serialize()
```php
public function __serialize(): array;
```
Serialize data
__unserialize()
```php
public function __unserialize( array $data ): void;
```
Unserialize data
getData()
```php
public function getData(): mixed;
```
isSuccess()
```php
public function isSuccess(): bool;
```
Returns `true` if the serialize/unserialize operation was successful;
`false` otherwise
setData()
```php
public function setData( mixed $data ): void;
```
isSerializable()
```php
protected function isSerializable( mixed $data ): bool;
```
If this returns true, then the data is returned as is
## Storage\Serializer\Base64
Class
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\Base64`**
`Phalcon\Storage\Serializer\Exceptions\InvalidSerializationInput` · `Phalcon\Storage\Serializer\Exceptions\InvalidUnserializationInput` · `Phalcon\Traits\Php\Base64Trait`
### Method Summary
Serializes data
Unserializes data
### Methods
serialize()
```php
public function serialize(): string;
```
Serializes data
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
## Storage\Serializer\Exceptions\InvalidSerializationInput
Class
- `\InvalidArgumentException`
- **`Phalcon\Storage\Serializer\Exceptions\InvalidSerializationInput`**
`InvalidArgumentException`
### Method Summary
### Methods
```php
public function __construct();
```
## Storage\Serializer\Exceptions\InvalidUnserializationInput
Class
- `\InvalidArgumentException`
- **`Phalcon\Storage\Serializer\Exceptions\InvalidUnserializationInput`**
`InvalidArgumentException`
### Method Summary
### Methods
```php
public function __construct();
```
## Storage\Serializer\Igbinary
Class
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\Igbinary`**
- [`Phalcon\Storage\Serializer\Msgpack`](#storageserializermsgpack)
`Phalcon\Traits\Php\IgbinaryTrait`
### Method Summary
Serializes data
Unserializes data
Serialize
Unserialize
### Methods
serialize()
```php
public function serialize(): mixed;
```
Serializes data
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
doSerialize()
```php
protected function doSerialize( mixed $value ): string|null;
```
Serialize
doUnserialize()
```php
protected function doUnserialize( mixed $value );
```
Unserialize
## Storage\Serializer\Json
Class
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\Json`**
`Phalcon\Support\Helper\Json\Decode` · `Phalcon\Support\Helper\Json\Encode`
### Method Summary
AbstractSerializer constructor.
Serializes data
Unserializes data
### Methods
__construct()
```php
public function __construct( mixed $data = null );
```
AbstractSerializer constructor.
serialize()
```php
public function serialize(): mixed;
```
Serializes data
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
## Storage\Serializer\MemcachedIgbinary
Class
Serializer using the built-in Memcached 'igbinary' serializer
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- **`Phalcon\Storage\Serializer\MemcachedIgbinary`**
## Storage\Serializer\MemcachedJson
Class
Serializer using the built-in Memcached 'json' serializer
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- **`Phalcon\Storage\Serializer\MemcachedJson`**
## Storage\Serializer\MemcachedPhp
Class
Serializer using the built-in Memcached 'php' serializer
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- **`Phalcon\Storage\Serializer\MemcachedPhp`**
## Storage\Serializer\Msgpack
Class
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\Igbinary`](#storageserializerigbinary)
- **`Phalcon\Storage\Serializer\Msgpack`**
`Phalcon\Traits\Php\MsgpackTrait`
### Method Summary
Serializes data
### Methods
doSerialize()
```php
protected function doSerialize( mixed $value ): string;
```
Serializes data
doUnserialize()
```php
protected function doUnserialize( mixed $value );
```
## Storage\Serializer\None
Class
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\None`**
- [`Phalcon\Storage\Serializer\MemcachedIgbinary`](#storageserializermemcachedigbinary)
- [`Phalcon\Storage\Serializer\MemcachedJson`](#storageserializermemcachedjson)
- [`Phalcon\Storage\Serializer\MemcachedPhp`](#storageserializermemcachedphp)
- [`Phalcon\Storage\Serializer\RedisIgbinary`](#storageserializerredisigbinary)
- [`Phalcon\Storage\Serializer\RedisJson`](#storageserializerredisjson)
- [`Phalcon\Storage\Serializer\RedisMsgpack`](#storageserializerredismsgpack)
- [`Phalcon\Storage\Serializer\RedisNone`](#storageserializerredisnone)
- [`Phalcon\Storage\Serializer\RedisPhp`](#storageserializerredisphp)
### Method Summary
Serializes data
Unserializes data
### Methods
serialize()
```php
public function serialize(): mixed;
```
Serializes data
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
## Storage\Serializer\Php
Class
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\Php`**
`Phalcon\Storage\Serializer\Exceptions\InvalidUnserializationInput` · `Phalcon\Traits\Php\SerializeTrait`
### Method Summary
Serializes data
Restricts the classes that unserialize() may instantiate (see the
Unserializes data
### Properties
Classes that unserialize() may instantiate: true (any class, the PHP
default), false (none) or a list of class names. Stored bytes that
try to build another class are rejected on read.
### Methods
getAllowedClasses()
```php
public function getAllowedClasses(): mixed;
```
serialize()
```php
public function serialize(): mixed;
```
Serializes data
setAllowedClasses()
```php
public function setAllowedClasses( mixed $allowedClasses ): static;
```
Restricts the classes that unserialize() may instantiate (see the
"allowed_classes" option of unserialize()).
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
## Storage\Serializer\RedisIgbinary
Class
Serializer using the built-in Redis 'igbinary' serializer
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- **`Phalcon\Storage\Serializer\RedisIgbinary`**
## Storage\Serializer\RedisJson
Class
Serializer using the built-in Redis 'json' serializer
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- **`Phalcon\Storage\Serializer\RedisJson`**
## Storage\Serializer\RedisMsgpack
Class
Serializer using the built-in Redis 'msgpack' serializer
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- **`Phalcon\Storage\Serializer\RedisMsgpack`**
## Storage\Serializer\RedisNone
Class
Serializer using the built-in Redis 'none' serializer
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- **`Phalcon\Storage\Serializer\RedisNone`**
## Storage\Serializer\RedisPhp
Class
Serializer using the built-in Redis 'php' serializer
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\None`](#storageserializernone)
- **`Phalcon\Storage\Serializer\RedisPhp`**
## Storage\Serializer\SerializerInterface
Interface
- **`Phalcon\Storage\Serializer\SerializerInterface`**
### Method Summary
Serializes data
Unserializes data
### Methods
getData()
```php
public function getData(): mixed;
```
serialize()
```php
public function serialize(): mixed;
```
Serializes data
setData()
```php
public function setData( mixed $data ): void;
```
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
Source: https://docs.phalcon.io/5.20/api/phalcon_storage/index.mdx