Perl (90) - Mason - speciální bloky

Perl Již víme, jak lze do Mason souborů vkládat kód Perlu pomocí speciálně označených pomocí bloků. Nyní se podíváme na některé další bloky, které přinášejí nové možnosti.

19.10.2009 01:00 | Jiří Václavík | přečteno 11073×

Komponenty Masonu jsou obyčejné HTML soubory. Obyčejné až na to, že obsahují jisté speciální úseky kódu, které jsou ještě před odesláním klientovi webového serveru zpracovány Masonem. Nyní se podrobněji podíváme na to, čím se tyto úseky vyznačují a jaký mají význam.

Inicializační blok

Blok <%init> ... </%init> je pro program něčím podobným jako konstruktor pro třídu nebo blok BEGIN pro perlový program. Jeho obsah je totiž vykonán (přesněji řečeno až na <%once> a <%shared>, ale to nás zatím nezajímá) ze všeho nejdříve. Nastavují se zde proměnné, které budou platné kdekoliv dále.

<% $file %>

<%init>
my $file = "/data.backup";
</%init>

Pokud v bloku <%init> děláme činnost, která musí být před ukončením programu zastavena, například otevírání databáze, můžeme toto zastavení provést v bloku <%cleanup>. Ten je volán po ukončení běhu programu.

Import komponent

Dalším uvedeným tagem je <& ... &>, který umožnuje import komponenty uvnitř jiné. To je praktické například tehdy, když na více stránek chceme umístit stejný prvek.

Základní použití může vypadat takto. V prvním souboru máme základní HTML strukturu dokumentu.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
    <title>Moje www stránka</title>
</head>
<body>
<& obsah &>
</body>
<html>

Import probíhá na řádku <& obsah &>. Ten bude nahrazen obsahem souboru obsah.

Součástí importu komponenty mohou být takzvané argumenty. Ty uvádíme také mezi <& a &>. Import komponenty se dvěma argumenty může vypadat takto.

<& /cesta/komponenta, argument=>"hodnota", dalsi_argument=>"dalsi_hodnota" &>

Místo pevně zadaného názvu souboru, jež má být importován, lze zadat také výraz. Jeho výsledkem musí být jméno existující komponenty.

Díky této vlastnosti bloku <& ... &> zde nastává nejednoznačnost: jak odlišit výraz od názvu komponenty? Je třeba alespoň tušit, že existují jakási parsovací pravidla, pro něž je určující první uvedený znak. Pokud je alfanumerickým znakem, podtržítkem, tečkou nebo lomítkem, jde o pevně zadaný název souboru. V opačném případě jde o výraz. Je to sice vzácný jev, ale teoreticky se může stát, že výraz bude začínat jedním z výše uvedených znaků. V takovém případě je nejjednodušším řešením výrazu předřadit znaménko + nebo ho uzavřít do závorek.

Argumenty

Komponenta může přijímat argumenty a to hned několika způsoby. Již jsme si ukázali předávání argumentů při importu komponenty. Lze je také předávat jako součást požadavků POST a GET.

K zpracování argumentů uvnitř komponenty slouží blok <%args> ... </%args>. Do něj umístíme proměnné, které mají být hodnotami argumentů inicializovány.

Rozlišujeme povinné a nepovinné argumenty. Těm nepovinným nastavujeme defaultní hodnotu. Argument bez nastavené implicitní hodnoty ji bude vyžadovat.

Každý argument umístíme na jeden řádek a pomocí operátoru => mu případně definujeme implicitní hodnotu, která může být vyjádřena i výrazem.

<%args>
   $scalar
   $default  => 20
   $default2 => $scalar-1000
   @pole
   %hash => (jmeno=>"anonym", heslo=>"gu1E-2")
</%args>

Definovali jsme 5 argumentů, z nichž jsou @pole a $scalar povinné. Ostatním nastavujeme implicitní hodnotu.

Zdánlivě se může kód uvnitř <%args> ... </%args> může zdát jako kód Perlu, ale tak tomu není. Nepoužívají se středníky a prostředky jazyka jsou také maximálně omezené.

Zmatek občas může nastat tehdy, pokud v bloku <%args> inicializujeme více než jednu proměnnou stejného názvu - tedy například $arg, @arg a %arg. Blok <%args> bude vypadat takto.

<%args>
   $arg
   @arg
   %arg
</%args>

Jak se nám naplní příslušné proměnné? K tomu, abychom to zjistili, využijeme modul Data::Dumper.

Předáme-li skalární argument, program vyvolá chybu. $arg bude obsahovat příslušnou hodnotu, totéž první prvek pole @arg, ale u konverze na hash nastane chyba. Není zde možné konvertovat skalár na hash.

Nyní zavoláme komponentu se seznamovým argumentem: komponenta?arg=7&arg=9&arg=11. $arg bude ukazatelem na pole, které obsahuje prvky 7, 9 a 11 - tedy vlastně na pole @arg. Hash ale nelze vytvořit z lichého počtu argumentů.

Předáme-li sudý počet argumentů, bude to stejné jako v minulém případě, ale navíc se v pořádku naplní klíče a prvky hashe. Skalár, pole i hash budou zpřístupňovat vždy tatéž data, pouze vždy trochu jinak.

Další možností, jak získat předané argumenty, je proměnná %ARGS. Sem se zkopírují všechny předané hodnoty ve formátu klíč=>hodnota. Mnohy je výhodnější užít tento způsob získávání argumentů než blok <%args>. Přispívá k tomu i fakt, že název proměnné nemůže být libovolným řetězcem, ale hashový klíč ano.

Další bloky

Toto byly ty úplně nejzákladnější bloky, jež jsou pro používání Masonu bezpodmínečně nezbytné. Ale zdaleka to nejsou všechny. Pojďme si alespoň stručně představit ještě některé další.

Do bloku <%text> lze umístit libovlný text, který nemá být nijak formátován.

Blok <%doc> je určen pro generování dokumentace a překladač ho ignoruje.

Blok <filter> ... </%filter> se spouští mezi během a odesláním stránky. V něm ještě naposledy můžeme upravit výslednou stránku. Generovaný výstup máme v bloku < %filter> umístěn ve výchozí proměnné. Tu můžeme modifikovat. Tento příklad cenzuruje ze stránky slovo obsah.

<%filter>
s/obsah//;
</%filter>

<& header &>
<h1>Vítejte<h1>
<p>Toto je obsah stránky<p>
<& footer &>

Později se setkáme ještě s několika dalšími bloky.

Online verze článku: http://www.linuxsoft.cz/article.php?id_article=1651