Хабрахабр / Комментарии к посту «Наследование шаблонов в Smarty» в блоге «PHP»

25.06.2010 14:08:58 col

col — Fri, 25 Jun 2010 14:08:58 GMT

Попробовал, понравилось.
Всё было хорошо пока не включил кэширование в Smarty.
Наследование тут же отвалилось, пробую понять что к чему, но изнутри Samarty знаю плохо.

Сталкивались с подобным?

15.06.2010 12:12:47 kid

kid — Tue, 15 Jun 2010 12:12:47 GMT

Вариант решения проблемы с output фильтрами:

0. Добавляете в свой унаследованный класс smarty поле is_page
public $is_page = false;

1. создаёте smarty-функцию {eop}
/**
* End Of Page
* @return
* @param object $params
* @param object $smarty
*/
function smarty_function_eop($params, &$smarty)
{
$smarty->is_page = true;
}

2. В конце главного шаблона вызываете функцию:

{eop}

3. В самом начале output фильтра проверяете, а не конец ли страницы
function smarty_outputfilter_head($tpl_output, &$smarty)
{
if (!$smarty->is_page)
return $tpl_output;
…
}

4. Правите smarty_block_extends:
function smarty_block_extends($params, $content, $smarty, $repeat)
{
/** Никому не доверяйте. Даже себе! */
if (false === array_key_exists('template', $params)) {
$smarty->trigger_error('Укажите шаблон, от которого наследуетесь!');
}

if (!$repeat)
return $smarty->fetch('pages/'.$params['template']);
}

15.06.2010 12:11:01 kid

kid — Tue, 15 Jun 2010 12:11:01 GMT

14.08.2009 22:56:13 Arsenichev

Arsenichev — Fri, 14 Aug 2009 22:56:13 GMT

Данный подход вызывает проблемы при использовании фильтров вывода, например сжатия страницы перед вызовом функции display:
$this->register_outputfilter( array(&$this, 'gz_compress') );

Проблема заключается в том что обвертываемый шаблон проходит дважды через фильтр вывода (первый раз при вызове функции $smarty->fetch($params['template']); а второй уже при выводе шаблона display()).

Решения проблемы пока не нашел :(

29.06.2009 13:05:51 crYpt

crYpt — Mon, 29 Jun 2009 13:05:51 GMT

При использовании вашего плагина для наследования шаблонов обнаружил несколько проблем:
1. базовый шаблон загружается дважды (при открывающем теге extends и при закрывающем)
2. если вставляю два наследуемых блока, а внутренний блок расширяю только для одного, то для второго будет подставлено содержимое первого вставленного блока. напрмер:

a.tpl
----
{block name=head}parent{/block}
----

b.tpl
----
{extends template="a.tpl"}
{block name="head"}child{/block}
{/extends}

{extends template="a.tpl"}{/extends}
---

при отображении b.tpl будет выведено:

child

child

Следующий код позволяет решить эту проблему:

плагины:

trigger_error('Block name is not set');
    }

    $name = $params['name'];

    if ( !$smarty->isBlockSet($name) && !is_null($content) )
    {
        $smarty->setBlock($name, $content);
    }

    if ( !is_null($content) )
    {
        return $smarty->getBlock($name);
    }
}

?>

trigger_error('Plese set extending template name!');
    }
    
    // if open tag
    if ( is_null($content) )
    {
        $smarty->openBlocksScope();
    }
    else
    {
        $content = $smarty->fetch($params['template']);
        $smarty->closeBlocksScope();
        return $content;
    }
    return '';
}

?>

поля и методы класса SmartyX (extends Smarty)


    protected $_blocks = array(array());
    protected $_blocksScope = 0;

...

    public function openBlocksScope()
    {
        $this->_blocksScope++;
        $this->_blocks[$this->_blocksScope] = array();
    }
    
    public function closeBlocksScope()
    {
        if ( $this->_blocksScope > 0 )
        {
            $this->_blocks[$this->_blocksScope] = array();
            $this->_blocksScope--;
        }
    }
    
    public function isBlockSet($key)
    {
        return array_key_exists($key, $this->_blocks[$this->_blocksScope]) !== false;
    }

    public function setBlock($key, $value)
    {
        $this->_blocks[$this->_blocksScope][$key] = $value;
    }

    public function getBlock($key)
    {
        if (array_key_exists($key, $this->_blocks[$this->_blocksScope]))
        {
            return $this->_blocks[$this->_blocksScope][$key];
        }
        return '';
    }

29.06.2009 12:54:41 crYpt

crYpt — Mon, 29 Jun 2009 12:54:41 GMT

10.01.2009 16:22:38 K1N6

K1N6 — Sat, 10 Jan 2009 16:22:38 GMT

$this->_blocks[$key][count($this->_blocks[$key])-1]
лучше заменить на
end($this->_blocks[$key])
наверное

09.12.2008 23:50:00 roller

roller — Tue, 09 Dec 2008 23:50:00 GMT

ну в том же ZF вроде как можно из шаблона вызывать другие контроллеры (а не тот который отрабатывается сейчас). И основной контроллер совершенно не обязан о них думать. В шаблон добавляем $this->action() и понеслась

03.12.2008 08:53:56 lexabug

lexabug — Wed, 03 Dec 2008 08:53:56 GMT

нашел еще пару интересных особенностей этого решения.
Приведу реальный пример из своей практики.

У меня есть класс Application. Он хранит сообщения об ошибках (например неправильно заполнена форма) во внутреннем массиве $_messages. Сообщения добавляются в массив следующим методом:

    public function addMessage($text, $type = 'Error') {
        if (empty($text)) return true;
        
        if (empty($type))
        $type = 'Error';
        $this->_messages[$type][] = $text;
        return true;
    }

А извлекаются следующим методом:

    public function getMessages($type = 'Error') {
        if (empty($type)) {
            $type = 'Error';
        }
        $aMessages = isset($this->_messages[$type]) ? $this->_messages[$type] : false;
        $this->_messages[$type] = null;
        return $aMessages;

    }

А выводятся эти сообщения в шаблоне _errors.tpl, который инклудится в основном шаблоне layout.tpl, таким вот образом:

{assign var="aFailureMessages" value=$Application->getMessages('Error')}
{assign var="aSuccessfulMessages" value=$Application->getMessages('Success')}
{assign var="aInformativeMessages" value=$Application->getMessages('Informative')}

{if $aFailureMessages || $aSuccessfulMessages || $aInformativeMessages}
    
        {if $aFailureMessages}
        
        {/if}

        {if $aSuccessfulMessages}
        
        {/if}

        {if $aInformativeMessages}
        
        {/if}
    
            
                {section name=failure loop=$aFailureMessages}
                    {$aFailureMessages[failure]}
                {/section}
            
        
         

            
                {section name=success loop=$aSuccessfulMessages}
                    {$aSuccessfulMessages[success]}
                {/section}
            
        
         

            
                {section name=informative loop=$aInformativeMessages}
                    {$aInformativeMessages[informative]}
                {/section}
            
        
         
{/if}

Т.е. логика работы этого механизма такова, что если сообщение было выведено для просмотра значит его уже не нужно выводить.

Но каково было мое удивление, когда применяя приведенный здесь механизм наследования шаблонов, я не увидел ни единого сообщения, добавленного в Application.

В ходе отладки выяснилось, что метод getMessage вызывается по 2 раза на каждый тип сообщений, т.е. шаблон рендерится дважды!!!
Если посмотреть документацию smarty по блоковым функциям, коими являются smarty_block_extends и smarty_block_block, то они вызываются по два раза, при открытии и закрытии соответствующих тегов smarty {extends} и {block}.

В случае с smarty_block_extends дважды вызовется метод $smarty->fetch!!! вот тут собака и порылась. Таким образом, родительский шаблон рендерится дважды. Но это не оптимально — раз, и приводит к печальному результату с моими сообщениями — два.

Чтобы этого избежать, нужно рендерить родительский шаблон всего лишь один раз, когда у нас имеются данные для подстановки в теги {block}, когда был обработан шаблон-потомок, а именно во время второго вызова smarty_block_extends.

Внутри функции smarty_block_extends ставим проверку вида:

    if (!is_null($content)) {
        return $smarty->fetch($params['template'], ...);
    }
    return false;

Казалось бы, проблема решена, но! Во время переназначения содержимого блоков в таком случае данные push'атся в обратном порядке, т.е. содержимое блока из шаблона-наследника будет не на ВЕРШИНЕ стека, а на его ДНЕ. Т.е при получении содержимого блока при помощи метода getBlock, мы получим значение блока из родительского шаблона.

Решение: заменить в методе setBlock

array_push($this->_blocks[$key], $value);

на

array_unshift($this->_blocks[$key], $value);

30.11.2008 09:37:13 developer

developer — Sun, 30 Nov 2008 09:37:13 GMT

решение проблеммы {$item->getColorById(1)->getSizeById(2)->name}
для смарти здесь:
habrahabr.ru/blogs/php/45651/#comment_1159897

12.09.2008 13:31:55 BasilSnowman

BasilSnowman — Fri, 12 Sep 2008 13:31:55 GMT

извиняюсь, что вторгаюсь в беседу, но уж очень любопытно глянуть на исправленную версию Smarty…

28.08.2008 21:33:20 faeton

faeton — Thu, 28 Aug 2008 21:33:20 GMT

Подробнее-подробнее!

26.08.2008 19:46:15 tenshi

tenshi — Tue, 26 Aug 2008 19:46:15 GMT

xslt. и не только на пхп…

26.08.2008 14:13:09 sEXEcutor

sEXEcutor — Tue, 26 Aug 2008 14:13:09 GMT

Это не наследование, как вы это понимаете, а немного другой метод подстановки — контейнер, когда любой кусок кода может быть обернут в другой шаблон.

А простой пример залупления :) — если вы напишете в файле index.tpl:
{include file=«index.tpl»}

В плагине наследования/контейнера может быть так, что в каком-то из родительских шаблонов обрабатывается снова какой-то из подшаблонов. Например, если в вашем parent.tpl написать:

{extends template=«child.tpl»}bla-bla-bla{/extends}

всё закончится очень печально. Цепочка подключений может быть длиннее, что затруднит поиск повторного инклуда. Ситуация смоделированная, но вполне реальная в условиях по-другому спроектированной обширной системы.

26.08.2008 14:08:14 develop7

develop7 — Tue, 26 Aug 2008 14:08:14 GMT

Разве только в виде патча. И то, интерес чисто академический, т.к. Smarty не пользую уже давно. И, если всё будет хорошо, не буду и в дальнейшем.

26.08.2008 14:01:58 marazmiki

marazmiki — Tue, 26 Aug 2008 14:01:58 GMT

Хотите увидеть эту приватную версию? :))

26.08.2008 14:00:51 marazmiki

marazmiki — Tue, 26 Aug 2008 14:00:51 GMT

Да, нужно исправить одно регулярное выражение для разыменования объектов и методов и второе — для доступа к публичным свойствам класса. Если интересно, ближе к вечеру выложу

26.08.2008 13:31:20 develop7

develop7 — Tue, 26 Aug 2008 13:31:20 GMT

А мои бывшие коллеги до сих пор его используют. Изобретая чудовищные костыли для обхода вот таких вот недоработок.
Хотя ходят слухи, что где-то существует приватная версия смарти, которая позволяет вызывать методы объектов цепочкой… ;)

26.08.2008 13:27:16 vitali

vitali — Tue, 26 Aug 2008 13:27:16 GMT

подскажите?
знаю только что нужно регекспы патчить, но они там такие, что чёрт ногу сломит…

26.08.2008 13:20:25 marazmiki

marazmiki — Tue, 26 Aug 2008 13:20:25 GMT

Это элементарно исправляется.

26.08.2008 13:14:51 vitali

vitali — Tue, 26 Aug 2008 13:14:51 GMT

Я отказался от смарти когда стал использовать больше ООП.
ведь конструкция типа
{$item->getColorById(1)->getSizeById(2)->name}
не работала :-(

26.08.2008 11:49:03 svetko

svetko — Tue, 26 Aug 2008 11:49:03 GMT

эм… а если для страницы нужен не один child?

26.08.2008 11:06:40 akzhan

akzhan — Tue, 26 Aug 2008 11:06:40 GMT

хранить кэши блоков и страниц можно и не в файловой системе.

правда, обычно это делается не на уровне шаблонизатора.

например, для Drupal есть модуль cache router, который позволяет распределять кэшируемые объекты по разным хранилищам (файловая система, БД, memcached.

26.08.2008 10:39:27 marazmiki

marazmiki — Tue, 26 Aug 2008 10:39:27 GMT

Про «не пригодится» не соглашусь.

Жёсткой необходимости нет почти ни в чём. Можно ведь и не заморачиваться на ООП в целом и Смарти в частности, а просто писать код линейно и потоком, не заморачиваясь на такие мелочи, как разделение логик приложения и отображения :). Вопрос в том, насколько потом ЭТО будет легко поддерживаться.

То же самое и с шаблонами. Я уже на собственном опыте убедился, что подобный подход проще в дальнейшем расширении. Особенно актуально для создания новых шаблонов на основе уже существующих :)

26.08.2008 10:32:37 Urevic

Urevic — Tue, 26 Aug 2008 10:32:37 GMT

Такими темпами функциональность smarty доведут до уровня самого php и таки напишут шаблонизатор на шаблонизаторе, написанном на языке, который сам в свою очередь изначально был шаблонизатором. Прямо дух захватывает от такой многоуровневости ;)

26.08.2008 10:27:09 marazmiki

marazmiki — Tue, 26 Aug 2008 10:27:09 GMT

Если честно, не совсем понял, где в Вашем случае наследование… Расскажите поподробнее, пожалуйста.

А насчёт «ЗЫ»: что такое за*loop*ленные включения шаблонов? Если это просто инклюд шаблона внутри {loop}{/loop} или {foreach}{/foreach}, то, как мне кажется, проблем возникнуть не должно. Если ошибся — поправьте. Желательно с примерами :)

26.08.2008 10:22:00 marazmiki

marazmiki — Tue, 26 Aug 2008 10:22:00 GMT

Если честно, я боялся этого вопроса и вероломно о нём умолчал. С другой стороны приятно, что я заставил кого-то задуматься :)

Дело тут в том, что если эту проверку убрать, то в массив будет дампаться всё дерево наследования. И последним элементом, разумеется, будет «корень». Если непонятно, просто сделайте var_dump($template), увидите, что я имею в виду.

Я пошёл на это ограничение, исходя именно из тех соображений, что случаи, когда «внук» будет точно таким же, как его «дедушка», довольно редки и ими можно пренебречь :)

26.08.2008 10:03:14 DeadMoroz

DeadMoroz — Tue, 26 Aug 2008 10:03:14 GMT

А чем хуже вынести содержимое блока, который нужно подменить во внешний файл (в несколько внешних файлов) и в зависимости от параметров эти файлы подключать? Получится композиция вместо наследования, что по сути есть более гибкое решение.

26.08.2008 09:58:05 fxposter

fxposter — Tue, 26 Aug 2008 09:58:05 GMT

А вообще — спасибо за статью, коротко и ясно. Мне этого, честно говоря, не хватало! :)

26.08.2008 09:57:35 fxposter

fxposter — Tue, 26 Aug 2008 09:57:35 GMT

Мдя… И что делать если я не дописал комментарий, он вставился непонятно с какой радости, да еще и при попытке его дописать — хабрахабр опять его вставил… :(

26.08.2008 09:54:44 fxposter

fxposter — Tue, 26 Aug 2008 09:54:44 GMT

if (in_array($value, $this->_blocks[$key]) === false) { array_push($this->_blocks[$key], $value); }

Вот этот момент, по-моему, лишний. Если я присвоил блоку значение, потом его переопределил, а потом хочу переопределить на предыдущее (хоть я этого, наверное, ни разу и не делал), то я хочу всё же получить последнее переопределенное значение. А так получается, что я могу написать:

{block name=«foo»}It's a parent{/block}

{extends template=«parent.tpl»}
{block name=«foo»}It's a child{/block}
{/extends}

{extends template=«parent.tpl»}
{block name=«foo»}It's a child{/block}
{/extends}

26.08.2008 09:53:54 fxposter

fxposter — Tue, 26 Aug 2008 09:53:54 GMT

if (in_array($value, $this->_blocks[$key]) === false) {
            array_push($this->_blocks[$key], $value);
        }

Вот этот момент, по-моему, лишний. Если я присвоил блоку значение, потом его переопределил, а потом хочу переопределить на предыдущее (хоть я этого, наверное, ни разу и не делал), то я хочу всё же получить последнее переопределенное значение. А так получается, что я могу написать:

parent.tpl:

Inherit it!

Just a paragraph
{block name=«foo»}It's a parent{/block}

{extends template=«parent.tpl»}
{block name=«foo»}It's a child{/block}
{/extends}

26.08.2008 09:53:46 akira

akira — Tue, 26 Aug 2008 09:53:46 GMT

Спасибо.

26.08.2008 09:52:10 dasbot

dasbot — Tue, 26 Aug 2008 09:52:10 GMT

он есть в посте. Там два файла parent.tpl и child.tpl в случае инклуда вам бы понадобились хидер и футер, вместо парента. Добавьте еще блок и вам понадобится хидер, футер и миддлер (гыгы).

26.08.2008 09:47:40 sEXEcutor

sEXEcutor — Tue, 26 Aug 2008 09:47:40 GMT

Похожая штука у меня называется «контейнерами» и обычно выглядит так:

{container name=«layout.tpl»}
Something here…
{/container}

В layout.tpl вложенный код вставляется тэгом {$_output}

ЗЫ Не забудьте написать обработку за*loop*ленных включений шаблонов ;)

26.08.2008 09:43:57 akira

akira — Tue, 26 Aug 2008 09:43:57 GMT

был бы благодарен примером :)

26.08.2008 09:41:19 dasbot

dasbot — Tue, 26 Aug 2008 09:41:19 GMT

Ну, честно говоря, никогда не сталкивался с их жесткой необходимостью. Это интересная фишка на заметку, но зачастую она вам не пригодится. Потому она и не получила широкого распространения ;)

26.08.2008 09:39:04 dasbot

dasbot — Tue, 26 Aug 2008 09:39:04 GMT

тем, что инклуд не меняется. В случае одного блока вам понадобится два инклуда код_до и код после. В случае двух блоков, уже три итд. В случае наследования, вам всегда нужен один (если наследуемся от одного конечно).

26.08.2008 09:17:24 akira

akira — Tue, 26 Aug 2008 09:17:24 GMT

Хоть убейте меня, но я не понимаю чем это отличается от include?

26.08.2008 09:17:17 develop7

develop7 — Tue, 26 Aug 2008 09:17:17 GMT

Это же слоты, правда?