Jasny\View\Twig

Complexity

Total Complexity

29

Size/Duplication

Total Lines	211
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	4
A	createTwigEnvironment()	0	11	2
A	addLoaderPaths()	0	10	3
A	getTwig()	0	4	1
A	assertViewVariableName()	0	11	4
B	expose()	0	17	6
A	addPlugin()	0	7	1
A	getPlugins()	0	4	1
A	invokePluginsOnRender()	0	6	2
A	addDefaultExtensions()	0	4	1
A	getFilename()	0	8	3
A	render()	0	16	1

<?php

namespace Jasny\View;

use Jasny\ViewInterface;
use Jasny\View\PluginInterface;
use Jasny\View\Plugin\DefaultTwigExtensions;
use Psr\Http\Message\ResponseInterface;

/**
 * Abstraction to use Twig with PSR-7
 */
class Twig implements ViewInterface
{
    /**
     * Twig environment
     * @var \Twig_Environment
     */
    protected $twig;
    
    /**
     * @var PluginInterface[]
     */
    protected $plugins = [];
    
    
    /**
     * Class constructor
     * 
     * @param \Twig_Environment|array $options
     */
    public function __construct($options)
    {
        $twig = is_array($options) ? $this->createTwigEnvironment($options) : $options;
        
        if (!$twig instanceof \Twig_Environment) {
            throw new \InvalidArgumentException("Was expecting an array with options or a Twig_Environment, got a "
                . (is_object($twig) ? get_class($twig) . ' ' : '') . gettype($twig));
        }
        
        $this->twig = $twig;
    }
    
    /**
     * Create a new Twig environment
     * 
     * @param array $options
     * @return \Twig_Environment
     */
    protected function createTwigEnvironment(array $options)
    {
        if (!isset($options['path'])) {
            throw new \BadMethodCallException("'path' option is required");
        }

        $loader = new \Twig_Loader_Filesystem();
        $this->addLoaderPaths($loader, $options['path']);
        
        return new \Twig_Environment($loader, $options);
    }
    
    /**
     * Add paths to Twig loader
     * 
     * @param \Twig_Loader_Filesystem $loader
     * @param string|array            $paths
     * @return type
     */
    protected function addLoaderPaths(\Twig_Loader_Filesystem $loader, $paths)
    {
        foreach ((array)$paths as $namespace => $path) {
            if (is_int($namespace)) {
                $namespace = \Twig_Loader_Filesystem::MAIN_NAMESPACE;
            }

            $loader->addPath($path, $namespace);
        }
    }
    
    /**
     * Get Twig environment
     *
     * @return \Twig_Environment
     */
    public function getTwig()
    {
        return $this->twig;
    }

    
    /**
     * Assert valid variable, function and filter name
     * 
     * @param string $name
     * @throws \InvalidArgumentException
     */
    protected function assertViewVariableName($name)
    {
        if (!is_string($name)) {
            $type = (is_object($name) ? get_class($name) . ' ' : '') . gettype($name);
            throw new \InvalidArgumentException("Expected name to be a string, not a $type");
        }

        if (!preg_match('/^[a-z]\w*$/i', $name)) {
            throw new \InvalidArgumentException("Invalid name '$name'");
        }
    }

    /**
     * Expose a function to the view.
     *
     * @param string        $name      Function name in template
     * @param callable|null $function
     * @param string        $as        'function' or 'filter'
     * @return $this
     */
    public function expose($name, $function = null, $as = 'function')
    {
        $this->assertViewVariableName($name);
        
        if ($as === 'function') {
            $function = new \Twig_SimpleFunction($name, $function ?: $name);
            $this->getTwig()->addFunction($function);
        } elseif ($as === 'filter') {
            $filter = new \Twig_SimpleFilter($name, $function ?: $name);
            $this->getTwig()->addFilter($filter);
        } else {
            $not = is_string($as) ? "'$as'" : gettype($as);
            throw new \InvalidArgumentException("You can create either a 'function' or 'filter', not a $not");
        }

        return $this;
    }

    
    /**
     * Add a plugin to the view
     * 
     * @param PluginInterface $plugin
     * @return $this
     */
    public function addPlugin(PluginInterface $plugin)
    {
        $plugin->onAdd($this); // Called before adding the plugin, because it may throw an exception
        $this->plugins[] = $plugin;
        
        return $this;
    }
    
    /**
     * Get all plugins
     * 
     * @return PluginInterface[]
     */
    public function getPlugins()
    {
        return $this->plugins;
    }
    
    /**
     * Invoke the onRender method of all plugins
     * 
     * @param string $template  Template filename
     * @param array  $context
     */
    protected function invokePluginsOnRender($template, array $context)
    {
        foreach ($this->plugins as $plugin) {
            $plugin->onRender($this, $template, $context);
        }
    }
    
    /**
     * Add the official Twig extension and Jansy Twig extensions.
     * @deprecated
     * 
     * @return $this
     */
    public function addDefaultExtensions()
    {
        return $this->addPlugin(new DefaultTwigExtensions());
    }

    
    /**
     * Get the filename
     * 
     * @return string
     */
    protected function getFilename($name)
    {
        if (pathinfo($name, PATHINFO_EXTENSION) === '') {
            $name .= substr($name, -1) === '/' ? 'index.html.twig' : '.html.twig';
        }
        
        return $name;
    }
    
    /**
     * Render and output template
     *
     * @param ResponseInterface $response
     * @param string            $name      Template name
     * @param array             $context   Template context as associated array
     * @return ResponseInterface
     */
    public function render(ResponseInterface $response, $name, array $context = [])
    {
        $file = $this->getFilename($name);

        $twig = $this->getTwig();
        $tmpl = $twig->load($file);
        
        $this->invokePluginsOnRender($file, $context);

        $contents = $tmpl->render($context);
        
        $newResponse = $response->withHeader('Content-Type', 'text/html; charset=' . $twig->getCharset());
        $newResponse->getBody()->write($contents);
        
        return $newResponse;
    }
}