Просмотр архива Contao (бывшая TYPOlight)


<?php

/**
 * Contao Open Source CMS
 *
 * Copyright (c) 2005-2016 Leo Feyer
 *
 * @license LGPL-3.0+
 */

namespace Contao;


/**
 * Provides shared logic for template classes
 *
 * @author Leo Feyer <https://github.com/leofeyer>
 */
abstract class BaseTemplate extends Controller
{

    /**
     * Template file
     * @var string
     */
    protected $strTemplate;

    /**
     * Parent template
     * @var string
     */
    protected $strParent;

    /**
     * Default template
     * @var string
     */
    protected $strDefault;

    /**
     * Output format
     * @var string
     */
    protected $strFormat = 'html5';

    /**
     * Tag ending
     * @var string
     */
    protected $strTagEnding = '>';

    /**
     * Blocks
     * @var array
     */
    protected $arrBlocks = array();

    /**
     * Block names
     * @var array
     */
    protected $arrBlockNames = array();


    /**
     * Parse the template file and return it as string
     *
     * @return string The template markup
     */
    public function parse()
    {
        $strBuffer = '';

        // Start with the template itself
        $this->strParent = $this->strTemplate;

        // Include the parent templates
        while ($this->strParent !== null)
        {
            $strCurrent = $this->strParent;
            $strParent = $this->strDefault ?: $this->getTemplate($this->strParent, $this->strFormat);

            // Reset the flags
            $this->strParent = null;
            $this->strDefault = null;

            ob_start();
            include $strParent;

            // Capture the output of the root template
            if ($this->strParent === null)
            {
                $strBuffer = ob_get_contents();
            }
            elseif ($this->strParent == $strCurrent)
            {
                $this->strDefault = TemplateLoader::getDefaultPath($this->strParent, $this->strFormat);
            }

            ob_end_clean();
        }

        // Reset the internal arrays
        $this->arrBlocks = array();

        // Add start and end markers in debug mode
        if (Config::get('debugMode'))
        {
            $strRelPath = str_replace(TL_ROOT . '/', '', $this->getTemplate($this->strTemplate, $this->strFormat));
            $strBuffer = "n<!-- TEMPLATE START: $strRelPath -->n$strBuffern<!-- TEMPLATE END: $strRelPath -->n";
        }

        return $strBuffer;
    }


    /**
     * Extend another template
     *
     * @param string $name The template name
     */
    public function extend($name)
    {
        $this->strParent = $name;
    }


    /**
     * Insert the content of the parent block
     */
    public function parent()
    {
        echo '[[TL_PARENT]]';
    }


    /**
     * Start a new block
     *
     * @param string $name The block name
     *
     * @throws Exception If a child templates contains nested blocks
     */
    public function block($name)
    {
        $this->arrBlockNames[] = $name;

        // Root template
        if ($this->strParent === null)
        {
            // Register the block name
            if (!isset($this->arrBlocks[$name]))
            {
                $this->arrBlocks[$name] = '[[TL_PARENT]]';
            }

            // Combine the contents of the child blocks
            elseif (is_array($this->arrBlocks[$name]))
            {
                $callback = function($current, $parent) {
                    return str_replace('[[TL_PARENT]]', $parent, $current);
                };

                $this->arrBlocks[$name] = array_reduce($this->arrBlocks[$name], $callback, '[[TL_PARENT]]');
            }

            // Handle nested blocks
            if ($this->arrBlocks[$name] != '[[TL_PARENT]]')
            {
                // Output everything before the first TL_PARENT tag
                if (strpos($this->arrBlocks[$name], '[[TL_PARENT]]') !== false)
                {
                    list($content) = explode('[[TL_PARENT]]', $this->arrBlocks[$name], 2);
                    echo $content;
                }

                // Output the current block and start a new output buffer to remove the following blocks
                else
                {
                    echo $this->arrBlocks[$name];
                    ob_start();
                }
            }
        }

        // Child template
        else
        {
            // Clean the output buffer
            ob_end_clean();

            // Check for nested blocks
            if (count($this->arrBlockNames) > 1)
            {
                throw new Exception('Nested blocks are not allowed in child templates');
            }

            // Start a new output buffer
            ob_start();
        }
    }


    /**
     * End a block
     *
     * @throws Exception If there is no open block
     */
    public function endblock()
    {
        // Check for open blocks
        if (empty($this->arrBlockNames))
        {
            throw new Exception('You must start a block before you can end it');
        }

        // Get the block name
        $name = array_pop($this->arrBlockNames);

        // Root template
        if ($this->strParent === null)
        {
            // Handle nested blocks
            if ($this->arrBlocks[$name] != '[[TL_PARENT]]')
            {
                // Output everything after the first TL_PARENT tag
                if (strpos($this->arrBlocks[$name], '[[TL_PARENT]]') !== false)
                {
                    list(, $content) = explode('[[TL_PARENT]]', $this->arrBlocks[$name], 2);
                    echo $content;
                }

                // Remove the overwritten content
                else
                {
                    ob_end_clean();
                }
            }
        }

        // Child template
        else
        {
            // Capture the block content
            $this->arrBlocks[$name][] = ob_get_contents();
            ob_end_clean();

            // Start a new output buffer
            ob_start();
        }
    }


    /**
     * Insert a template
     *
     * @param string $name The template name
     * @param array  $data An optional data array
     */
    public function insert($name, array $data=null)
    {
        if ($this instanceof Template)
        {
            $tpl = new static($name);
        }
        elseif (TL_MODE == 'BE')
        {
            $tpl = new BackendTemplate($name);
        }
        else
        {
            $tpl = new FrontendTemplate($name);
        }

        if ($data !== null)
        {
            $tpl->setData($data);
        }

        echo $tpl->parse();
    }
}