Doctrine Cache Adapter

Warning: You are browsing the documentation for Symfony 5.x, which is no longer maintained.

Consider upgrading your projects to Symfony 7.2.

5.4

The DoctrineAdapter and DoctrineProvider classes were deprecated in Symfony 5.4 and it will be removed in Symfony 6.0.

This adapter wraps any class extending the Doctrine Cache abstract provider, allowing you to use these providers in your application as if they were Symfony Cache adapters.

This adapter expects a \Doctrine\Common\Cache\CacheProvider instance as its first parameter, and optionally a namespace and default cache lifetime as its second and third parameters:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
        use Doctrine\Common\Cache\CacheProvider;
use Doctrine\Common\Cache\SQLite3Cache;
use Symfony\Component\Cache\Adapter\DoctrineAdapter;

$provider = new SQLite3Cache(new \SQLite3(__DIR__.'/cache/data.sqlite'), 'youTableName');

$cache = new DoctrineAdapter(

    // a cache provider instance
    CacheProvider $provider,

    // a string prefixed to the keys of the items stored in this cache
    $namespace = '',

    // the default lifetime (in seconds) for cache items that do not define their
    // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
    // until the database table is truncated or its rows are otherwise deleted)
    $defaultLifetime = 0
);
    

Tip

A DoctrineProvider class is also provided by the component to use any PSR6-compatible implementations with Doctrine-compatible classes.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version