W3cubDocs

/Symfony 4.0

TemplateCacheWarmer

class TemplateCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInterface

Generates the Twig cache for all templates.

Methods

__construct(ContainerInterface $container, Traversable $iterator)
warmUp(string $cacheDir)

Warms up the cache.

bool isOptional()

Checks whether this warmer is optional or not.

static array getSubscribedServices()

Returns an array of service types required by such instances, optionally keyed by the service names used internally.

Details

__construct(ContainerInterface $container, Traversable $iterator)

Parameters

ContainerInterface $container
Traversable $iterator

warmUp(string $cacheDir)

Warms up the cache.

Parameters

string $cacheDir The cache directory

bool isOptional()

Checks whether this warmer is optional or not.

Optional warmers can be ignored on certain conditions.

A warmer should return true if the cache can be generated incrementally and on-demand.

Return Value

bool true if the warmer is optional, false otherwise

static array getSubscribedServices()

Returns an array of service types required by such instances, optionally keyed by the service names used internally.

For mandatory dependencies:

  • array('logger' => 'Psr\Log\LoggerInterface') means the objects use the "logger" name internally to fetch a service which must implement Psr\Log\LoggerInterface.
  • array('Psr\Log\LoggerInterface') is a shortcut for
  • array('Psr\Log\LoggerInterface' => 'Psr\Log\LoggerInterface')

otherwise:

  • array('logger' => '?Psr\Log\LoggerInterface') denotes an optional dependency
  • array('?Psr\Log\LoggerInterface') is a shortcut for
  • array('Psr\Log\LoggerInterface' => '?Psr\Log\LoggerInterface')

Return Value

array The required service types, optionally keyed by service names

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.html