---
title: "Phalcon Storage"
version: "5.14"
---
> 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
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- [`Phalcon\Factory\AbstractConfigFactory`](/5.14/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.14/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Storage\AdapterFactory`**
__Uses__ `Phalcon\Factory\AbstractFactory` · `Phalcon\Storage\Adapter\AdapterInterface`
### Method Summary
### Methods
Public · 2
__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
Protected · 2
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
## Storage\Adapter\AbstractAdapter
Abstract
Source on GitHub
Class AbstractAdapter
@package Phalcon\Storage\Adapter
@property mixed $adapter
@property string $defaultSerializer
@property int $lifetime
@property array $options
@property string $prefix
@property SerializerInterface $serializer
@property SerializerFactory $serializerFactory
- **`Phalcon\Storage\Adapter\AbstractAdapter`** — implements [`Phalcon\Storage\Adapter\AdapterInterface`](#storageadapteradapterinterface), [`Phalcon\Events\EventsAwareInterface`](/5.14/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)
__Uses__ `DateInterval` · `DateTime` · `Exception` · `Phalcon\Events\EventsAwareInterface` · `Phalcon\Events\ManagerInterface` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Storage\Serializer\SerializerInterface` · `Phalcon\Support\Exception`
### Method Summary
public
bool
clear()
Flushes/clears the cache
public
int|bool
decrement(string $key,int $value = 1)
Decrements a stored number
public
bool
delete( string $key )
Deletes data from the adapter
public
bool
deleteMultiple( array $keys )
Deletes data from the adapter
public
mixed
get(string $key,mixed $defaultValue = null)
Reads data from the adapter
public
mixed
getAdapter()
Returns the adapter - connects to the storage if not connected
public
string
getDefaultSerializer()
Name of the default serializer class
public
ManagerInterface|null
getEventsManager()
Get the event manager
public
array
getKeys( string $prefix = "" )
Returns all the keys stored
public
int
getLifetime()
Returns the lifetime
public
string
getPrefix()
Returns the prefix
public
SerializerInterface
getSerializer()
Get the serializer
public
bool
has( string $key )
Checks if an element exists in the cache
public
int|bool
increment(string $key,int $value = 1)
Increments a stored number
public
bool
set(string $key,mixed $value,mixed $ttl = null)
Stores data in the adapter. If the TTL is null (default) or not defined
public
void
setDefaultSerializer( string $serializer )
public
void
setEventsManager( ManagerInterface $eventsManager )
Sets the event manager
protected
__construct(SerializerFactory $factory,array $options = [])
AbstractAdapter constructor.
protected
int|bool
doDecrement(string $key,int $value = 1)
Decrements a stored number
protected
bool
doDelete( string $key )
Deletes data from the adapter
protected
bool
doDeleteMultiple( array $keys )
Deletes multiple keys from the adapter
protected
mixed
doGet(string $key,mixed $defaultValue = null)
protected
mixed
doGetData( string $key )
protected
bool
doHas( string $key )
Checks if an element exists in the cache
protected
int|bool
doIncrement(string $key,int $value = 1)
Increments a stored number
protected
bool
doSet(string $key,mixed $value,mixed $ttl = null)
Stores data in the adapter. If the TTL is null (default) or not defined
protected
void
fire(string $eventName,mixed $keys)
Trigger an event for the eventsManager.
protected
mixed
getArrVal(array $collection,mixed $index,mixed $defaultValue = null,string $cast = null)
@todo Remove this when we get traits
protected
array
getFilteredKeys(mixed $keys,string $prefix)
Filters the keys array based on global and passed prefix
protected
string
getPrefixedKey( mixed $key )
Returns the key requested, prefixed
protected
mixed
getSerializedData( mixed $content )
Returns serialized data
protected
int
getTtl( mixed $ttl )
Calculates the TTL for a cache item
protected
mixed
getUnserializedData(mixed $content,mixed $defaultValue = null)
Returns unserialized data
protected
void
initSerializer()
Initializes the serializer
### Properties
protected
mixed
$adapter
protected
string
$defaultSerializer = "php"
Name of the default serializer class
protected
string
$eventType = "storage"
EventType prefix.
protected
ManagerInterface|null
$eventsManager = null
Event Manager
protected
int
$lifetime = 3600
Name of the default TTL (time to live)
protected
array
$options = []
protected
string
$prefix = "ph-memo-"
protected
SerializerInterface|null
$serializer
Serializer
protected
SerializerFactory
$serializerFactory
Serializer Factory
### Methods
Public · 17
clear()
```php
abstract public function clear(): bool;
```
Flushes/clears the cache
decrement()
```php
public function decrement(
string $key,
int $value = 1
): int|bool;
```
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 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
getEventsManager()
```php
public function getEventsManager(): ManagerInterface|null;
```
Get the event manager
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;
```
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
): int|bool;
```
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;
```
setEventsManager()
```php
public function setEventsManager( ManagerInterface $eventsManager ): void;
```
Sets the event manager
Protected · 17
__construct()
```php
protected function __construct(
SerializerFactory $factory,
array $options = []
);
```
AbstractAdapter constructor.
doDecrement()
```php
abstract protected function doDecrement(
string $key,
int $value = 1
): int|bool;
```
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 keys 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
): int|bool;
```
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.
fire()
```php
protected function fire(
string $eventName,
mixed $keys
): void;
```
Trigger an event for the eventsManager.
getArrVal()
```php
protected function getArrVal(
array $collection,
mixed $index,
mixed $defaultValue = null,
string $cast = null
): mixed;
```
@todo Remove this when we get traits
getFilteredKeys()
```php
protected function getFilteredKeys(
mixed $keys,
string $prefix
): array;
```
Filters the keys array based on global and passed prefix
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
Source on GitHub
Interface for Phalcon\Logger adapters
- **`Phalcon\Storage\Adapter\AdapterInterface`**
- [`Phalcon\Cache\Adapter\AdapterInterface`](/5.14/api/phalcon_cache/#cacheadapteradapterinterface)
__Uses__ `Phalcon\Storage\Serializer\SerializerInterface`
### Method Summary
### Methods
Public · 12
clear()
```php
public function clear(): bool;
```
Flushes/clears the cache
decrement()
```php
public function decrement(
string $key,
int $value = 1
): int|bool;
```
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
): int|bool;
```
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 $value
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
## Storage\Adapter\Apcu
Class
Source on GitHub
Apcu adapter
@property array $options
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Apcu`**
- [`Phalcon\Cache\Adapter\Apcu`](/5.14/api/phalcon_cache/#cacheadapterapcu)
__Uses__ `APCUIterator` · `DateInterval` · `Exception` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Support\Exception`
### Method Summary
public
__construct(SerializerFactory $factory,array $options = [])
Apcu constructor.
public
bool
clear()
Flushes/clears the cache
public
array
getKeys( string $prefix = "" )
Stores data in the adapter
public
bool
setForever(string $key,mixed $value)
Stores data in the adapter forever. The key needs to manually deleted
protected
int|bool
doDecrement(string $key,int $value = 1)
Decrements a stored number
protected
bool
doDelete( string $key )
Deletes data from the adapter
protected
bool
doDeleteMultiple( array $keys )
Deletes multiple keys from APCu in a single call
protected
doGetData( string $key )
protected
bool
doHas( string $key )
Checks if an element exists in the cache
protected
int|bool
doIncrement(string $key,int $value = 1)
Increments a stored number
protected
bool
doSet(string $key,mixed $value,mixed $ttl = null)
Stores data in the adapter. If the TTL is null (default) or not defined
protected
bool|int
phpApcuDec(mixed $key,int $step = 1)
@todo Remove the below once we get traits
protected
bool|array
phpApcuDelete( mixed $key )
protected
bool|array
phpApcuExists( mixed $key )
protected
mixed
phpApcuFetch( mixed $key )
protected
bool|int
phpApcuInc(mixed $key,int $step = 1)
protected
APCUIterator|bool
phpApcuIterator( string $pattern )
protected
bool|array
phpApcuStore(mixed $key,mixed $payload,int $ttl = 0)
### Properties
protected
string
$prefix = "ph-apcu-"
### Methods
Public · 4
__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 $value
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
Protected · 14
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): int|bool;
```
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 );
```
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
): int|bool;
```
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.
phpApcuDec()
```php
protected function phpApcuDec(
mixed $key,
int $step = 1
): bool|int;
```
@todo Remove the below once we get traits
phpApcuDelete()
```php
protected function phpApcuDelete( mixed $key ): bool|array;
```
phpApcuExists()
```php
protected function phpApcuExists( mixed $key ): bool|array;
```
phpApcuFetch()
```php
protected function phpApcuFetch( mixed $key ): mixed;
```
phpApcuInc()
```php
protected function phpApcuInc(
mixed $key,
int $step = 1
): bool|int;
```
phpApcuIterator()
```php
protected function phpApcuIterator( string $pattern ): APCUIterator|bool;
```
phpApcuStore()
```php
protected function phpApcuStore(
mixed $key,
mixed $payload,
int $ttl = 0
): bool|array;
```
## Storage\Adapter\Libmemcached
Class
Source on GitHub
Libmemcached adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Libmemcached`**
- [`Phalcon\Cache\Adapter\Libmemcached`](/5.14/api/phalcon_cache/#cacheadapterlibmemcached)
__Uses__ `DateInterval` · `Exception` · `Phalcon\Storage\Exception` · `Phalcon\Storage\Exceptions\ConnectionFailed` · `Phalcon\Storage\Exceptions\InvalidConfiguration` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Support\Exception`
### Method Summary
### Properties
protected
string
$prefix = "ph-memc-"
### Methods
Public · 5
__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 $value
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
Protected · 6
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): int|bool;
```
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
): int|bool;
```
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
Source on GitHub
Memory adapter
@property array $data
@property array $options
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Memory`**
- [`Phalcon\Cache\Adapter\Memory`](/5.14/api/phalcon_cache/#cacheadaptermemory)
__Uses__ `DateInterval` · `Exception` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Support\Exception`
### Method Summary
### Properties
protected
array
$data = []
protected
int
$maxItems = 0
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
Public · 6
__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 $value
): 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.
Protected · 6
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): int|bool;
```
Decrements a stored number
doDelete()
```php
protected function doDelete( string $key ): bool;
```
Deletes data from the adapter
doGetData()
```php
protected function doGetData( string $key );
```
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
): int|bool;
```
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
Source on GitHub
Redis adapter
@property array $options
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Redis`**
- [`Phalcon\Cache\Adapter\Redis`](/5.14/api/phalcon_cache/#cacheadapterredis)
- [`Phalcon\Storage\Adapter\RedisCluster`](#storageadapterrediscluster)
__Uses__ `DateInterval` · `Exception` · `Phalcon\Storage\Exception` · `Phalcon\Storage\Exceptions\AuthenticationFailed` · `Phalcon\Storage\Exceptions\ConnectionFailed` · `Phalcon\Storage\Exceptions\DatabaseSelectionFailed` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Support\Exception`
### Method Summary
### Properties
protected
string
$prefix = "ph-reds-"
### Methods
Public · 5
__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)
getKeys()
```php
public function getKeys( string $prefix = "" ): array;
```
Stores data in the adapter
setForever()
```php
public function setForever(
string $key,
mixed $value
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
Protected · 6
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): int|bool;
```
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
): int|bool;
```
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\RedisCluster
Class
Source on GitHub
RedisCluster adapter
@property array $options
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Redis`](#storageadapterredis)
- **`Phalcon\Storage\Adapter\RedisCluster`**
- [`Phalcon\Cache\Adapter\RedisCluster`](/5.14/api/phalcon_cache/#cacheadapterrediscluster)
__Uses__ `Phalcon\Storage\Exceptions\ClusterConnectionFailed` · `Phalcon\Storage\SerializerFactory`
### Method Summary
### Properties
protected
string
$prefix = "ph-redc-"
### Methods
Public · 3
__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
Cluster server(s)
## Storage\Adapter\Stream
Class
Source on GitHub
Stream adapter
@property string $storageDir
@property array $options
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Stream`**
- [`Phalcon\Cache\Adapter\Stream`](/5.14/api/phalcon_cache/#cacheadapterstream)
__Uses__ `DateInterval` · `FilesystemIterator` · `Iterator` · `Phalcon\Storage\Exceptions\InvalidConfiguration` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Support\Exception` · `RecursiveDirectoryIterator` · `RecursiveIteratorIterator`
### Method Summary
public
__construct(SerializerFactory $factory,array $options = [])
Stream constructor.
public
bool
clear()
Flushes/clears the cache
public
array
getKeys( string $prefix = "" )
Stores data in the adapter
public
bool
setForever(string $key,mixed $value)
Stores data in the adapter forever. The key needs to manually deleted
protected
int|bool
doDecrement(string $key,int $value = 1)
Decrements a stored number
protected
bool
doDelete( string $key )
Deletes data from the adapter
protected
mixed
doGet(string $key,mixed $defaultValue = null)
Reads data from the adapter
protected
bool
doHas( string $key )
Checks if an element exists in the cache and is not expired
protected
int|bool
doIncrement(string $key,int $value = 1)
Increments a stored number
protected
bool
doSet(string $key,mixed $value,mixed $ttl = null)
Stores data in the adapter. If the TTL is null (default) or not defined
protected
bool
phpFileExists( string $filename )
@todo Remove the methods below when we get traits
protected
string|bool
phpFileGetContents( string $filename )
protected
int|bool
phpFilePutContents(string $filename,mixed $data,int $flags = 0,mixed $context = null)
protected
mixed
phpFopen(string $filename,string $mode)
protected
bool
phpUnlink( string $filename )
### Properties
protected
string
$prefix = "ph-strm"
protected
string
$storageDir = ""
### Methods
Public · 4
__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 $value
): bool;
```
Stores data in the adapter forever. The key needs to manually deleted
from the adapter.
Protected · 11
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): int|bool;
```
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
): int|bool;
```
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.
phpFileExists()
```php
protected function phpFileExists( string $filename ): bool;
```
@todo Remove the methods below when we get traits
phpFileGetContents()
```php
protected function phpFileGetContents( string $filename ): string|bool;
```
phpFilePutContents()
```php
protected function phpFilePutContents(
string $filename,
mixed $data,
int $flags = 0,
mixed $context = null
): int|bool;
```
phpFopen()
```php
protected function phpFopen(
string $filename,
string $mode
): mixed;
```
phpUnlink()
```php
protected function phpUnlink( string $filename ): bool;
```
## Storage\Adapter\Weak
Class
Source on GitHub
Weak Adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](#storageadapterabstractadapter)
- **`Phalcon\Storage\Adapter\Weak`**
- [`Phalcon\Cache\Adapter\Weak`](/5.14/api/phalcon_cache/#cacheadapterweak)
__Uses__ `DateInterval` · `Exception` · `Phalcon\Storage\SerializerFactory` · `Phalcon\Storage\Serializer\SerializerInterface` · `Phalcon\Support\Exception`
### Method Summary
public
__construct(SerializerFactory $factory,array $options = [])
Constructor, there are no options
public
bool
clear()
Flushes/clears the cache
public
array
getKeys( string $prefix = "" )
Stores data in the adapter
public
void
setDefaultSerializer( string $serializer )
will never set a serializer, WeakReference cannot be serialized
public
bool
setForever(string $key,mixed $value)
For compatiblity only, there is no Forever with WeakReference.
protected
int|bool
doDecrement(string $key,int $value = 1)
Decrements a stored number - not supported for WeakReference
protected
bool
doDelete( string $key )
Deletes data from the adapter
protected
mixed
doGet(string $key,mixed $defaultValue = null)
Reads data from the adapter
protected
bool
doHas( string $key )
Checks if an element exists in the cache
protected
int|bool
doIncrement(string $key,int $value = 1)
Increments a stored number - not supported for WeakReference
protected
bool
doSet(string $key,mixed $value,mixed $ttl = null)
Stores data in the adapter. If the TTL is null (default) or not defined
### Properties
protected
int|null
$fetching = null
protected
array
$options = []
protected
array
$weakList = []
### Methods
Public · 5
__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 $value
): bool;
```
For compatiblity only, there is no Forever with WeakReference.
Protected · 6
doDecrement()
```php
protected function doDecrement(
string $key,
int $value = 1
): int|bool;
```
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
): int|bool;
```
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
Source on GitHub
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
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\AuthenticationFailed`**
__Uses__ `Phalcon\Storage\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Storage\Exceptions\ClusterConnectionFailed
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\ClusterConnectionFailed`**
__Uses__ `Phalcon\Storage\Exception`
## Storage\Exceptions\ConnectionFailed
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\ConnectionFailed`**
__Uses__ `Phalcon\Storage\Exception`
## Storage\Exceptions\DatabaseSelectionFailed
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\DatabaseSelectionFailed`**
__Uses__ `Phalcon\Storage\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Storage\Exceptions\InvalidConfiguration
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\InvalidConfiguration`**
__Uses__ `Phalcon\Storage\Exception`
## Storage\Exceptions\StorageError
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Storage\Exception`](#storageexception)
- **`Phalcon\Storage\Exceptions\StorageError`**
__Uses__ `Phalcon\Storage\Exception`
## Storage\SerializerFactory
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- [`Phalcon\Factory\AbstractConfigFactory`](/5.14/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.14/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Storage\SerializerFactory`**
__Uses__ `Phalcon\Factory\AbstractFactory` · `Phalcon\Storage\Serializer\SerializerInterface`
### Method Summary
### Methods
Public · 2
__construct()
```php
public function __construct( array $services = [] );
```
SerializerFactory constructor.
newInstance()
```php
public function newInstance( string $name ): SerializerInterface;
```
Protected · 2
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
## Storage\Serializer\AbstractSerializer
Abstract
Source on GitHub
@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)
### Method Summary
### Properties
protected
mixed
$data = null
protected
bool
$isSuccess = true
### Methods
Public · 6
__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;
```
Protected · 1
isSerializable()
```php
protected function isSerializable( mixed $data ): bool;
```
If this returns true, then the data is returned as is
## Storage\Serializer\Base64
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\Base64`**
__Uses__ `Phalcon\Storage\Serializer\Exceptions\InvalidSerializationInput` · `Phalcon\Storage\Serializer\Exceptions\InvalidUnserializationInput`
### Method Summary
### Methods
Public · 2
serialize()
```php
public function serialize(): string;
```
Serializes data
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
@retrun void
Protected · 1
phpBase64Decode()
```php
protected function phpBase64Decode(
string $input,
bool $strict = false
);
```
Wrapper for base64_decode
## Storage\Serializer\Exceptions\InvalidSerializationInput
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\InvalidArgumentException`
- **`Phalcon\Storage\Serializer\Exceptions\InvalidSerializationInput`**
### Method Summary
### Methods
Public · 1
```php
public function __construct();
```
## Storage\Serializer\Exceptions\InvalidUnserializationInput
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\InvalidArgumentException`
- **`Phalcon\Storage\Serializer\Exceptions\InvalidUnserializationInput`**
### Method Summary
### Methods
Public · 1
```php
public function __construct();
```
## Storage\Serializer\Igbinary
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\Igbinary`**
- [`Phalcon\Storage\Serializer\Msgpack`](#storageserializermsgpack)
### Method Summary
### Methods
Public · 2
serialize()
```php
public function serialize(): mixed;
```
Serializes data
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
Protected · 3
doSerialize()
```php
protected function doSerialize( mixed $value ): string|null;
```
Serialize
doUnserialize()
```php
protected function doUnserialize( mixed $value );
```
Unserialize
phpIgbinarySerialize()
```php
protected function phpIgbinarySerialize( mixed $value ): string|null;
```
Wrapper for `igbinary_serialize`
## Storage\Serializer\Json
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\Json`**
__Uses__ `InvalidArgumentException` · `Phalcon\Support\Helper\Json\Decode` · `Phalcon\Support\Helper\Json\Encode`
### Method Summary
### Methods
Public · 3
__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
Source on GitHub
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
Source on GitHub
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
Source on GitHub
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
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- [`Phalcon\Storage\Serializer\Igbinary`](#storageserializerigbinary)
- **`Phalcon\Storage\Serializer\Msgpack`**
### Method Summary
### Methods
Protected · 2
doSerialize()
```php
protected function doSerialize( mixed $value ): string;
```
Serializes data
doUnserialize()
```php
protected function doUnserialize( mixed $value );
```
## Storage\Serializer\None
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- [`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
### Methods
Public · 2
serialize()
```php
public function serialize(): mixed;
```
Serializes data
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
@retrun void
## Storage\Serializer\Php
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- [`Phalcon\Storage\Serializer\AbstractSerializer`](#storageserializerabstractserializer)
- **`Phalcon\Storage\Serializer\Php`**
__Uses__ `Phalcon\Storage\Serializer\Exceptions\InvalidUnserializationInput`
### Method Summary
### Methods
Public · 2
serialize()
```php
public function serialize(): mixed;
```
Serializes data
unserialize()
```php
public function unserialize( mixed $data ): void;
```
Unserializes data
## Storage\Serializer\RedisIgbinary
Class
Source on GitHub
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
Source on GitHub
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
Source on GitHub
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
Source on GitHub
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
Source on GitHub
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
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- **`Phalcon\Storage\Serializer\SerializerInterface`**
### Method Summary
### Methods
Public · 4
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.14/api/phalcon_storage/index.mdx