jenschude / HandlebarsBundle

src/HandlebarsEnvironment.php

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 */


namespace JaySDe\HandlebarsBundle;


use JaySDe\HandlebarsBundle\Cache\Filesystem;
use JaySDe\HandlebarsBundle\Error\LoaderException;
use JaySDe\HandlebarsBundle\Loader\FilesystemLoader;
use LightnCandy\LightnCandy;
use Symfony\Component\Config\Resource\FileResource;

class HandlebarsEnvironment
{
    /**
     * @var array
     */
    protected $options;

    /**
     * @var Filesystem
     */
    protected $cache;

    /**
     * @var FilesystemLoader
     */
    protected $loader;

    /**
     * @var bool
     */
    protected $autoReload;

    /**
     * @var bool
     */
    protected $debug;

    /**
     * @var HandlebarsProfileExtension
     */
    private $profiler;

    /**
     * @var HandlebarsHelperServiceInterface
     */
    private $helper;

    /**
     * @var \ArrayObject
     */
    private $partials;

    public function __construct(
        FilesystemLoader $loader,
        HandlebarsHelperServiceInterface $helper,
        $options = [],
        Filesystem $cache,
        HandlebarsProfileExtension $profiler
    )
    {
        $this->loader = $loader;
        $this->partials = $partials = new \ArrayObject();
        $this->helper = $helper;

        $this->options = array_merge([
            'auto_reload' => null,
            'debug' => true,
            'helpers' => $this->helper->getHelperMethods(),
            'partialresolver' => function($cx, $name) use ($loader, &$partials) {
                $extension = $this->getTemplateExtension($loader, $name);
                if ($extension === false) {
                    return null;
                }
                $partials[] = new FileResource($loader->getCacheKey($name.$extension));
                return $loader->getSource($name.$extension);
            },
        ], $options);
        $this->debug = (bool) $this->options['debug'];
        $this->autoReload = null === $this->options['auto_reload'] ? $this->debug : (bool) $this->options['auto_reload'];
        $this->cache = $cache;
        $this->profiler = $profiler;
    }

    private function getTemplateExtension(FilesystemLoader $loader, $name) {
        if ($loader->exists($name.'.handlebars')) {
            return '.handlebars';
        }
        if ($loader->exists($name.'.hbs')) {
            return '.hbs';
        }
        return false;
    }

    public function compile($name)
    {
        $source = $this->getLoader()->getSource($name);
        $cacheKey = $this->getCacheFilename($name);

        $phpStr = '';
        try {
            $this->partials->exchangeArray([new FileResource($this->getLoader()->getCacheKey($name))]);
            $phpStr = LightnCandy::compile($source, $this->options);
        } catch (\Exception $e) {
            throw new LoaderException($e->getMessage());
        }
        $this->cache->write($cacheKey, '<?php // '.$name.PHP_EOL.$phpStr, $this->partials->getArrayCopy());

        return $phpStr;
    }

    public function render($name, array $context = [])
    {
        $renderer = $this->loadTemplate($name);

        $templateProfile = new \Twig_Profiler_Profile($name, \Twig_Profiler_Profile::TEMPLATE, $name);

The class Twig_Profiler_Profile has been deprecated with message: since Twig 2.7, use "Twig\Profiler\Profile" instead

        $this->profiler->enter($templateProfile);
        $html = $renderer($context, ['helpers' => $this->helper->getHelpers()]);
        $this->profiler->leave($templateProfile);

        return $html;
    }

    public function getCacheFilename($name)
    {
        $key = $this->cache->generateKey($name);

        return !$key ? false : $key;
    }

    public function getLoader()
    {
        return $this->loader;
    }

    /**
     * @param $templateName
     * @return callable
     */
    public function loadTemplate($templateName)
    {
        $name = (string) $templateName;
        $cacheKey = $this->getCacheFilename($name);

        if (!file_exists($cacheKey) || $this->isAutoReload() && !$this->cache->isFresh($cacheKey)) {
            $this->compile($name);
        }

        return $this->cache->load($cacheKey);
    }

    /**
     * Checks if the auto_reload option is enabled.
     *
     * @return bool true if auto_reload is enabled, false otherwise
     */
    public function isAutoReload()
    {
        return $this->autoReload;
    }
}