README

Drupal Cache Adapter

Provides a Symfony Cache adapter to the Drupal cache system.

It's useful when a third-party library requires a php-cache style adapter to cache data, but you want to pipe the cachig process through the Drupal cache API.

A good example is https://github.com/KnpLabs/php-github-api, a library querying the GitHub API. Calls to GitHub might be cached but the library requires a php-cache adapter. You can use the DrupalPhpCacheAdapter provided by this package, to route the cache write/read via Drupal caching API. See https://github.com/KnpLabs/php-github-api/blob/master/doc/caching.md.

Install

Use composer:

composer require drupal/php_cache_adapter

Usage

use Drupal\SymfonyCacheAdapter\DrupalPhpCacheAdapter;
use ThirdParty\Library\Client;

class SomeService {
    public function doSomething()
    {
        $client = new Client(...);
        $adapter = new DrupalPhpCacheAdapter(\Drupal::service('cache.data'));
        $client->addCacheBackend($adapter);
        $client->fetch();
        ...
    }
}

Contributing

We use DDEV for development. Refer to the DDEV documentation for details on how to get started.

Code quality

Run code style checks:

ddev composer phpcs

Fix code style issues:

ddev composer phpcbf

Static analysis:

ddev composer phpstan

Unit tests

ddev composer phpunit