Utopia Cache

Important

This repository is a read-only mirror of the utopia-php monorepo. Development happens in packages/cache — please open issues and pull requests there.

Utopia framework cache library is simple and lite library for managing application cache storing, loading and purging. This library is aiming to be as simple and easy to learn and use. This library is maintained by the Appwrite team.

Although this library is part of the Utopia Framework project it is dependency free and can be used as standalone with any other PHP project or framework.

Getting started

Install using Composer:

composer require utopia-php/cache

File System Adapter

<?php

require_once __DIR__ . '/../../vendor/autoload.php';

use Utopia\Cache\Cache;
use Utopia\Cache\Adapter\Filesystem;

$cache  = new Cache(new Filesystem('/cache-dir'));
$key    = 'data-from-example.com';

$data   = $cache->load($key, 60 * 60 * 24 * 30 * 3 /* 3 months */);

if(!$data) {
    $data = file_get_contents('https://example.com');
    
    $cache->save($key, $data);
}

echo $data;

Adapters

Adapter	Notes
Filesystem	Files on disk, with optional streaming reads.
Memory	In-process array, useful in tests.
None	Stores nothing, for turning caching off.
Redis	phpredis, with reconnect and leases.
Redis\Multiplexing	Many Swoole coroutines over one Redis connection — see the multiplexing guide.
RedisCluster	phpredis against a Redis cluster.
Memcached	Memcached over the binary protocol.
Hazelcast	Hazelcast over its Memcached protocol.
Sharding	Spreads keys across several adapters.
Pool	Checks an adapter out of a utopia-php/pools pool per call.
CircuitBreaker	Wraps an adapter so a failing cache stops being called.

System requirements

The library requires PHP 8.4 or later. The Redis, Memcached and Hazelcast adapters need the matching extension — see the suggest block in composer.json.

Tests

The unit tier needs nothing running:

composer test

The end-to-end tier runs on the host against this package's services:

docker compose up -d --wait
composer test:e2e
docker compose down -v

Copyright and license

The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php