Puli\TwigExtension\CacheWarmer\TwigTemplateCacheWarmer

Complexity

Total Complexity

5

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

90%

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	isOptional()	0	4	1
A	warmUp()	0	22	3

<?php

/*
 * This file is part of the puli/twig-puli-extension package.
 *
 * (c) Bernhard Schussek <bschussek@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\TwigExtension\CacheWarmer;

use Puli\Repository\Api\ResourceRepository;
use Puli\Repository\Resource\Iterator\RecursiveResourceIteratorIterator;
use Puli\Repository\Resource\Iterator\ResourceCollectionIterator;
use Puli\Repository\Resource\Iterator\ResourceFilterIterator;
use RuntimeException;
use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
use Twig_Environment;
use Twig_Error;

/**
 * Generates the Twig cache for all templates in the resource repository.
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class TwigTemplateCacheWarmer implements CacheWarmerInterface
{
    /**
     * @var ResourceRepository
     */
    private $repo;

    /**
     * @var string
     */
    private $suffix;

    /**
     * @var Twig_Environment
     */
    private $twig;

    public function __construct(ResourceRepository $repo, Twig_Environment $twig, $suffix = '.twig')
    {
        $this->repo = $repo;
        $this->suffix = $suffix;
        $this->twig = $twig;
    }

    /**
     * Warms up the cache.
     *
     * @param string $cacheDir The cache directory
     *
     * @throws RuntimeException If setEnvironment() wasn't called
     */
    public function warmUp($cacheDir)
    {
        $iterator = new ResourceFilterIterator(
            new RecursiveResourceIteratorIterator(
                new ResourceCollectionIterator(
                    $this->repo->get('/')->listChildren(),
                    ResourceCollectionIterator::CURRENT_AS_PATH
                ),
                RecursiveResourceIteratorIterator::SELF_FIRST
            ),
            $this->suffix,
            ResourceFilterIterator::FILTER_BY_NAME | ResourceFilterIterator::MATCH_SUFFIX
        );

        foreach ($iterator as $path) {
            try {
                $this->twig->loadTemplate($path);
            } catch (Twig_Error $e) {
                // Problem during compilation, stop
            }
        }
    }

    /**
     * Returns whether this warmer is optional or not.
     *
     * @return bool always true
     */
    public function isOptional()
    {
        return true;
    }
}