Šablony

Školení, která pořádám

U větších projektů je k nezaplacení mít důsledně oddělenou aplikační vrstvu aplikace od té prezentační. Pro nás jako programátory by mělo být cílem, abychom mohli grafikovi nebo HTML kodérovi svěřit část projektu bez obavy, že nám zmrší kód, a naopak aby nás grafik nemusel žádat o spolupráci kvůli jakékoliv změně, které se týká prezentace dat.

Řešením tohoto úkolu by mohlo být XSLT – programátor vygeneruje v podstatě libovolné XML a grafik si ho převede jak chce pomocí XSLT. Problém je v tom, že většina HTML kodérů XSLT neumí a učit se ho nechtějí, protože jim to příliš připomíná programování. Proto se spíše používá řešení založené na rozličných šablonovacích systémech. To funguje tak, že programátor v kódu jenom naplní PHP proměnné, grafik vytvoří šablonu, která tyto proměnné využívá, a šablonovací systém to celé poskládá dohromady.

Další velkou výhodou šablonovacích systémů je to, že pokud neřeknete jinak, tak jsou všechna vypisovaná data automaticky escapovaná, takže nehrozí nebezpečí XSS.

Jeden z nejoblíbenějších šablonovacích systémů je Smarty. Já osobně ho moc rád nemám, protože podle mě dává grafikovi do ruky až moc silnou zbraň. Oblíbil jsem si proto spíše HTMLTmpl, který podle mě umožňuje přesně to, co by umožňovat měl – nic míň a hlavně nic víc. V Česku je oblíbený také Teng původně vyvinutý Seznamem.

<?php
require "htmltmpl.php";
$manager = new TemplateManager();
$template = $manager->prepare("template.tmpl");
$tproc = new TemplateProcessor();

$tabulka = array();
$result = mysql_query("SELECT id, nazev FROM tabulka");
while ($row = mysql_fetch_assoc($result)) {
    $tabulka[] = $row;
}
mysql_free_result($result);
$tproc->set("tabulka", $tabulka);

echo $tproc->process($template);
?>

Soubor template.tmpl je potom běžný HTML soubor doplněný speciálními značkami. Proměnná $tabulka by se zpracovala např. takto:

<TMPL_LOOP tabulka>
	<li><a href="?id=<TMPL_VAR id>"><TMPL_VAR nazev></a></li>
</TMPL_LOOP>

HTMLTmpl jsem si předělal tak, že do cache ukládá přímo nativní PHP kód. Upravenou verzi lze stáhnout ze SourceForge.

U svých soukromých projektů šablony obvykle nepoužívám, je s tím přeci jen trochu práce navíc – musí se vytvořit víc souborů a musí se správně poslepovat. U projektů, na kterých pracuje víc lidí nebo u kterých se do budoucna počítá se změnou designu bez potřeby měnit i PHP kód, jsou naopak šablony ten pravý nástroj.

Pokud vám žádný šablonovací systém nevyhovuje a máte nutkavou potřebu si napsat vlastní, vyjděte prosím alespoň ze syntaxe některého stávajícího.

Jakub Vrána, Seznámení s oblastí, 18.5.2005, diskuse: 67 (nové: 0)

Diskuse

xfish5:

Nebo se to dá řešit jen pomocí regulérních výrazů + nějaké funkce pro nahrazování v textu(str_replace(),...). Nebo to potom celé zabalit do třídy... Já to mám <%posledniKomentare(2)%> a pak to pomocí reg. výrarů a té funkce nahradím...:-)

18.5.2005 07:04:46

Llaik:

No osobne si myslim, ze veci jako podminky ci treba modifikatory by mel do ruky dostat HTML koder a ne programator. Napriklad omezeni delky textu napr. pro title obrazku preci neni zalezitost pro aplikacni cast aplikace (ta ma title nacist treba z db), ale pro prezencni cast (zobrazim to cele, nebo jen prvnich 20 znaku?)

Jinak Smarty ma ohromnou vyhodu, kterou skoro nikde nevidim zminenou - sablony kompiluje do phpka. Tj. Pokud mate 10 volani stranky za vterinu, tak Smarty nedela jako jine "tupe" sablonove systemy to, ze by 10x nacetl stranku z disku, pomoci regularnich vyrazu ji parsoval a zobrzil. Udela to jen jednou a zkompilovanou verzi ulozi jako php, ktere pri dalsich volanich jen includuje.

Jinak samozrejme nejlepsi (co do vykonu) ze zminovanych je nutne Teng - je to modul pro Apache (coz mimojine znamena, ze pokud nemate ochotnou podporu na webhostingu, pripadne nemate svuj, zrejme si ho neuzijete)

Jinak se sablonami neni vice prace. Aplikacni i prezencni cast musite udelat tak jako tak, takze v cem je to "vice prace"? V tom, ze to ulozite do dvou souboru, misto do jednoho? Videl bych spise paraleru s tim "xhtml nepisu, je to pomalejsi nez html" :)

18.5.2005 09:19:28

Zdeněk Merta:

No nemyslím si, že HTML kodér by měl mít možnost omezovat třeba délku textu, ...

Pokud programuješ objektově, tak se tohle dá řešit obdobou Helper tříd v Jave. Jinak speciální šablonovací systém nepoužívám - vystačím si s PHP

př.

<?php
class Article {
var $title;
var $body;

// get, set metody
...
}

class ArticleHelper {
var $article;

function &ArticleHelper(&$article)
{
$this->article =& $article;
}

function getTitle()
{
// omezeni delky titulku na 50 znaku
return TextUtils::limitText($this->article->getTitle(), 50);
}

function getBody()
{
return $this->article->getBody();
}
}
?>

Nedefinovaná třída TextUtils obsahuje metody pro práci s textem.

Vytvořený Helper pak jen předám do HTML šablony a v ní volám jeho metody.
Helperů samořejmě existuje více, např. pro seznam článků v rubrice, pro zobrazení článku, ...

18.5.2005 09:31:30

dgx:

ono jde o to, že pokud rozdělíme aplikaci na aplikační a prezentační logiku, že by v tom prezentování "nějaká logika" měla být. A pouhé zobrazení proměnných přecijen logika není.

Vidím docela rozdíl v ořezání proměnné v aplikační a prezentační části aplikace. V tom prvním případě by neměla být motivací snaha, aby se titulek kamsi vtěsnal, ale nějaký prezentačně-nezávislý důvod.

18.5.2005 12:36:09

Jan Bien:

ad dgx: Přesně tak, i do prezentační vrstvy patří logika a jde jen o vedoucího projektu, aby zajistil správné oddělení toho, co je ještě věc aplikace a co již prezentace.

Jinak nezapomínejme, prosím, na to, že samotný PHP jazyk je svým původem jazyk šablonový. Pokud se určí přísná pravidla, co v šablonách HTML designer použít smí a co ne, tak je použití PHP pro šablony v PHP aplikacích dobré i výkonné řešení a není třeba zavádět žádný další "pseudojazyk".

Zmíněný teng IMHO nachází uplatnění spíše v nePHP aplikacích (C++, ...) které vůbec možností šablon neoplývají. Krom toho má teng tu výhodu, že jde o jednotný šablonový systém pro více jazykových platforem -- to může být dostatečný důvod i pro použití v PHP aplikacích.

Ale nejsem vývojář, takže někde možná trochu zavádím.

18.5.2005 15:09:36

Zdeněk Merta:

Jen je potřeba ta přísná pravidla kontrolovat.
Nevýhodou použití PHP jako šablonovacího systému je možnost vyvolat jakýkoliv příkaz PHP. Dá se to sice různými způsoby omezit, ale bude to na úkor rychlosti.

18.5.2005 16:23:13

Jan Bien:

To je fakt. Pokud nedokáži udržet disciplinovanost HTML kodérů, tak asi nezbude nic jiného, než přistoupit k nějakému jinému systému šablon.

18.5.2005 19:00:51

Zdeněk Merta:

Problém je, pokud je to v rámci nějaké firmy, která nedělá pouze v PHP, ale i v jiných jazycích. Tam se hodí TENG, který má ale nevýhodu v nutnosti zakompilování do webového serveru.
Cesta by možná mohla vést tudy: http://www.kuwata-lab.com/kwartz/
Zatím jsem se na to moc nedíval, ale na první pohled to vypadá zajímavě.

18.5.2005 19:12:47

Zdeněk Merta:

Máš naprostou pravdu, v prezentační vrstvě se logice vyhnout nedá, ale je potřeba důsledně rozlišovat aplikační a prezentační logiku.

Můj příklad je samozřejmě prezentační logika, čili ořezání je naprosto správné.
Používam návrhový vzor MVC a Helper se vytváří až ve View. Pak se předává šablonovacímu systému a v šabloně se používají už pouze metody helperu a samozřejmě základní jazykové konstrukce PHP jako cykly a podmínky.

Výhoda je v tom, že HTML kodérovi ke každému View přibalím vygenerovanou API dokumentaci k Helperu a hned je mu jasné, jaké metody může použít.
Čili naučí se pouze základní jazykové konstrukce PHP a používání Helperu.

(reakce na) 18.5.2005 16:20:50

dgx:

když už jste nakousl MVC, dovolím si jeden OT dotaz, snad mi Jakub odpustí :-) Používáte vlastní framework + šablony nebo některý opensource systém?

18.5.2005 16:54:42

Zdeněk Merta:

Používám Mojavi http://www.mojavi.org/
Doposud upravenou verzi 2, teď se chystám trošku se seznámit s verzí 3, která je už pouze pro PHP 5.

Speciální šablonový systém nepoužívám, jen PHP s tím rozdílem, že se to tváří jako obvyklý šablonovací systém. Čili data do šablony se předávají pomocí metod šablonovací třídy a v HTML jsou pak dostupná přes proměnnou $template. Tenhle systém jsem používal už dříve a v Mojavi je to výchozí systém šablon. Je ale možné si dodělat podporu pro další systémy. Např. pro Smarty a PatTemplates už myslím existují.

18.5.2005 17:05:07

llook:

Pomalu se také přikláním k používání PHP pro šablony. Prostě místo {$name} napíšu <?=$name?> (připomínám, že short_open_tag lze nastavit i na úrovni adresáře)

Nedávno jsem pomocí "pure Smarty" (tj. nešahal jsem na obsluhující skripty) řešil výpis stromové struktury, šlo o komentáře na blogu. Většinou se to řeší jako tady nebo na Intervalu - jednoúrovňová struktura, kde jsou zanořenější prvky více odsazené, ale já chtěl vnořené seznamy. Nakonec se mi to snad podařilo, ale nechtějte vidět zdroják tý šablony ;)

Zajímavá obhajoba PHP jako TE je taky tady, od autora bTemplate (anglicky): http://massassi.com/php/articles/template_engines/

Ad Teng: Používá to někdo kromě Seznamu? To by mě fakt zajímalo, protože všude čtu doporučení a nikde zkušenosti.

18.5.2005 23:22:03

Zdeněk Merta:

short_open_tag bych se radši vyvaroval, pokud bys souběžně používal XML, tak se dostaneš do problémů.

Od používání šablon mě odradily diskuze na SitePointu a ten článek, co odkazuješ. PHP šablony mají snad jen samé výhody až na zmiňované zneužití funkcí PHP HML kodérem. Ale není problém si napsat skript, který projde všechny adresáře se šablonami a zkontroluje používání nevhodných příkazů.

Celkem se mi líbil šablonový systém, co jsme používali ve firmě, který používal speciální XML tagy a parsování šablon používalo SAX parser. Implementováno bylo spoustu vychytávek, jako různé barvy sudých a lichých řádků a mnoho dalších.
Jen jsem se nikdy neodvážil měřit jeho rychlost, protože by to asi nebylo nic moc, ale ve spolupráci s cacheováním výsledků to bylo celkem použitelné.

19.5.2005 00:11:18

llook:

Všechny XML deklarace v PHP skriptech jsem si zvykl zapisovat takhle: <<?php ?>?xml version="1.0"?>
Je mnohem pohodlnější psát <?='něco'?> než <?php echo 'něco'?> i za tu cenu, že si musím dát pozor na XML deklarace.

19.5.2005 01:24:05

DaMage:

a prečo rovno neoddeliť XHTML od akehokoľvek formatovania a vysledok formatovať pomocou CSS...
jediná potrebná vec je aby vystupný dokument mal dobrú štruktúru zbavenú akehokoľvek formatovania (okrem atributu class). Dobrou ukážkou je http://www.csszengarden.com

Šablony

Školení, která pořádám

Diskuse

xfish5:

Llaik:

Zdeněk Merta:

dgx:

Jan Bien:

Zdeněk Merta:

Jan Bien:

Zdeněk Merta:

Zdeněk Merta:

dgx:

Zdeněk Merta:

llook:

Zdeněk Merta:

llook:

DaMage:

Jakub Vrána :

DaMage:

tark:

PHX:

lama:

Jakub Vrána :

@ss@ssIn:

Jakub Vrána :

@ss@ssIn:

scippio:

Tom@sQo:

Saell:

Jakub Vrána :

max@lera:

spaze:

spaze:

Jakub Vrána :

spaze:

Hořec:

RATMex B:

Jakub Vrána :

RATMex B:

Jakub Vrána :

Techi:

Elvard:

Motyl23:

Jakub Vrána :

Norn:

Jakub Vrána :

Norn:

Ján Koštial:

Jakub Vrána :

Ján Koštial:

Jakub Vrána :

Martin Vlasak:

Jakub Vrána :

Martin Vlasak:

Jakub Vrána :

hannes:

Jakuje:

S.:

Jan Kahoun:

Jan Kahoun:

Jan Kahoun:

Jakub Vrána :

Jan Kahoun:

PetrX:

Jakub Vrána :

Zemistr:

Zemistr:

Honza Hučín:

Richard Šimek:

Navigace

PHP triky

Kupte si mou knihu

Reklama

Web běží na serveru

Články podle skupin

Výběr článků

Nejnovější články

Normy a manuály

Další projekty