CedricZiel\TwigLoaderFlysystem\FlysystemLoader

Complexity

Total Complexity

10

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

96.15%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getSource()	0	6	1
A	getFileOrFail()	0	13	3
A	getCacheKey()	0	6	1
A	isFresh()	0	6	1
A	resolveTemplateName()	0	9	3

<?php

namespace CedricZiel\TwigLoaderFlysystem;

use League\Flysystem\Filesystem;
use Twig_Error_Loader;
use Twig_LoaderInterface;

/**
 * Provides a template loader for twig that allows to use flysystem
 * instances to load templates.
 *
 * @package CedricZiel\TwigLoaderFlysystem
 */
class FlysystemLoader implements Twig_LoaderInterface
{
    /**
     * @var Filesystem
     */
    private $filesystem;

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

    /**
     * FlysystemLoader constructor.
     *
     * @param Filesystem $filesystem
     * @param string $templatePath
     */
    public function __construct(Filesystem $filesystem, $templatePath = '')
    {
        $this->filesystem = $filesystem;
        $this->templatePath = $templatePath;
    }

    /**
     * Gets the source code of a template, given its name.
     *
     * @param string $name The name of the template to load
     *
     * @return string The template source code
     *
     * @throws Twig_Error_Loader When $name is not found
     */
    public function getSource($name)
    {
        $this->getFileOrFail($name);

        return $this->filesystem->read($this->resolveTemplateName($name));
    }

    /**
     * Checks if the underlying flysystem contains a file of the given name.
     *
     * @param string $name
     *
     * @return \League\Flysystem\File|\League\Flysystem\Handler
     * @throws Twig_Error_Loader
     */
    protected function getFileOrFail($name)
    {
        if (!$this->filesystem->has($this->resolveTemplateName($name))) {
            throw new Twig_Error_Loader('Template could not be found on the given filesystem');
        }

        $fileObject = $this->filesystem->get($this->resolveTemplateName($name));
        if ($fileObject->isDir()) {
            throw new Twig_Error_Loader('Cannot use directory as template');
        }

        return $fileObject;
    }

    /**
     * Gets the cache key to use for the cache for a given template name.
     *
     * @param string $name The name of the template to load
     *
     * @return string The cache key
     *
     * @throws Twig_Error_Loader When $name is not found
     */
    public function getCacheKey($name)
    {
        $this->getFileOrFail($name);

        return $name;
    }

    /**
     * Returns true if the template is still fresh.
     *
     * @param string $name The template name
     * @param int    $time Timestamp of the last modification time of the
     *                     cached template
     *
     * @return bool true if the template is fresh, false otherwise
     *
     * @throws Twig_Error_Loader When $name is not found
     */
    public function isFresh($name, $time)
    {
        $object = $this->getFileOrFail($name);

        return (int)$time >= (int)$object->getTimestamp();
    }

    /**
     * @param string $name
     *
     * @return string
     */
    protected function resolveTemplateName($name)
    {
        $prefix = $this->templatePath;
        if ($this->templatePath !== null && $this->templatePath !== '') {
            $prefix = rtrim($prefix, '/').'/';
        }

        return $prefix.$name;
    }
}