README

Yii Cache Library - Memcached Handler

This package provides the Memcached handler and implements PSR-16 cache.

This option can be considered as the fastest one when dealing with a cache in a distributed applications (e.g. with several servers, load balancers, etc.).

Requirements

PHP 8.0 or higher.
Memcached PHP extension.

Installation

The package could be installed with composer:

composer require yiisoft/cache-memcached

Development environment

For greater ease it is recommended to use docker containers.

Run container with memcached directly via command:

docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11211 memcached:1.6.23

Memcached must be accessible by address 127.0.0.1. If you use PHP via docker container, run PHP container in network of memcached container. Use docker run command argument for it:

--network container:yiisoft-cache-memcached-cache

Configuration

Creating an instance:

$cache = new \Yiisoft\Cache\Memcached\Memcached($persistentId, $servers);

$persistentId (string) - The ID that identifies the Memcached instance is an empty string by default. By default, the Memcached instances are destroyed at the end of the request. To create an instance that persists between requests, use persistent_id to specify a unique ID for the instance. All instances created with the same $persistentId will share the same connection.

For more information, see the description of the \Memcached::__construct().

$servers (array) - List of memcached servers that will be added to the server pool.

List has the following structure:

$servers => [
    [
        'host' => 'server-1',
        'port' => 11211,
        'weight' => 100,
    ],
    [
        'host' => 'server-2',
        'port' => 11211,
        'weight' => 50,
    ],
];

The default value:

$servers => [
    [
        'host' => Memcached::DEFAULT_SERVER_HOST, // '127.0.0.1'
        'port' => Memcached::DEFAULT_SERVER_PORT, // 11211
        'weight' => Memcached::DEFAULT_SERVER_WEIGHT, // 1
    ],
];

For more information, see the description of the \Memcached::addServers().

General usage

The package does not contain any additional functionality for interacting with the cache, except those defined in the PSR-16 interface.

$cache = new \Yiisoft\Cache\Memcached\Memcached();
$parameters = ['user_id' => 42];
$key = 'demo';

// try retrieving $data from cache
$data = $cache->get($key);

if ($data === null) {
    // $data is not found in cache, calculate it from scratch
    $data = calculateData($parameters);
    
    // store $data in cache for an hour so that it can be retrieved next time
    $cache->set($key, $data, 3600);
}

// $data is available here

In order to delete value you can use:

$cache->delete($key);
// Or all cache
$cache->clear();

To work with values in a more efficient manner, batch operations should be used:

getMultiple()
setMultiple()
deleteMultiple()

This package can be used as a cache handler for the Yii Caching Library.

Documentation

Internals

Support

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

Support the project

Follow updates

License

The Yii Cache Library - Memcached Handler is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

yiisoft / cache-memcached

Maintainers

Details