PHP Files Cache Adapter

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

Read the updated version of this page for Symfony 7.1 (the current stable version).

Similarly to Filesystem Adapter, this cache implementation writes cache entries out to disk, but unlike the Filesystem cache adapter, the PHP Files cache adapter writes and reads back these cache files as native PHP code. For example, caching the value ['my', 'cached', 'array'] will write out a cache file similar to the following:

        1
2
3
4
5
6
7
8
9
10
11
12
13
        <?php return [

    // the cache item expiration
    0 => 9223372036854775807,

    // the cache item contents
    1 => [
        0 => 'my',
        1 => 'cached',
        2 => 'array',
    ],

];
    

Note

As cache items are included and parsed as native PHP code and due to the way OPcache handles file includes, this adapter has the potential to be much faster than other filesystem-based caches.

Caution

If you have configured OPcache to not check the file timestamps the cached items will not be invalidated unless you clear OPcache.

The PhpFilesAdapter can optionally be provided a namespace, default cache lifetime, and cache directory path as constructor arguments:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        use Symfony\Component\Cache\Adapter\PhpFilesAdapter;

$cache = new PhpFilesAdapter(

    // a string used as the subdirectory of the root cache directory, where cache
    // items will be stored
    $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 files are deleted)
    $defaultLifetime = 0,

    // the main cache directory (the application needs read-write permissions on it)
    // if none is specified, a directory is created inside the system temporary directory
    $directory = null
);
    

Note

Since Symfony 3.4, this adapter implements PruneableInterface, allowing for manual pruning of expired cache entries by calling its prune() method.

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

TOC

Version