Charcoal\View\Twig\TwigLoader

Complexity

Total Complexity

8

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	isTemplateString()	0	4	2
A	filenameFromIdent()	0	7	1
A	getSource()	0	4	1
A	getSourceContext()	0	5	1
A	exists()	0	4	1
A	getCacheKey()	0	5	1
A	isFresh()	0	6	1

<?php

namespace Charcoal\View\Twig;

// From Twig
use Twig_LoaderInterface;
use Twig_Source;

// From 'charcoal-view'
use Charcoal\View\AbstractLoader;
use Charcoal\View\LoaderInterface;

/**
 * The Charcoal View Twig Loader implements both Twig_LoaderInterface and its own LoaderInterface.
 */
class TwigLoader extends AbstractLoader implements
    LoaderInterface,
    Twig_LoaderInterface
{
    /**
     * Determine if the variable is a template literal.
     *
     * This method looks for any tag delimiters in the given string,
     * which a file path would most likely not have.
     *
     * @todo   Add support for custom delimiters.
     * @param  string $ident The template being evaluated.
     * @return boolean
     */
    protected function isTemplateString($ident)
    {
        return strpos($ident, '{%') !== false || parent::isTemplateString($ident);

The method isTemplateString() cannot be called from this context as it is declared protected in class Charcoal\View\AbstractLoader.

    }

    /**
     * Convert an identifier to a file path.
     *
     * @param string $ident The identifier to convert.
     * @return string
     */
    protected function filenameFromIdent($ident)
    {
        $filename = str_replace([ '\\' ], '.', $ident);
        $filename .= '.twig';

        return $filename;
    }

    /**
     * Twig_LoaderInterface > getSource()
     *
     * 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.
     */
    public function getSource($name)
    {
        return $this->load($name);

The method Charcoal\View\AbstractLoader::load() has been deprecated with message: $GLOBALS['widget_template']

    }

    /**
     * Twig_LoaderInterface > getSourceContext()
     *
     * Gets the source code of a template, given its name.
     * For Twig 2.x
     *
     * @param  string $name The name of the template to load.
     * @return Twig_Source The template source object.
     */
    public function getSourceContext($name)
    {
        $source = $this->load($name);

The method Charcoal\View\AbstractLoader::load() has been deprecated with message: $GLOBALS['widget_template']

        return new Twig_Source($source, $name);
    }

    /**
     * Twig_LoaderInterface > exists()
     *
     * For Twig 2.x
     *
     * @param  string $name The name of the template to load.
     * @return boolean
     */
    public function exists($name)
    {
        return !!$this->findTemplateFile($name);
    }

    /**
     * Twig_LoaderInterface > getCacheKey()
     *
     * 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|null The cache key
     */
    public function getCacheKey($name)
    {
        $key = $this->findTemplateFile($name);
        return $key;
    }

    /**
     * Twig_LoaderInterface > isFresh()
     *
     * Returns true if the template is still fresh.
     *
     * @param string  $name The template name.
     * @param integer $time The last modification time of the cached template.
     * @return boolean
     */
    public function isFresh($name, $time)
    {
        $file = $this->findTemplateFile($name);
        $fresh = (filemtime($file) <= $time);
        return $fresh;
    }
}