--- title: "Phalcon Cache" version: "5.17" --- > 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 Source on GitHub 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.17/api/phalcon_events/#eventseventsawareinterface) - [`Phalcon\Cache\Cache`](#cachecache)
__Uses__ `DateInterval` · `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Cache\Adapter\Redis` · `Phalcon\Cache\Exception\InvalidArgumentException` · `Phalcon\Events\EventsAwareInterface` · `Phalcon\Events\ManagerInterface` · `Traversable` ### Method Summary
public __construct( AdapterInterface $adapter ) Constructor. public get(string $key,mixed $defaultValue = null) Fetches a value from the cache. public AdapterInterface getAdapter() Returns the current adapter public ManagerInterface|null getEventsManager() Get the event manager public bool set(string $key,mixed $value,mixed $ttl = null) Persists data in the cache, uniquely referenced by a key with an public void setEventsManager( ManagerInterface $eventsManager ) Sets the event manager protected void checkKey( string $key ) Checks the key. If it contains invalid characters an exception is thrown protected void checkKeys( mixed $keys ) Checks the key. If it contains invalid characters an exception is thrown protected bool doClear() Wipes clean the entire cache's keys. protected bool doDelete( string $key ) Delete an item from the cache by its unique key. protected bool doDeleteMultiple( mixed $keys ) Deletes multiple cache items in a single operation. protected mixed doGet(string $key,mixed $defaultValue = null) Fetches a value from the cache. protected array doGetMultiple(mixed $keys,mixed $defaultValue = null) Obtains multiple cache items by their unique keys. protected bool doHas( string $key ) Determines whether an item is present in the cache. protected bool doSet(string $key,mixed $value,mixed $ttl = null) Persists data in the cache, uniquely referenced by a key with an optional protected bool doSetMultiple(mixed $values,mixed $ttl = null) Persists a set of key => value pairs in the cache, with an optional TTL. protected void fire(string $eventName,mixed $keys) Trigger an event for the eventsManager. protected string getExceptionClass() Returns the exception class that will be used for exceptions thrown
### Properties
protected AdapterInterface $adapter The adapter
protected ManagerInterface|null $eventsManager = null Event Manager
### Methods
Public · 6

__construct()

```php public function __construct( AdapterInterface $adapter ); ``` Constructor.

get()

```php abstract public function get( string $key, mixed $defaultValue = null ); ``` Fetches a value from the cache.

getAdapter()

```php public function getAdapter(): AdapterInterface; ``` Returns the current adapter

getEventsManager()

```php public function getEventsManager(): ManagerInterface|null; ``` Get the event manager

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.

setEventsManager()

```php public function setEventsManager( ManagerInterface $eventsManager ): void; ``` Sets the event manager
Protected · 12

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.

fire()

```php protected function fire( string $eventName, mixed $keys ): void; ``` Trigger an event for the eventsManager.

getExceptionClass()

```php abstract protected function getExceptionClass(): string; ``` Returns the exception class that will be used for exceptions thrown ## Cache\AdapterFactory Class Source on GitHub Factory to create Cache adapters
- [`Phalcon\Factory\AbstractConfigFactory`](/5.17/api/phalcon_factory/#factoryabstractconfigfactory) - [`Phalcon\Factory\AbstractFactory`](/5.17/api/phalcon_factory/#factoryabstractfactory) - **`Phalcon\Cache\AdapterFactory`**
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Cache\Exception\Exception` · `Phalcon\Factory\AbstractFactory` · `Phalcon\Storage\SerializerFactory` ### Method Summary
public __construct(SerializerFactory $factory,array $services = []) AdapterFactory constructor. public AdapterInterface newInstance(string $name,array $options = []) Create a new instance of the adapter protected string getExceptionClass() protected array getServices() Returns the available adapters
### Properties
protected SerializerFactory $serializerFactory
### 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 ## Cache\Adapter\AdapterInterface Interface Source on GitHub Interface for Phalcon\Cache adapters
- [`Phalcon\Storage\Adapter\AdapterInterface`](/5.17/api/phalcon_storage/#storageadapteradapterinterface) - **`Phalcon\Cache\Adapter\AdapterInterface`**
__Uses__ `Phalcon\Storage\Adapter\AdapterInterface` ## Cache\Adapter\Apcu Class Source on GitHub Apcu adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.17/api/phalcon_storage/#storageadapterabstractadapter) - [`Phalcon\Storage\Adapter\Apcu`](/5.17/api/phalcon_storage/#storageadapterapcu) - **`Phalcon\Cache\Adapter\Apcu`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Apcu` ### Properties
protected string $eventType = "cache"
## Cache\Adapter\Libmemcached Class Source on GitHub Libmemcached adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.17/api/phalcon_storage/#storageadapterabstractadapter) - [`Phalcon\Storage\Adapter\Libmemcached`](/5.17/api/phalcon_storage/#storageadapterlibmemcached) - **`Phalcon\Cache\Adapter\Libmemcached`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Libmemcached` ### Properties
protected string $eventType = "cache"
## Cache\Adapter\Memory Class Source on GitHub Memory adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.17/api/phalcon_storage/#storageadapterabstractadapter) - [`Phalcon\Storage\Adapter\Memory`](/5.17/api/phalcon_storage/#storageadaptermemory) - **`Phalcon\Cache\Adapter\Memory`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Memory` ### Properties
protected string $eventType = "cache"
## Cache\Adapter\Redis Class Source on GitHub Redis adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.17/api/phalcon_storage/#storageadapterabstractadapter) - [`Phalcon\Storage\Adapter\Redis`](/5.17/api/phalcon_storage/#storageadapterredis) - **`Phalcon\Cache\Adapter\Redis`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Redis` ### Properties
protected string $eventType = "cache"
## Cache\Adapter\RedisCluster Class Source on GitHub RedisCluster adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.17/api/phalcon_storage/#storageadapterabstractadapter) - [`Phalcon\Storage\Adapter\Redis`](/5.17/api/phalcon_storage/#storageadapterredis) - [`Phalcon\Storage\Adapter\RedisCluster`](/5.17/api/phalcon_storage/#storageadapterrediscluster) - **`Phalcon\Cache\Adapter\RedisCluster`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\RedisCluster` ### Properties
protected string $eventType = "cache"
## Cache\Adapter\Stream Class Source on GitHub Stream adapter
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.17/api/phalcon_storage/#storageadapterabstractadapter) - [`Phalcon\Storage\Adapter\Stream`](/5.17/api/phalcon_storage/#storageadapterstream) - **`Phalcon\Cache\Adapter\Stream`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Stream` ### Properties
protected string $eventType = "cache"
## Cache\Adapter\Weak Class Source on GitHub WeakCache implementation based on WeakReference
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.17/api/phalcon_storage/#storageadapterabstractadapter) - [`Phalcon\Storage\Adapter\Weak`](/5.17/api/phalcon_storage/#storageadapterweak) - **`Phalcon\Cache\Adapter\Weak`** - implements [`Phalcon\Cache\Adapter\AdapterInterface`](#cacheadapteradapterinterface)
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Storage\Adapter\Weak` ### Properties
protected string $eventType = "cache"
## Cache\Cache Class Source on GitHub This component offers caching capabilities for your application.
- [`Phalcon\Cache\AbstractCache`](#cacheabstractcache) - **`Phalcon\Cache\Cache`**
__Uses__ `DateInterval` · `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Cache\Exception\InvalidArgumentException` ### Method Summary
public bool clear() Wipes clean the entire cache's keys. public bool delete( string $key ) Delete an item from the cache by its unique key. public bool deleteMultiple( mixed $keys ) Deletes multiple cache items in a single operation. public get(string $key,mixed $defaultValue = null) Fetches a value from the cache. public getMultiple(mixed $keys,mixed $defaultValue = null) Obtains multiple cache items by their unique keys. public bool has( string $key ) Determines whether an item is present in the cache. public bool set(string $key,mixed $value,mixed $ttl = null) Persists data in the cache, uniquely referenced by a key with an optional public bool setMultiple(mixed $values,mixed $ttl = null) Persists a set of key => value pairs in the cache, with an optional TTL. protected string getExceptionClass() Returns the exception class that will be used for exceptions thrown
### Methods
Public · 8

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 ); ``` 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.
Protected · 1

getExceptionClass()

```php protected function getExceptionClass(): string; ``` Returns the exception class that will be used for exceptions thrown ## Cache\CacheFactory Class Source on GitHub Creates a new Cache class
- [`Phalcon\Factory\AbstractConfigFactory`](/5.17/api/phalcon_factory/#factoryabstractconfigfactory) - **`Phalcon\Cache\CacheFactory`**
__Uses__ `Phalcon\Cache\Adapter\AdapterInterface` · `Phalcon\Cache\Cache` · `Phalcon\Cache\Exception\Exception` · `Phalcon\Config\ConfigInterface` · `Phalcon\Factory\AbstractConfigFactory` ### Method Summary
public __construct( AdapterFactory $factory ) Constructor public CacheInterface load( mixed $config ) Factory to create an instance from a Config object public CacheInterface newInstance(string $name,array $options = []) Constructs a new Cache instance. protected string getExceptionClass()
### Properties
protected AdapterFactory $adapterFactory
### Methods
Public · 3

__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.
Protected · 1

getExceptionClass()

```php protected function getExceptionClass(): string; ``` ## Cache\CacheInterface Interface Source on GitHub Interface for Phalcon\Cache\Cache
- [`Phalcon\Contracts\Cache\Cache`](/5.17/api/phalcon_contracts/#contractscachecache) - **`Phalcon\Cache\CacheInterface`**
__Uses__ `Phalcon\Contracts\Cache\Cache` ## Cache\Exception\Exception Class Source on GitHub Exceptions thrown in Phalcon\Cache will use this class
- `\Exception` - **`Phalcon\Cache\Exception\Exception`**
## Cache\Exception\InvalidArgumentException Class Source on GitHub Exceptions thrown in Phalcon\Cache will use this class
- `\Exception` - **`Phalcon\Cache\Exception\InvalidArgumentException`**
Source: https://docs.phalcon.io/5.17/api/phalcon_cache/index.mdx