PHPackages                             kuria/cache - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Caching](/categories/caching)
4. /
5. kuria/cache

ActiveLibrary[Caching](/categories/caching)

kuria/cache
===========

Caching library with driver abstraction

v6.0.0(4y ago)26911MITPHPPHP >=7.1.0

Since Dec 22Pushed 3y ago1 watchersCompare

[ Source](https://github.com/kuria/cache)[ Packagist](https://packagist.org/packages/kuria/cache)[ RSS](/packages/kuria-cache/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (7)Versions (11)Used By (1)

Cache
=====

[](#cache)

Caching library with driver abstraction.

[![https://travis-ci.com/kuria/cache.svg?branch=master](https://camo.githubusercontent.com/cef0fc2517db7d382ab91db4039cbf119e2d83a5955d79a460c51638c944ccd0/68747470733a2f2f7472617669732d63692e636f6d2f6b757269612f63616368652e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/kuria/cache)Contents

- [Features](#features)
- [Requirements](#requirements)
- [Built-in drivers](#built-in-drivers)
- [Usage](#usage)
    - [Creating a cache instance](#creating-a-cache-instance)
        - [Filesystem](#filesystem)
        - [APCu](#id1)
        - [Memcached](#id3)
        - [Redis](#redis)
        - [Memory](#memory)
        - [Black hole](#black-hole)
    - [Cache methods](#cache-methods)
        - [`setPrefix()` - configure cache prefix](#setprefix-configure-cache-prefix)
        - [`getNamespace()` - get a namespaced cache instance](#getnamespace-get-a-namespaced-cache-instance)
        - [`has()` - check if an entry exists](#has-check-if-an-entry-exists)
        - [`get()` - read a single entry](#get-read-a-single-entry)
        - [`getMultiple()` - read multiple entries](#getmultiple-read-multiple-entries)
        - [`listKeys()` - list keys in the cache](#listkeys-list-keys-in-the-cache)
        - [`getIterator()` - list keys and values in the cache](#getiterator-list-keys-and-values-in-the-cache)
        - [`add()` / `set()` - create a new entry](#add-set-create-a-new-entry)
        - [`addMultiple()` / `setMultiple()` - create multiple entries](#addmultiple-setmultiple-create-multiple-entries)
        - [`cached()` - cache the result of a callback](#cached-cache-the-result-of-a-callback)
        - [`delete()` - delete an entry](#delete-delete-an-entry)
        - [`deleteMultiple()` - delete multiple entries](#deletemultiple-delete-multiple-entries)
        - [`filter()` - delete entries using a prefix](#filter-delete-entries-using-a-prefix)
        - [`clear()` - delete all entries](#clear-delete-all-entries)
        - [`cleanup()` - clean-up the cache](#cleanup-clean-up-the-cache)
    - [Allowed value types](#allowed-value-types)
    - [Cache events](#cache-events)
        - [`CacheEvents::HIT`](#cacheevents-hit)
        - [`CacheEvents::MISS`](#cacheevents-miss)
        - [`CacheEvents::WRITE`](#cacheevents-write)
        - [`CacheEvents::DRIVER_EXCEPTION`](#cacheevents-driver-exception)
    - [PSR-6: Cache adapter](#psr-6-cache-adapter)
    - [PSR-16: Simple cache wrapper](#psr-16-simple-cache-wrapper)

[Features](#id6)
----------------

[](#features)

- entry operations: has, add, set, get, delete
- multiple-entry operations: getting, setting, adding, deleting
- listing, filtering, cleanup (requires driver support)
- TTL expiration
- key prefixing / namespacing
- stored and retrieved values can be manipulated via events
- [PSR-6](http://www.php-fig.org/psr/psr-6/) cache adapter
- [PSR-16](http://www.php-fig.org/psr/psr-16/) simple cache wrapper
- multiple built-in driver implementations

[Requirements](#id7)
--------------------

[](#requirements)

- PHP 7.1+

[Built-in drivers](#id8)
------------------------

[](#built-in-drivers)

DriverMulti-readMulti-writeMulti-deleteFilterableManual cleanupRequired extension`FilesystemDriver`nononoyesyesnone`ApcuDriver`yesyesyesyesno[APCu](http://php.net/manual/en/book.apcu.php)`MemcachedDriver`yespartialyesnono[Memcached](http://php.net/manual/en/book.memcached.php)`RedisDriver`yesyesyesyesno[PhpRedis](https://github.com/phpredis/phpredis)`MemoryDriver`yesyesyesyesyesnone`BlackHoleDriver`nononoyesnononeNote

The cache will emulate multi-read/write/delete if the driver doesn't support it natively.

[Usage](#id9)
-------------

[](#usage)

### [Creating a cache instance](#id10)

[](#creating-a-cache-instance)

#### [Filesystem](#id11)

[](#filesystem)

Store cache entries in the given directory as binary files.

```