Skip to content

Document that cache warmers now must return an array of files to preload #13516

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.

Sign up for GitHub

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
javiereguiluz merged 1 commit into from
May 18, 2020
Merged

Document that cache warmers now must return an array of files to preload #13516

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions reference/dic_tags.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,13 +468,25 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i
// src/Cache/MyCustomWarmer.php
namespace App\Cache;

use App\Foo\Bar;
use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;

class MyCustomWarmer implements CacheWarmerInterface
{
public function warmUp($cacheDirectory)
{
// ... do some sort of operations to "warm" your cache

$filesAndClassesToPreload = [];
$filesAndClassesToPreload[] = Bar::class;

foreach (scandir($someCacheDir) as $file) {
if (!is_dir($file = $someCacheDir.'/'.$file)) {
$filesAndClassesToPreload[] = $file;
}
}

return $filesAndClassesToPreload;
}

public function isOptional()
Expand All @@ -483,6 +495,16 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i
}
}

The ``warmUp()`` method must return an array with the files and classes to
preload. Files must be absolute paths and classes must be fully-qualified class
names. The only restriction is that files must be stored in the cache directory.
If you don't need to preload anything, return an empty array

.. deprecated:: 5.1

Not returning an array from the ``warmUp()`` method with the files to
preload is deprecated since Symfony 5.1.

The ``isOptional()`` method should return true if it's possible to use the
application without calling this cache warmer. In Symfony, optional warmers
are always executed by default (you can change this by using the
Expand Down