Asmaster\EquipTwig\Loader\FilesystemLoader\FilesystemLoader::template()

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	1

1 Method

Rating	Name	Duplication	Size	Complexity
A	FilesystemLoader::getFileExtensions()	0	4	1

<?php

namespace Asmaster\EquipTwig\Loader;

use Asmaster\EquipTwig\Exception\LoaderException;
use Twig_ExistsLoaderInterface as TwigExistsLoader;
use Twig_LoaderInterface as TwigLoader;

final class FilesystemLoader implements TwigLoader, TwigExistsLoader

The interface Twig_ExistsLoaderInterface has been deprecated with message: since 1.12 (to be removed in 3.0)

{
    /**
     * @var string
     */
    private $path;

    /**
     * @var array
     */
    private $fileExtensions = ['html.twig', 'twig'];

    /**
     * @var array
     */
    private $cache = [];

    /**
     * @param string $path           The template directory path
     * @param array  $fileExtensions The template file extensions
     */
    public function __construct($path, array $fileExtensions = null)
    {
        $this->path = $path;

        if ($fileExtensions) {
            $this->fileExtensions = $fileExtensions;
        }
    }

    /**
     * @inheritDoc
     */
    public function getSource($name)
    {
        return file_get_contents($this->template($name));
    }

    /**
     * @inheritDoc
     */
    public function getCacheKey($name)
    {
        return $this->template($name);
    }

    /**
     * @inheritDoc
     */
    public function isFresh($name, $time)
    {
        return filemtime($this->template($name)) <= $time;
    }

    /**
     * @inheritDoc
     */
    public function exists($name)
    {
        if (isset($this->cache[$name])) {
            return true;
        }

        return (bool) $this->findTemplate($name);
    }

    /**
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * @return array
     */
    public function getFileExtensions()
    {
        return $this->fileExtensions;
    }

    /**
     * @throws LoaderException When $name is not found
     *
     * @param string $name
     *
     * @return string
     */
    private function template($name)
    {
        if (isset($this->cache[$name])) {
            return $this->cache[$name];
        }

        $found = $this->findTemplate($name);
        if (!$found) {

The expression $found of type string|null is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === null instead.

            throw LoaderException::notFound($name, $this->path);
        }

        return $this->cache[$name] = $found;
    }

    /**
     * @param string $name
     *
     * @return string|null
     */
    private function findTemplate($name)
    {
        $files = $this->possibleTemplateFiles($name);

        foreach($files as $file) {
            $filepath = $this->path . DIRECTORY_SEPARATOR . $file;
            if (is_readable($filepath)) {
                return realpath($filepath);
            }
        }

        return null;
    }

    /**
     * @param string $name
     *
     * @return array
     */
    private function possibleTemplateFiles($name)
    {
        $name = $this->normalizeName($name);

        $templates = [$name];
        foreach($this->fileExtensions as $extension) {
            $templates[] = "$name.$extension";
        }

        return $templates;
    }

    /**
     * @param string $name
     *
     * @return string
     */
    private function normalizeName($name)
    {
        return preg_replace('#/{2,}#', DIRECTORY_SEPARATOR,
            str_replace('\\', DIRECTORY_SEPARATOR, $name)
        );
    }
}