ICanBoogie/Render v0.5.1
  • Namespace
  • Class

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 
<?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;

/**
 * Resolves templates pathname.
 */
class BasicTemplateResolver implements TemplateResolver
{
    use TemplateResolverTrait;

    /**
     * An array of key/value pairs, where _key_ if a pathname and _value_ its weight.
     *
     * @var array
     */
    protected $paths = [];

    /**
     * @param array $paths
     */
    public function __construct(array $paths = [])
    {
        foreach ($paths as $path)
        {
            $this->add_path($path);
        }
    }

    /**
     * @inheritdoc
     */
    public function resolve($name, array $extensions, &$tried = [])
    {
        return $this->resolve_path($this->resolve_tries($this->get_paths(), $name, $extensions), $tried);
    }

    /**
     * Adds a path to search templates in.
     *
     * Note: The path is discarded if it cannot be resolved with `realpath()`.
     *
     * @param string $path
     * @param int $weight
     *
     * @return string|false The real path, or `false` if the path was not added.
     */
    public function add_path($path, $weight = 0)
    {
        $path = realpath($path);

        if (!$path)
        {
            return false;
        }

        $path = $path . DIRECTORY_SEPARATOR;
        $this->paths[$path] = $weight;

        return $path;
    }

    /**
     * Returns the paths used to search templates.
     *
     * @return array
     */
    public function get_paths()
    {
        return array_keys(array_reverse($this->paths));
    }
}
ICanBoogie/Render v0.5.1 API documentation generated by ApiGen