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 162 163 164 165 166 167 

<?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;
use ICanBoogie\ActiveRecord\Query;

/**
 * Representation of a template name.
 *
 * @property-read string $as_template Name as template name.
 * @property-read string $as_partial Name as partial name.
 * @property-read string $as_layout Name as layout name.
 */
class TemplateName
{
    use AccessorTrait;

    const TEMPLATE_PREFIX_VIEW = '';
    const TEMPLATE_PREFIX_LAYOUT = '@';
    const TEMPLATE_PREFIX_PARTIAL = '_';

    static private $instances = [];

    /**
     * @param string|TemplateName $source
     *
     * @return TemplateName
     */
    static public function from($source)
    {
        if ($source instanceof self)
        {
            return $source;
        }

        if ($source instanceof Query)
        {
            $source = $source->model->id . '/list';
        }

        $source = static::normalize($source);

        if (isset(self::$instances[$source]))
        {
            return self::$instances[$source];
        }

        return self::$instances[$source] = new static($source);
    }

    /**
     * Normalizes a template name by removing any known prefix.
     *
     * @param string $name
     *
     * @return string
     */
    static public function normalize($name)
    {
        $basename = basename($name);
        $dirname = $basename != $name ? dirname($name) : null;

        if (in_array($basename{0}, [ self::TEMPLATE_PREFIX_VIEW, self::TEMPLATE_PREFIX_LAYOUT, self::TEMPLATE_PREFIX_PARTIAL ]))
        {
            $basename = substr($basename, 1);
        }

        if ($dirname)
        {
            $basename = $dirname . "/". $basename;
        }

        return $basename;
    }

    private $name;

    /**
     * Returns the name as template name.
     *
     * @return string
     */
    protected function get_as_template()
    {
        return $this->name;
    }

    /**
     * Returns the name as partial name.
     *
     * @return string
     */
    protected function get_as_partial()
    {
        return $this->with_prefix(self::TEMPLATE_PREFIX_PARTIAL);
    }

    /**
     * Returns the name as layout name.
     *
     * @return string
     */
    protected function get_as_layout()
    {
        return $this->with_prefix(self::TEMPLATE_PREFIX_LAYOUT);
    }

    /**
     * Returns the template name with the specified prefix.
     *
     * @param string $prefix
     *
     * @return string
     */
    public function with_prefix($prefix)
    {
        $name = $this->name;

        if (!$prefix)
        {
            return $name;
        }

        $basename = basename($name);
        $dirname = $basename != $name ? dirname($name) : null;

        $name = $prefix . $basename;

        if ($dirname)
        {
            $name = $dirname . "/" . $name;
        }

        return $name;
    }

    /**
     * Initializes the {@link $name} property.
     *
     * @param string $name
     */
    protected function __construct($name)
    {
        $this->name = (string) $name;
    }

    /**
     * Returns the {@link $name} property.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->name;
    }
}