PHP/Open Power Template

Z Wikibooks, biblioteki wolnych podręczników.
< PHP
Przejdź do nawigacji Przejdź do wyszukiwania
Poprzedni rozdział: Savant
Spis treści
Następny rozdział: PHPTAL

Open Power Template[edytuj]

Omówiony w poprzednim rozdziale Savant to doskonały przykład biblioteki wykorzystującej PHP jako język szablonów. W Open Power Template sytuacja odwraca się o 180 stopni. Ten system udostępnia swój własny, XML-owy język, którego cechą szczególną jest deklaratywne podejście do tworzenia szablonów. Zamiast skupiać się na szczegółach implementacyjnych, twórca szablonu powinien jedynie powiedzieć, co chce osiągnąć i zlecić kompilatorowi wygenerowanie odpowiedniego kodu, który spełni jego życzenia. Pomaga w tym rozumienie struktury HTML szablonu oraz unikalna cecha, tzw. formaty danych. Aby nie być gołosłownym, zaprezentujemy poniżej przykładowy szablon:

 1 <?xml version="1.0" ?>
 2 <opt:root>
 3 <opt:prolog />
 4 <opt:dtd template="html5" />
 5 <html>
 6  <head>
 7   <title>{$pageTitle}</title>
 8  </head>
 9  <body>
10   <p>Polecamy nasze produkty:</p>
11   <ul>
12    <li opt:section="products"><a parse:href="$products.url">{$products.name}</a></li>
13   </ul>
14  </body>
15 </html>
16 </opt:root>

Oprócz tego, Open Power Template udostępnia obiektowy interfejs programistyczny dla PHP 5.2/5.3 dostosowany do potrzeb integracji z popularnymi frameworkami, które niebawem poznamy. Do naszej dyspozycji są trzy najważniejsze elementy interfejsu:

  1. Opt_Class - główna klasa zarządzająca konfiguracją.
  2. Opt_View - klasa reprezentująca tzw. widok, czyli określony szablon i towarzyszące mu dane ze skryptu:
  3. Opt_Output_Interface - interfejs systemu wyjścia, który mówi, gdzie wysłać wygenerowany kod.

Podobnie jak w naszym prostym systemie edukacyjnym, nasza aplikacja WWW tworzy sobie odpowiednią liczbą widoków i przekazuje do nich dane. Jednak zamiast wykonywać je od razu, przekazuje je do jednego z systemów wyjścia, który zajmuje się wykonaniem szablonu i wysłaniem wyniku w określone miejsce. Przykładowo, jeśli skorzystamy z systemu wyjścia Opt_Output_Http, dane polecą do przeglądarki, a oprócz tego możemy też stworzyć sobie system wyjścia Email, który podany szablon potraktuje jako np. treść wiadomości e-mail, którą trzeba wysłać pod określony adres.

Instalacja[edytuj]

Bibliotekę można pobrać ze strony www.invenzzia.org - pobieramy najnowsze wydanie z gałęzi 2.0.x, które jest omówione w tym podręczniku. W ściągniętym archiwum znajdziemy katalog /lib z właściwym kodem źródłowym biblioteki. Pozostałe katalogi to przykłady, dokumentacja oraz testy. Przenosimy wspomniany katalog gdzieś do drzewa katalogowego naszej aplikacji WWW.

Druga czynność to stworzenie folderów na szablony. Pierwszy z nich nazwijmy /templates - będą tam źródłowe wersje szablonów. W drugim, /templates_c Open Power Template będzie zapisywać skompilowane wersje, dlatego upewnijmy się, że PHP posiada do niego prawa zapisu.

Open Power Template jest częścią większej rodziny bibliotek Open Power Libs, dla których potrzeb opracowane zostało wspólne mikrojądro oferujące m.in. automatyczną ładowarkę czy system obsługi błędów. Znajdziemy je w katalogu /lib/Opl, podczas gdy właściwy kod systemu szablonów będzie w /lib/Opt. Gdybyśmy chcieli użyć w przyszłości innych bibliotek z tej rodziny, wystarczy wgrać je tuż obok, gdyż będą one korzystać z tego samego jądra.

Kolejna rzecz to ustawienie automatycznej ładowarki:

1 <?php
2 require('/sciezka/do/opl/Opl/Base.php');
3 Opl_Loader::setDirectory('/sciezka/do/opl/');
4 Opl_Loader::register();

Autoloader OPL ma charakter uniwersalny, tzn. można go także wykorzystać do ładowania innych bibliotek z kompatybilnym schematem nazewnictwa (np. Doctrine), aczkolwiek powyższy sposób jest dobry jedynie dla bibliotek OPL. Poniżej jest przedstawione bardziej uniwersalne podejście:

1 <?php
2 require('/sciezka/do/bibliotek/Opl/Base.php');
3 Opl_Loader::addLibrary('Opl', array('basePath' => '/sciezka/do/bibliotek/'));
4 Opl_Loader::addLibrary('Opt', array('basePath' => '/sciezka/do/bibliotek/'));
5 Opl_Loader::addLibrary('InnaBiblioteka', array('basePath' => '/sciezka/do/bibliotek/', 'handler' => null));
6 Opl_Loader::register();

Opcja handler ustawiona na null pozwala wyłączyć dodatkowe opcje ładowania klas specyficzne dla OPL-a, które mogą nie znaleźć zastosowania przy innych bibliotekach. I to wszystko. Jeśli poustawialiśmy dobrze ścieżki, możemy już zacząć korzystać z OPT.

Pierwszy szablon[edytuj]

Przypomnijmy sobie jeszcze raz szablon z początku rozdziału:

 1 <?xml version="1.0" ?>
 2 <opt:root xmlns:opt="http://xml.invenzzia.org/opt">
 3 <opt:prolog />
 4 <opt:dtd template="html5" />
 5 <html>
 6  <head>
 7   <title>{$pageTitle}</title>
 8  </head>
 9  <body>
10   <p>Polecamy nasze produkty:</p>
11   <ul>
12    <li opt:section="products"><a parse:href="$products.url">{$products.name}</a></li>
13   </ul>
14  </body>
15 </html>
16 </opt:root>

Możemy tu zauważyć kilka charakterystycznych dla OPT zachowań. Szablon jest domyślnie traktowany jak dokument XML, dlatego powinien posiadać prolog <?xml version="1.0" ?>, a co więcej - jest on podany wyłącznie do wiadomości parsera. Jeśli chcemy wygenerować prolog w kodzie wyjściowym, korzystamy z instrukcji opt:prolog, która podana bez argumentów nadaje im domyślne wartości. Oprócz tego chcielibyśmy dodać odpowiedni DTD. Komendy DTD także idą na cele parsera biblioteki, stąd też bierze się instrukcja opt:dtd. Ma ona predefiniowanych kilka szablonów DTD dla najpopularniejszych języków, np. html5, dzięki czemu ich wstawianie jest łatwiejsze.

XML wymaga od nas jeszcze jednej ważnej rzeczy, mianowicie w dokumencie nie może być więcej niż jednego głównego znacznika. W tradycyjnym HTML-u rolę głównego znacznika pełnił element <html>, ale ponieważ mamy obok niego jeszcze dwa inne, OPT oddaje nam do dyspozycji opt:root. Oprócz bycia głównym znacznikiem, można w nim poustawiać kilka rzeczy odnoszących się do całego szablonu.

Jak widać, przejście na język XML-owy w momencie, gdy XHTML oraz HTML same albo wywodzą się, albo są podobne do niego, spowodowało konieczność specjalnego traktowania niektórych elementów, jednak w praktyce musimy je wykonać tylko raz, na samym początku. Gdy zaczniemy pracować z właściwą treścią, sytuacja znacząco się odwraca. Zerknijmy na linijkę 7. Pokazane jest tam, jak osadzać zmienne ze skryptu w tekście międzyznacznikowym. Używamy do tego klamerek, w którym zapisujemy nasze wyrażenie. Zapis ten oznacza, że tytuł strony zostanie załadowany ze zmiennej $pageTitle.

W linijce 12 pragniemy wyświetlić kilka produktów jako listę wypunktowaną. Do wyświetlania list służą tzw. sekcje, czyli rodzaj inteligentnych pętli. Jednak zamiast obudowywać element <li> pętlą, wystarczy że dokleimy do niego atrybut opt:section z podaną nazwą sekcji. Jest to prosty sposób powiedzenia: ten kawałek ma być użyty jako wzorzec do wyświetlenia pojedynczego elementu listy, przy czym nie obchodzi mnie teraz, jak ta lista będzie dokładnie działać. Nazwa sekcji umożliwia nam później dostęp do zmiennych elementu listy, np. {$products.name} - zauważmy, że do separacji służy nam kropka.

W tej samej linijce widać też, że aby wczytać zawartość atrybutu ze zmiennej, nie używamy klamerek, lecz do nazwy doklejamy parse:, a wyrażenie zapisujemy bezpośrednio w cudzysłowach. Plik zapisujemy do katalogu ./templates/.

A oto i kod PHP, który powyższy szablon uruchomi:

 1 <?php
 2 require('/sciezka/do/bibliotek/Opl/Base.php');
 3 Opl_Loader::addLibrary('Opl', array('basePath' => '/sciezka/do/bibliotek/'));
 4 Opl_Loader::addLibrary('Opt', array('basePath' => '/sciezka/do/bibliotek/'));
 5 Opl_Loader::register();
 6 
 7 $pdo = new PDO('mysql:host=localhost;dbname=test', 'root', 'root');
 8 
 9 try
10 {
11    // Konfiguracja OPT
12    $tpl = new Opt_Class;
13    $tpl->sourceDir = './templates/';
14    $tpl->compileDir = './templates_c/';
15    $tpl->stripWhitespaces = false;
16    $tpl->setup();
17 
18    // Tworzymy widok
19    $view = new Opt_View('szablon.tpl');
20    $view->pageTitle = 'Tytuł strony';
21 
22    $list = array();
23    $stmt = $pdo->query('SELECT * FROM produkty');
24    while($row = $stmt->fetch(PDO::FETCH_ASSOC))
25    {
26       $list[] = array(
27          'name' => $row['nazwa'],
28          'url' => 'produkt.php?id='.$row['id']
29       );
30    }
31    $stmt->closeCursor();
32    $view->products = $list;
33 
34    // Renderujemy
35    $output = new Opt_Output_Http;
36    $output->setContentType(Opt_Output_Http::HTML, 'utf-8');
37    $output->render($view);
38 }
39 catch(Opt_Exception $exception)
40 {
41    $handler = new Opt_ErrorHandler;
42    $handler->display($exception);
43 }

Do raportowania błędów Open Power Template używa mechanizmu wyjątków, dlatego cały kod zawarty jest w bloku try...catch. Błędów nie musimy wyświetlać samodzielnie - do dyspozycji jest specjalna klasa Opt_ErrorHandler, która dodatkowo potrafi podawać różne informacje o błędzie, dzięki czemu łatwiej jest usunąć przyczynę. Sam skrypt składa się z trzech części. W pierwszej musimy skonfigurować bibliotekę, tworząc obiekt Opt_Class i ustawiając niektóre właściwości:

  1. sourceDir - katalog z szablonami źródłowymi (tj. ./templates/)
  2. compileDir - katalog ze skompilowanymi szablonami (tj. ./templates_c/)
  3. stripWhitespaces - czy usuwać ze źródeł niepotrzebne białe znaki, utrudniając analizę kodu wynikowego. Wartość false wyłącza usuwanie.

Po skonfigurowaniu wywołujemy metodę setup() i możemy zabrać się za tworzenie widoków. Obsługuje się je podobnie, jak w naszym edukacyjnym systemie z tą różnicą, że nie używamy tutaj metody fabrycznej, lecz samodzielnie tworzymy cały obiekt. W argumencie konstruktora podajemy nazwę szablonu, a później możemy do widoku przypisywać różne dane przy pomocy getterów i setterów. Przy okazji spójrzmy na linijki 23 do 33, gdzie wypełniana jest lista produktów dla sekcji. Lista jest zwykłą tablicą z elementami numerowanymi od zera, a każdy element jest tablicą asocjacyjną zawierającą kilka zmiennych.

Na samym końcu musimy szablon wykonać. W tym celu potrzebny jest nam jakiś system wyjścia, który zdecyduje, co zrobić z wynikiem. OPT dostarcza domyślnie dwóch takich systemów:

  1. Opt_Output_Return - zwraca kod jako wynik wykonania z powrotem do skryptu.
  2. Opt_Output_Http - wysyła kod do przeglądarki i udostępnia opcje zarządzania nagłówkami.

Skorzystamy z tego drugiego. Ma on dodatkową pomocniczą metodę setContentType(), która wysyła nagłówek Content-type z informacją dla przeglądarki, co dokładnie przysyłamy z serwera i ew. w jakim kodowaniu. Później wystarczy już tylko wywołać metodę render(), której podajemy za argument widok i to wszystko.

Sekcje[edytuj]

Sekcje to rodzaj inteligentnych pętli i służą do wyświetlania różnego rodzaju list. Zacznijmy od wyświetlenia prostej listy produktów:

 1 <?xml version="1.0" ?>
 2 <opt:root xmlns:opt="http://xml.invenzzia.org/opt">
 3 <h1>Lista produktów</h1>
 4 
 5 <table class="list">
 6  <thead>
 7    <tr>
 8      <td>#</td>
 9      <td>Nazwa</td>
10      <td>Cena</th>
11    </tr>
12  </thead>
13  <tbody>
14    <opt:section name="products">
15    <tr>
16       <td>{$products.id}</td>
17       <td>{$products.name}</td>
18       <td>{$products.price}</td>
19    </tr>
20    </opt:section>
21  </tbody>
22 </table>
23 </opt:root>

Aby utworzyć sekcję, stosujemy znacznik opt:section pokazany w linii 14. Jego zawartość określa wygląd pojedynczego elementu listy. Każda sekcja musi posiadać swoją własną nazwę; w szablonie wykorzystujemy ją do odwoływania się do zmiennych elementu: $products.id, zaś w skrypcie posłuży ona do przypisania danych listy. Zauważmy, że w szablonie nie ma żadnych informacji odnośnie szczegółów implementacyjnych. Jest to jedna z charakterystycznych cech sekcji i nie tylko; w założeniu twórca szablonów powinien skupić się jedynie na końcowym efekcie bez zajmowania się tym, jak do niego dojść. Przyjrzyjmy się zatem, jak wygenerować dane dla naszej listy. Ponownie skorzystamy z pomocy bazy danych z poprzedniego rozdziału, zatem należy pamiętać o wcześniejszym połączeniu się z nią poprzez PDO.

 1 $view = new Opt_View('product_list.tpl');
 2 $products = array();
 3 $stmt = $pdo->query('SELECT id, nazwa, cena FROM produkty ORDER BY id');
 4 while($row = $stmt->fetch(PDO::FETCH_ASSOC))
 5 {
 6    // Dodajemy nowy element
 7    $products[] = array(
 8       'id' => $row['id'],
 9       'name' => $row['nazwa'],
10       'price' => $row['cena']
11    );
12 }
13 $stmt->closeCursor();
14 // Dodaj listę do widoku
15 $view->products = $products;

Jak widzimy, pojedynczy element listy to zwykła tablica asocjacyjna, w której klucze odpowiadają indeksom użytym w szablonie. Aby utworzyć listę, wystarczy wszystkie elementy zgrupować w kolejną tablicę i przekazać do widoku pod nazwą identyczną, jak nazwa sekcji. Po uruchomieniu OPT automatycznie rozwinie je w podaną nam listę.

W szablonie nie mamy żadnych informacji o tym czy dane naszej listy umieszczone są w tablicy czy nie. Skąd zatem OPT wie, jak po niej iterować? Odpowiadają za to tzw. formaty danych. Jest to pewien rodzaj przepisu informujący OPT, jak radzić sobie z określonym rodzajem elementów. Przeróbmy nasz skrypt tak, aby umieszczał elementy w obiekcie klasy SplDoublyLinkedList (lista dwukierunkowa) i nauczmy OPT z niego korzystać:

 1 $view = new Opt_View('product_list.tpl');
 2 $products = new SplDoublyLinkedList;
 3 $stmt = $pdo->query('SELECT id, nazwa, cena FROM produkty ORDER BY id');
 4 while($row = $stmt->fetch(PDO::FETCH_ASSOC))
 5 {
 6    // Dodajemy nowy element
 7    $products->push(array(
 8       'id' => $row['id'],
 9       'name' => $row['nazwa'],
10       'price' => $row['cena']
11    ));
12 }
13 $stmt->closeCursor();
14 // Dodaj listę do widoku
15 $view->products = $products;
16 $view->setFormat('products', 'SplDatastructure');

Widzimy, że obiekt SplDoublyLinkedList to coś zupełnie innego niż tablica. Okazuje się, że poinformowanie o tym OPT to kwestia dodania jednej linijki (nr 16). Metoda setFormat() ustawia format danych dla określonego elementu. SplDatastructure to format dostosowany do pracy z listami, stosami i kolejkami wchodzącymi w skład znanego nam już pakietu SPL.

Jeśli sekcja obejmuje pojedynczy znacznik HTML, nie musimy tworzyć całego znacznika, ponieważ mamy do dyspozycji skróconą formę atrybutową:

1 <tr opt:section="products">
2    <td>{$products.id}</td>
3    <td>{$products.name}</td>
4    <td>{$products.price}</td>
5 </tr>

A co zrobić, gdy chcielibyśmy wyświetlić alternatywny tekst w razie otrzymania pustej listy? Pomoże nam znacznik opt:show:

 1 <?xml version="1.0" ?>
 2 <opt:root xmlns:opt="http://xml.invenzzia.org/opt">
 3 <h1>Lista produktów</h1>
 4 <opt:show name="products">
 5 <table class="list">
 6  <thead>
 7    <tr>
 8      <td>#</td>
 9      <td>Nazwa</td>
10      <td>Cena</th>
11    </tr>
12  </thead>
13  <tbody>
14    <opt:section>
15    <tr>
16       <td>{$products.id}</td>
17       <td>{$products.name}</td>
18       <td>{$products.price}</td>
19    </tr>
20    </opt:section>
21  </tbody>
22 </table>
23 <opt:showelse>
24  <p>Przykro nam, ale nie dodano jeszcze żadnych produktów.</p>
25 </opt:showelse>
26 </opt:show>
27 </opt:root>

Zauważmy, że w tym przypadku nazwa sekcji i inne ewentualne atrybuty trafiają do znacznika opt:show, pozostawiając opt:section pusty. Należy pamiętać o tej subtelności, ponieważ w przeciwnym razie efekty mogą być odmienne od zamierzonych.

Jednak prawdziwa elastyczność sekcji pojawia się dopiero przy próbie utworzenia list zagnieżdżonych. Pamiętamy, że w PHP i Savancie musieliśmy zajmować się tym samodzielnie, a wszelkie zmiany w strukturze danych generowanych przez aplikację zmuszały nas do przepisywania szablonów. W OPT wszystkimi detalami zajmują się formaty danych, my natomiast musimy jedynie umieścić jedną sekcję w drugiej i to wszystko. Wykorzystajmy tę właściwość do wypisania listy tagów skojarzonych z każdym produktem.

 1 <?xml version="1.0" ?>
 2 <opt:root xmlns:opt="http://xml.invenzzia.org/opt">
 3 <h1>Lista produktów</h1>
 4 <opt:show name="products">
 5 <table class="list">
 6  <thead>
 7    <tr>
 8      <td>#</td>
 9      <td>Nazwa</td>
10      <td>Cena</th>
11    </tr>
12  </thead>
13  <tbody>
14    <opt:section>
15    <tr>
16       <td>{$products.id}</td>
17       <td><span class="name">{$products.name}</span>
18         <span class="tags"><opt:section name="tags" str:separator=", ">
19          <a parse:href="$tags.url">{$tags.name}</a>
20         <opt:section></span>
21       </td>
22       <td>{$products.price}</td>
23    </tr>
24    </opt:section>
25  </tbody>
26 </table>
27 </opt:show>
28 </opt:root>

Utworzenie sekcji zagnieżdżonej nie wymaga od nas absolutnie żadnej dodatkowej czynności oprócz osadzenie jednej sekcji w drugiej. Przy okazji przykład pokazuje inną ciekawą właściwość. Chcielibyśmy, aby nasze tagi były odseparowane przecinkiem, przy czym po ostatnim ma go już nie być. W tym celu dodajemy do sekcji atrybut str:separator. Przestrzeń nazw str informuje OPT, że wartość atrybutu to zwykły tekst, ponieważ domyślnie kompilator oczekuje wczytywania jego kształtu ze zmiennej lub innego wyrażenia.

Cały proces składania odbywać się będzie po stronie skryptu. Jednak ponieważ nasza baza danych nie zawiera tagów, zapiszemy je na sztywno w kodzie, a stworzenie dynamicznej listy tagów dla każdego produktu pozostawiamy jako ćwiczenie.

 1 $view = new Opt_View('product_list.tpl');
 2 $products = array();
 3 $stmt = $pdo->query('SELECT id, nazwa, cena FROM produkty ORDER BY id');
 4 while($row = $stmt->fetch(PDO::FETCH_ASSOC))
 5 {
 6    // Dodajemy nowy element
 7    $products[] = array(
 8       'id' => $row['id'],
 9       'name' => $row['nazwa'],
10       'price' => $row['cena'],
11       // tagi dla tego produktu.
12       'tags' => array(0 =>
13          array('url' => '/tag1', 'name' => 'tag1'),
14          array('url' => '/tag2', 'name' => 'tag2'),
15          array('url' => '/tag3', 'name' => 'tag3'),
16       );
17    );
18 }
19 $stmt->closeCursor();
20 // Dodaj listę do widoku
21 $view->products = $products;
22 $view->setFormat('tags', 'SingleArray');

Ponieważ lista tagów jest zapisana dla każdego produktu z osobna, musimy poinformować o tym OPT, wybierając dla sekcji tags format danych SingleArray. Zachowanie domyślnego formatu jest nieco inne i wymaga od nas, aby sekcja tags posiadała swoją własną tablicę, lecz z podwójnym indeksowaniem (pierwsze - produkty; drugie - tagi konkretnego produktu).

Sekcje to bardzo wygodne narzędzie do wyświetlania wszekiego rodzaju list. Oprócz opt:section istnieją też trzy inne rodzaje sekcji:

  1. opt:selector - pozwala zdefiniować kilka różnych możliwych wyglądów dla elementów, które są wybierane na podstawie ich typu.
  2. opt:grid - wyświetlanie elementów w kolumnach z obsługą dopełniania ostatniego wiersza pustymi elementami.
  3. opt:tree - wyświetlanie drzew o dowolnej głębokości.

Wrócimy do nich w kolejnych rozdziałach.

Bloki i sortowanie listy produktów[edytuj]

W panelach administracyjnych często spotyka się możliwość sortowania listy poprzez klikanie na nagłówkach kolumn. Choć Open Power Template nie dostarcza nam gotowego rozwiązania, udostępnia narzędzia, które umożliwią nam łatwą jego implementację. Są to tzw. bloki. Każdy blok składa się zawsze z dwóch elementów:

  1. Obiektu pewnej klasy PHP implementującej interfejs Opt_Block_Interface. Nazywa się on obiektem bloku.
  2. Grupy znaczników w szablonie, w których dany obiekt będzie uruchamiany. Nazywa się ona portem bloku.

Zaczniemy od umieszczenia w naszym szablonie stosownego portu:

 1 <?xml version="1.0" ?>
 2 <opt:root xmlns:opt="http://xml.invenzzia.org/opt">
 3 <h1>Lista produktów</h1>
 4 <opt:show name="products">
 5 <table class="list">
 6  <thead>
 7    <tr>
 8      <td><opt:sort-list str:name="products:id" str:selected="sel">#</opt:sort-list></td>
 9      <td><opt:sort-list str:name="products:name" str:selected="sel">Nazwa</opt:sort-list></td>
10      <td><opt:sort-list str:name="products:price" str:selected="sel">Cena</opt:sort-list></th>
11    </tr>
12  </thead>
13  <!-- treść tabeli -->
14 </table>
15 </opt:show>
16 </opt:root>

Jak widać, port jest zwykłym znacznikiem. Jego nazwę wybraliśmy sami i niebawem poinformujemy OPT, że ma on go skojarzyć z odpowiednim typem bloków. Do portu możemy przekazać dowolną liczbę argumentów. U nas definiują one etykiety, po których rozpoznamy, jaką kolumnę sortujemy, a także klasy CSS, jakie należy użyć np. gdy dana kolumna jest wybrana.

Powyższy rodzaj portów to tzw. porty statyczne. OPT podczas wykonywania automatycznie utworzy dla nich odpowiedni obiekt danego typu. Oprócz tego, istnieją też porty dynamiczne, w których obiekt wczytywany jest ze zmiennej. Oznacza to, że możemy utworzyć taki obiekt po stronie skryptu, skonfigurować go tam, a następnie pchnąć do szablonu, gdzie zostanie odpalony:

<opt:block from="$obiektBloku" argument="wartość">
  ... treść ...
</opt:block>

Zanim zaczniemy implementować Opt_Block_Interface, napiszemy sobie interfejs, który pozwoli skryptowi na skonfigurowanie kolumn, po których będziemy sortować:

<?php
class Sorter
{
   const ASC = 0;
   const DESC = 1;

   private $_columns = array();
   private $_default = null;
   private $_defaultOrder = 0;

   private $_selected;
   private $_order;
   private $_url;

   static private $_sorters = array();

   public function __construct($name, $url)
   {
      $this->_sorters[$name] = $this;
      $this->_url = $url;
   } // end __construct();

   static public function get($name)
   {
      if(!isset(self::$_sorters[$name]))
      {
         throw new RuntimeException('Podany zestaw reguł sortowania: '.$name.' nie istnieje.');
      }
      return self::$_sorters[$name];
   } // end get();

   public function addColumn($id, $dbField)
   {
      $this->_columns[$id] = $dbField;
      if($this->_default === null)
      {
         $this->_default = $id;
      }
   } // end addColumn();

   public function setDefault($id, $order)
   {
      $this->_default = (string)$id;
      $this->_defaultOrder = (int)$order;
   } // end setDefault();

   public function process()
   {
      $this->_selected = $this->_default;
      // Pobierz z adresu URL informację o kolumnie, po której sortujemy.
      if(isset($_GET['col']))
      {
         if(isset($this->_columns[$_GET['col']))
         {
            $this->_selected = $_GET['col'];
         }
      }
      // Pobierz informację o kierunku sortowania
      if(isset($_GET['ord']))
      {
         if($_GET['ord'] == 0 || $_GET['ord'] == 1)
         {
            $this->_order = $_GET['ord'];
         }
      }
      // Zwróć kawałek zapytania SQL
      return $this->_columns[$this->_selected].' '.($this->_order == 0 ? 'ASC' : 'DESC');
   } // end process();

   public function isSelected($id)
   {
      if($this->_selected != $id)
      {
         // ten element nie został wybrany.
         return null;
      }
      return $this->_order;
   } // end isSelected();

   public function getUrl()
   {
      return $this->_url;
   } // end getUrl();
} // end Sorting;

Opis metod jest następujący:

  1. __construct() - tworzy nowy zestaw reguł sortowania.
  2. addColumn() - dodaje informację o nowej kolumnie. Pierwszy argument to nasz identyfikator, drugi - nazwa kolumny w zapytaniu SQL
  3. setDefault() - ustawia domyślne sortowanie.
  4. process() - wczytuje z adresu URL informacje o aktualnym sortowaniu i generuje kawałek zapytania SQL.
  5. isSelected() - metoda ta będzie używana przez nasz obiekt bloku do rozpoznania czy aktualna kolumna jest wybrana.
  6. get() - metoda statyczna zwracająca określony zestaw reguł na potrzeby obiektu bloku.

Teraz pora na klasę implementującą Opt_Block_Interface. Musimy w niej zaimplementować trzy metody:

  1. onOpen($attributes) - wywoływana w momencie otwarcia znacznika portu. Powinna zwrócić true, jeśli chcemy wyświetlić zawartość bloku.
  2. onClose() - wywoływana w momencie zamykania znacznika bloku.
  3. onSingle($attributes) - wywoływana, gdy mamy do czynienia z portem w znaczniku pojedynczym: <znacznik />.

Kod źródłowy:

 1 <?php
 2 class Sorter_Block implements Opt_Block_Interface
 3 {
 4    private $_order;
 5 
 6    public function onOpen(array $attributes)
 7    {
 8       $data = explode(':', $attributes['name']);
 9       if(sizeof($data) != 2)
10       {
11          throw new DomainException('Nieprawidłowa nazwa bloku.');
12       }
13       $sorter = Sorter::get($data[0]);
14 
15       // Sprawdź czy sortujemy według tej kolumny
16       $this->_order = $sorter->isSelected($data[1]);
17       $url = $sorter->getUrl();
18       $url .= (strpos($url, '?') !== null ? '?' : '&');
19 
20       // Dodaj trochę CSS-a i wygeneruj kod HTML
21       $class = (isset($attributes['class']) ? $attributes['class'] : null);
22       $selected = (isset($attributes['selected']) ? $attributes['selected'] : null);
23 
24       if($this->_order != null)
25       {
26          echo '<a href="'.$url.'col='.$data[1].'&ord='.(int)(!$this->_order).'" '.($selected !== null ? 'class="'.$selected.'" : '').'>';
27       }
28       else
29       {
30          echo '<a href="'.$url.'col='.$data[1].'&ord=0" '.($class !== null ? 'class="'.$class.'" : '').'>';
31       }
32       return true;
33    } // end onOpen();
34 
35    public function onClose()
36    {
37       if($this->_order !== null)
38       {
39          if($this->_order == 0)
40          {
41             echo '↓</a>';
42          }
43          else
44          {
45             echo '↑</a>';
46          }
47       }
48       else
49       {
50          echo '</a>';
51       }
52    } // end onClose();
53 
54    public function onSingle(array $arguments)
55    {
56       /* pusto */
57    } // end onSingle();
58 } // end Sorter_Block;

Nasz mechanizm sortowania będzie przekazywać informacje o aktualnym sortowaniu za pośrednictwem dodatkowych argumentów w adresie URL. Dlatego nasz blok będzie generować wokół nazwy kolumny znacznik <a>, który po kliknięciu spowoduje posortowanie elementów według danej kolumny, a w przypadku już wybranej - odwróci kolejność sortowania. Oczywiście wybraną kolumnę należy wyróżnić odpowiednią klasą CSS oraz dodatkową strzałką pokazującą kierunek sortowania.

Zauważmy, że OPT nie zabrania nam generowania HTML-a przez kod PHP. Oczywiście generowanie w ten sposób większego kawałka kodu mijałoby się z celem i byłoby wyjątkowo nieczytelne, ale dla pojedynczych znaczników nie ma żadnych przeciwwskazań przeciwko programowaniu w ten sposób.

Pora na podłączenie naszego systemu sortowania pod listę. Dla zachowania czytelności pozbyliśmy się obsługi tagów:

 1 $view = new Opt_View('product_list.tpl');
 2 
 3 $sorter = new Sorter('products', 'product_list.php');
 4 $sorter->addColumn('id', '`id`');
 5 $sorter->addColumn('name', '`nazwa`');
 6 $sorter->addColumn('price', '`cena`');
 7 
 8 $products = array();
 9 $stmt = $pdo->query('SELECT id, nazwa, cena FROM produkty ORDER BY '.$sorter->process());
10 while($row = $stmt->fetch(PDO::FETCH_ASSOC))
11 {
12    // Dodajemy nowy element
13    $products[] = array(
14       'id' => $row['id'],
15       'name' => $row['nazwa'],
16       'price' => $row['cena'],
17    );
18 }
19 $stmt->closeCursor();
20 // Dodaj listę do widoku
21 $view->products = $products;

Wygląda na to, że to już wszystko. Reguły sortowania są ustawione, odpowiedni kawałek zapytania SQL generowany, w szablonie oznaczone kolumny... jednak po uruchomieniu nagłówki kolumn znikają. Oczywiście - zapomnieliśmy poinformować OPT, że opt:sort-list jest blokiem. W przypadku takich nieznanych znaczników kompilator po prostu je ignoruje wraz z zawartością, stąd zniknięcie tekstu w nagłówkach. Musimy zarejestrować naszą klasę Sorter_Block w OPT, dlatego w momencie inicjowania biblioteki dodajemy:

1 $tpl = new Opt_Class;
2 $tpl->sourceDir = './templates/';
3 $tpl->compileDir = './templates_c/';
4 $tpl->stripWhitespaces = false;
5 $tpl->register(Opt_Class::OPT_BLOCK, 'opt:sort-list', 'Sorter_Block');
6 $tpl->setup();

Po ponownym skompilowaniu szablonów nasza lista będzie już mogła być sortowana po nagłówkach kolumn.

Przekonaliśmy się właśnie, że kluczem do efektywnego pisania szablonów jest przygotowanie sobie odpowiedniego zaplecza, bowiem większość napisanego przed chwilą kodu to rozmaite klasy PHP. Moglibyśmy osiągnąć identyczny efekt przy pomocy pętli oraz instrukcji warunkowych bezpośrednio w szablonie, ale przecież w prawdziwej aplikacji nie mamy jednej listy, tylko co najmniej kilkanaście. Dlatego tak ważne jest, aby poświęcić chwilkę czasu na zaprogramowanie obsługi takich fragmentów, jak sortowanie czy stronicowanie oraz aby system szablonów udostępniał odpowiednie narzędzia do ich osadzania w szablonach. W przypadku OPT są to bloki oraz działające na podobnej zasadzie komponenty, które mają jednak dużo bardziej rozbudowany interfejs dostosowany do wyświetlania formularzy. Zauważmy, że gdy przyjdzie nam tworzyć np. listę użytkowników, w szablonie będzie to już kwestia dodania dodatkowego znacznika w nagłówku każdej kolumny i nic więcej!

Zaawansowane sekcje i stronicowanie[edytuj]

Upiększanie listy produktów[edytuj]

Zakończenie[edytuj]

W rozdziale tym pokazaliśmy, jak zbudować i obsłużyć szablon dla dynamicznej listy produktów przy pomocy biblioteki Open Power Template. Jest to jednak tylko wycinek jej możliwości, ponieważ jest ona projektowana, by poradzić sobie nawet z najtrudniejszymi wymaganiami. Filozofia tworzenia szablonów jest tutaj zupełnie inna, niż w poznanym wcześniej Savancie, dlatego nie powinniśmy tutaj polegać na swojej intuicji i przenosić tego, co funkcjonowało w PHP z nadzieją, że zadziała i tutaj. Zauważmy, że w podanych przykładach nie użyliśmy po stronie szablonów ani klasycznej pętli, ani zwykłej instrukcji warunkowej, chociaż oczywiście OPT udostępnia takie instrukcje, jak opt:if czy opt:foreach.

Następny i zarazem ostatni system szablonów, jaki poznamy, to PHPTAL. Jest on ogniwem pośrednim między OPT, a Savantem, z nowoczesnym językiem szablonów, który jednak jest nieco bardziej zbliżony do klasycznego programowania.