Skip to content

Covering two missing Cache adapters introduced in 3.2 #7424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 28, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions components/cache/cache_pools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,25 @@ contents as regular files in a set of directories on the local file system::
$directory = null
);

Php Files Cache Adapter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Php Files -> PHP Files ? (after all, PHP is an acronym)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to leave this - I did it because the name of the class is PhpFilesAdapter... but I could see it either way (I would normally 100% agree)

~~~~~~~~~~~~~~~~~~~~~~~

This adapter is very similar to the Filesystem adapter, except that the saving creates
a ``.php`` file, which is included on fetch (allowing the file to be saved in OPcache)::

use Symfony\Component\Cache\Adapter\PhpFilesAdapter;

$cache = new PhpFilesAdapter(
// the subdirectory of the main cache directory where cache items are stored
$namespace = '',
// in seconds; applied to cache items that don't define their own lifetime
// 0 means to store the cache items 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
);

APCu Cache Adapter
~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -189,6 +208,41 @@ This adapter also defines two optional arguments called ``namespace`` (default:
``''``) and ``defaultLifetime`` (default: ``0``) and adapts them to make them
work in the underlying Doctrine cache.

Php Array Cache Adapter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. Php -> PHP ?

~~~~~~~~~~~~~~~~~~~~~~~

This adapter is a highly performant way to cache static data (e.g. application configuration)
that is optimized and preloaded into OPcache memory storage::

use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
use Symfony\Component\Cache\Adapter\PhpFilesAdapter;

// somehow, decide it's time to warm up the cache!
if ($needsWarmup) {
// some static values
$values = array(
'stats.num_products' => 4711,
'stats.num_users' => 1356,
);

$cache = new PhpArrayAdapter(
// single file where values are cached
__DIR__ . '/somefile.cache',
// a backup adapter, if you set values after warmup
new FilesystemAdapter()
);
$cache->warmUp($values);
}

// ... then, use the cache!
$cacheItem = $cache->getItem('stats.num_users');
echo $cacheItem->get();

.. note::

This adapter requires PHP 7.x and should be used with the php.ini setting
``opcache.enable`` on.

Looking for Cache Items
-----------------------

Expand Down