Skip to content

[FrameworkBundle][HttpKernel] Introduce $buildDir argument to WarmableInterface::warmup to warm read-only artefacts in build_dir #19041

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 1 commit into from
Oct 18, 2023
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
12 changes: 10 additions & 2 deletions reference/dic_tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i

class MyCustomWarmer implements CacheWarmerInterface
{
public function warmUp($cacheDirectory): array
public function warmUp(string $cacheDir, string $buildDir = null): array
{
// ... do some sort of operations to "warm" your cache

Expand All @@ -515,7 +515,15 @@ 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.
If you don't need to preload anything, return an empty array. If read-only
artefacts need to be created, you can store them in a different directory
with the ``$buildDir`` parameter of the ``warmUp()`` method.

.. versionadded:: 6.4

The ``$buildDir`` parameter of the
:method:`Symfony\\Component\\HttpKernel\\CacheWarmer\\WarmableInterface::warmUp`
method was introduced in Symfony 6.4.

The ``isOptional()`` method should return true if it's possible to use the
application without calling this cache warmer. In Symfony, optional warmers
Expand Down