---
title: "Phalcon Cache"
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 Cache
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Cache\AbstractCache
Abstract
This component offers caching capabilities for your application.
Event layering: cache operations can emit `cache:*` events from two layers.
This facade fires `cache:before*`/`cache:after*` around each operation, and
the underlying `Storage` adapter (whose `eventType` is `"cache"`) also fires
`cache:before*`/`cache:after*` for the same operation. If an events manager
is wired into both the facade and the adapter, a single call emits the event
twice (once from each object). Wire the manager into one layer only; the
facade is the supported source for cache-level events (it also emits the
multi-key `cache:*Multiple` events).
- **`Phalcon\Cache\AbstractCache`** - implements [`Phalcon\Cache\CacheInterface`](#cachecacheinterface), [`Phalcon\Events\EventsAwareInterface`](/5.20/api/phalcon_events/#eventseventsawareinterface)
- [`Phalcon\Cache\Cache`](#cachecache)
`DateInterval` · `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Cache\Adapter\Redis` · `Phalcon\Cache\Exception\InvalidArgumentException` · `Phalcon\Events\EventsAwareInterface` · `Phalcon\Events\ManagerInterface` · `Phalcon\Events\Traits\EventsAwareTrait` · `Throwable` · `Traversable`
### Method Summary
Constructor.
Fetches a value from the cache.
Returns the current adapter
Persists data in the cache, uniquely referenced by a key with an
Checks the key. If it contains invalid characters an exception is thrown
Checks the key. If it contains invalid characters an exception is thrown
Wipes clean the entire cache's keys.
Delete an item from the cache by its unique key.
Deletes multiple cache items in a single operation.
Fetches a value from the cache.
Obtains multiple cache items by their unique keys.
Determines whether an item is present in the cache.
Persists data in the cache, uniquely referenced by a key with an optional
Persists a set of key => value pairs in the cache, with an optional TTL.
Returns the exception class that will be used for exceptions thrown
### Properties
### Methods
__construct()
```php
public function __construct( AdapterInterface $adapter );
```
Constructor.
get()
```php
abstract public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
Fetches a value from the cache.
getAdapter()
```php
public function getAdapter(): AdapterInterface;
```
Returns the current adapter
set()
```php
abstract public function set(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Persists data in the cache, uniquely referenced by a key with an
optional expiration TTL time.
checkKey()
```php
protected function checkKey( string $key ): void;
```
Checks the key. If it contains invalid characters an exception is thrown
checkKeys()
```php
protected function checkKeys( mixed $keys ): void;
```
Checks the key. If it contains invalid characters an exception is thrown
doClear()
```php
protected function doClear(): bool;
```
Wipes clean the entire cache's keys.
doDelete()
```php
protected function doDelete( string $key ): bool;
```
Delete an item from the cache by its unique key.
doDeleteMultiple()
```php
protected function doDeleteMultiple( mixed $keys ): bool;
```
Deletes multiple cache items in a single operation.
doGet()
```php
protected function doGet(
string $key,
mixed $defaultValue = null
): mixed;
```
Fetches a value from the cache.
doGetMultiple()
```php
protected function doGetMultiple(
mixed $keys,
mixed $defaultValue = null
): array;
```
Obtains multiple cache items by their unique keys.
doHas()
```php
protected function doHas( string $key ): bool;
```
Determines whether an item is present in the cache.
doSet()
```php
protected function doSet(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Persists data in the cache, uniquely referenced by a key with an optional
expiration TTL time.
doSetMultiple()
```php
protected function doSetMultiple(
mixed $values,
mixed $ttl = null
): bool;
```
Persists a set of key => value pairs in the cache, with an optional TTL.
getExceptionClass()
```php
abstract protected function getExceptionClass(): string;
```
Returns the exception class that will be used for exceptions thrown
## Cache\AdapterFactory
Class
Factory to create Cache adapters
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.20/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Cache\AdapterFactory`**
`Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Cache\Adapter\Apcu` · `Phalcon\Cache\Adapter\Libmemcached` · `Phalcon\Cache\Adapter\Memory` · `Phalcon\Cache\Adapter\Redis` · `Phalcon\Cache\Adapter\RedisCluster` · `Phalcon\Cache\Adapter\Stream` · `Phalcon\Cache\Adapter\Weak` · `Phalcon\Cache\Exception\Exception` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Factory\AbstractFactory` · `Phalcon\Storage\SerializerFactory` · `Throwable`
### Method Summary
AdapterFactory constructor.
Create a new instance of the adapter
Returns the available adapters
### Properties
### Methods
__construct()
```php
public function __construct(
SerializerFactory $serializerFactory,
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
## Cache\Adapter\AdapterInterface
Interface
Interface for Phalcon\Cache adapters
- [`Phalcon\Storage\Adapter\AdapterInterface`](/5.20/api/phalcon_storage/#storageadapteradapterinterface)
- **`Phalcon\Cache\Adapter\AdapterInterface`**
`Phalcon\Storage\Adapter\AdapterInterface`
## Cache\Adapter\Apcu
Class
Apcu adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.20/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Apcu`](/5.20/api/phalcon_storage/#storageadapterapcu)
- **`Phalcon\Cache\Adapter\Apcu`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
`Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Apcu`
### Properties
EventType prefix.
## Cache\Adapter\Libmemcached
Class
Libmemcached adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.20/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Libmemcached`](/5.20/api/phalcon_storage/#storageadapterlibmemcached)
- **`Phalcon\Cache\Adapter\Libmemcached`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
`Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Libmemcached`
### Properties
EventType prefix.
## Cache\Adapter\Memory
Class
Memory adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.20/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Memory`](/5.20/api/phalcon_storage/#storageadaptermemory)
- **`Phalcon\Cache\Adapter\Memory`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
`Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Memory`
### Properties
EventType prefix.
## Cache\Adapter\Redis
Class
Redis adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.20/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Redis`](/5.20/api/phalcon_storage/#storageadapterredis)
- **`Phalcon\Cache\Adapter\Redis`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
`Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Redis`
### Properties
EventType prefix.
## Cache\Adapter\RedisCluster
Class
RedisCluster adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.20/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Redis`](/5.20/api/phalcon_storage/#storageadapterredis)
- [`Phalcon\Storage\Adapter\RedisCluster`](/5.20/api/phalcon_storage/#storageadapterrediscluster)
- **`Phalcon\Cache\Adapter\RedisCluster`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
`Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\RedisCluster`
### Properties
EventType prefix.
## Cache\Adapter\Stream
Class
Stream adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.20/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Stream`](/5.20/api/phalcon_storage/#storageadapterstream)
- **`Phalcon\Cache\Adapter\Stream`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
`Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Stream`
### Properties
EventType prefix.
## Cache\Adapter\Weak
Class
WeakCache implementation based on WeakReference
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.20/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Weak`](/5.20/api/phalcon_storage/#storageadapterweak)
- **`Phalcon\Cache\Adapter\Weak`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
`Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Weak`
### Properties
EventType prefix.
## Cache\Cache
Class
This component offers caching capabilities for your application.
- [`Phalcon\Cache\AbstractCache`](#cacheabstractcache)
- **`Phalcon\Cache\Cache`**
`DateInterval` · `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Cache\Exception\InvalidArgumentException` · `Throwable`
### Method Summary
Wipes clean the entire cache's keys.
Delete an item from the cache by its unique key.
Deletes multiple cache items in a single operation.
Fetches a value from the cache.
Obtains multiple cache items by their unique keys.
Determines whether an item is present in the cache.
Persists data in the cache, uniquely referenced by a key with an optional
Persists a set of key => value pairs in the cache, with an optional TTL.
Returns the exception class that will be used for exceptions thrown
### Methods
clear()
```php
public function clear(): bool;
```
Wipes clean the entire cache's keys.
delete()
```php
public function delete( string $key ): bool;
```
Delete an item from the cache by its unique key.
deleteMultiple()
```php
public function deleteMultiple( mixed $keys ): bool;
```
Deletes multiple cache items in a single operation.
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
Fetches a value from the cache.
getMultiple()
```php
public function getMultiple(
mixed $keys,
mixed $defaultValue = null
);
```
Obtains multiple cache items by their unique keys.
has()
```php
public function has( string $key ): bool;
```
Determines whether an item is present in the cache.
set()
```php
public function set(
string $key,
mixed $value,
mixed $ttl = null
): bool;
```
Persists data in the cache, uniquely referenced by a key with an optional
expiration TTL time.
setMultiple()
```php
public function setMultiple(
mixed $values,
mixed $ttl = null
): bool;
```
Persists a set of key => value pairs in the cache, with an optional TTL.
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
Returns the exception class that will be used for exceptions thrown
## Cache\CacheFactory
Class
Creates a new Cache class
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- **`Phalcon\Cache\CacheFactory`**
`Phalcon\Cache\Exception\Exception` · `Phalcon\Config\ConfigInterface` · `Phalcon\Contracts\Storage\StorageTypes` · `Phalcon\Factory\AbstractConfigFactory` · `Throwable`
### Method Summary
Constructor
Factory to create an instance from a Config object
Constructs a new Cache instance.
Returns the exception class for the factory
### Properties
### Methods
__construct()
```php
public function __construct( AdapterFactory $factory );
```
Constructor
load()
```php
public function load( mixed $config ): CacheInterface;
```
Factory to create an instance from a Config object
newInstance()
```php
public function newInstance(
string $name,
array $options = []
): CacheInterface;
```
Constructs a new Cache instance.
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
Returns the exception class for the factory
## Cache\CacheInterface
Interface
Interface for Phalcon\Cache\Cache
- [`Phalcon\Contracts\Cache\Cache`](/5.20/api/phalcon_contracts/#contractscachecache)
- **`Phalcon\Cache\CacheInterface`**
`Phalcon\Contracts\Cache\Cache`
## Cache\Exception\Exception
Class
Exceptions thrown in Phalcon\Cache will use this class
- `\Exception`
- **`Phalcon\Cache\Exception\Exception`**
## Cache\Exception\InvalidArgumentException
Class
Exceptions thrown in Phalcon\Cache for invalid arguments will use this class
- `\Exception`
- **`Phalcon\Cache\Exception\InvalidArgumentException`**
Source: https://docs.phalcon.io/5.20/api/phalcon_cache/index.mdx