Namespaces

• ICanBoogie
  • Render
    • EngineCollection
    • Renderer
    • TemplateResolver

Classes

• BasicTemplateResolver
• EngineCollection
• EngineNotAvailable
• EngineNotDefined
• PHPEngine
• Renderer
• StringObject
• TemplateName

Interfaces

• Engine
• Exception
• TemplateResolver
• TemplateResolverDecorator

Traits

• TemplateResolverDecoratorTrait
• TemplateResolverTrait

Exceptions

• InvalidRenderTarget
• TemplateNotFound

Functions

• get_engines
• get_renderer
• get_template_resolver
• render

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Render;

use ICanBoogie\Accessor\AccessorTrait;

/**
 * An engine collection.
 *
 * @property-read array $extensions The extensions supported by the engines.
 */
class EngineCollection implements \ArrayAccess, \IteratorAggregate
{
    use AccessorTrait;

    /**
     * @var array
     */
    private $engines;

    /**
     * @return array
     */
    protected function get_extensions()
    {
        return array_keys($this->engines);
    }

    /**
     * @var Engine[]
     */
    private $instances;

    /**
     * @param array $engines
     */
    public function __construct(array $engines = [])
    {
        foreach ($engines as $extension => $engine)
        {
            $this[$extension] = $engine;
        }
    }

    /**
     * @inheritdoc
     */
    public function offsetExists($extension)
    {
        return isset($this->engines[$extension]);
    }

    /**
     * @inheritdoc
     */
    public function offsetGet($extension)
    {
        if (!$this->offsetExists($extension))
        {
            throw new EngineNotDefined([ $extension, $this ]);
        }

        if (empty($this->instances[$extension]))
        {
            $instance = $this->engines[$extension];

            if (is_string($instance))
            {
                $instance = new $instance;
            }

            $this->instances[$extension] = $instance;
        }

        return $this->instances[$extension];
    }

    /**
     * @inheritdoc
     */
    public function offsetSet($extension, $engine)
    {
        $this->engines[$extension] = $engine;
    }

    /**
     * @inheritdoc
     */
    public function offsetUnset($extension)
    {
        unset($this->engines[$extension]);
    }

    /**
     * @inheritdoc
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->engines);
    }

    /**
     * Resolves the engine to use from the specified pathname.
     *
     * @param $pathname
     *
     * @return Engine|bool An engine or `false` if none matches the extension.
     */
    public function resolve_engine($pathname)
    {
        $extension = pathinfo($pathname, PATHINFO_EXTENSION);

        if (!$extension)
        {
            return false;
        }

        $extension = "." . $extension;

        if (!isset($this[$extension]))
        {
            return false;
        }

        return $this[$extension];
    }

    /**
     * Renders a template with the specified variables.
     *
     * @param string $template_pathname The pathname of the template.
     * @param mixed $thisArg The subject of the rendering.
     * @param array $variables
     * @param array $options
     *
     * @return string
     *
     * @throws EngineNotAvailable when there is no engine available to render the template.
     */
    public function render($template_pathname, $thisArg, $variables, array $options = [])
    {
        $engine = $this->resolve_engine($template_pathname);

        if (!$engine)
        {
            throw new EngineNotAvailable("There is no engine available to render template $template_pathname.");
        }

        return $engine->render($template_pathname, $thisArg, $variables, $options);
    }
}