Filesystem Cache Adapter

4.0 version

Maintained

4.4 5.2 current 5.3 dev

Unmaintained

3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1

Filesystem Cache Adapter¶

This adapter offers improved application performance for those who cannot install tools like APCu or Redis in their environment. It stores the cache item expiration and content as regular files in a collection of directories on a locally mounted filesystem.

Tip

The performance of this adapter can be greatly increased by utilizing a temporary, in-memory filesystem, such as tmpfs on Linux, or one of the many other RAM disk solutions available.

The FilesystemAdapter can optionally be provided a namespace, default cache lifetime, and cache root path as constructor parameters:

use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$cache = new FilesystemAdapter(

    // 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
);

Caution

The overhead of filesystem IO often makes this adapter one of the slower choices. If throughput is paramount, the in-memory adapters (Apcu, Memcached, and Redis) or the database adapters (Doctrine and PDO) are recommended.

Note

Since Symfony 3.4, this adapter implements Symfony\Component\Cache\PruneableInterface, enabling manual pruning of expired cache items by calling its prune() method.

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