W3cubDocs

/Symfony 3.3

TemplateCacheCacheWarmer

class TemplateCacheCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInterface

Generates the Twig cache for all templates.

This warmer must be registered after TemplatePathsCacheWarmer, as the Twig loader will need the cache generated by it.

Methods

__construct(ContainerInterface $container, TemplateFinderInterface $finder = null, array $paths = array())

Constructor.

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, TemplateFinderInterface $finder = null, array $paths = array())

Constructor.

Parameters

ContainerInterface $container The dependency injection container
TemplateFinderInterface $finder The template paths cache warmer
array $paths Additional twig paths to warm

warmUp(string $cacheDir)

Warms up the cache.

Parameters

string $cacheDir The cache directory

bool isOptional()

Checks whether this warmer is optional or not.

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/3.3/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheCacheWarmer.html