pear list

To polecenie powinno nam zwrócić mniej więcej taki wynik:

1
2
3
4
5
6
7
8
9
10
11
12

Installed packages, channel pear.php.net:
=========================================
Package             Version State
Archive_Tar         1.3.3   stable
Console_Getopt      1.2.3   stable
HTML_Common         1.2.5   stable
HTML_QuickForm      3.2.11  stable
HTML_Template_Flexy 1.3.9   stable
HTML_Template_IT    1.2.1   stable
PEAR                1.8.1   stable
Structures_Graph    1.0.2   stable
XML_Util            1.2.1   stable

Oczywiście nie powinniście mieć HTML_Template_IT, ale jeżeli macie, pomińcie dalszą część instalacji.

Instalacja
Żeby zainstalować pakiet z biblioteki PEAR, należy uzyskać prawa administratora, ja używam archlinuxa, przez co u mnie uzyskanie praw administratora wykonuje się przez polecenie:

su

w zależności od dystrybucji, może to być też również

sudo su

Po wpisaniu hasła, wydajemy polecenie:

pear update-channels

być może będzie trzeba zrobić coś innego, ale czytajcie logi z konsoli, i na pewno przejdziecie ten etap. Następnie wpisujemy:

pear install HTML_Template_IT

I teraz plus dla Linuxa, linux sam sobie rozwiąże zależności wśród pakietów, co załatwia za nas instalowanie dodatkowych pakietów które musielibyśmy sami rozwiązać (czytaj ściąganie ręcznie z strony pear.php.net reszty paczek). Dobra mamy już to czego nam potrzeba, czyli system szablonów ITX. Dobrym też rozwiązaniem jest upgrejd pozostałych pakietów, jeżeli mamy jakieś stare, możemy to łatwo i szybko rozwiązać wpisując polecenie:

pear upgrade-all

Teraz możemy przejść do części kulminacyjnej, czyli implementacji ITX.

Sposób użycia systemu szablonów ITX
Tworzymy sobie jakiś plik, np index.php, i zaczynamy kodzić nasz pierwszy skrypt z użyciem ITX:

1
2
3
4
5
6
7
8
9

<?php
require_once ('HTML/Template/ITX.php'); # wczytujemy klase bazową
$tpl = new HTML_Template_ITX('./templates'); # do konstruktora podajemy ścieżkę w której znajduje się nas szablon
$tpl->loadTemplatefile('index.tpl',true,true); # wczytujemy nasz plik z templatką
$tpl->setCurrentBlock('start'); # zaczynamy blok do parsowania
$tpl->setVariable('imie','Andrzej'); # parsujemy zmienna imie na tekst Andrzej
$tpl->parseCurrentBlock('start'); # dobrym nawykiem jest dodawanie nazwy bloku
$tpl->show();
?>

Dla totalnie zielonych (nie chcesz nie czytaj)

Mamy już gotowy plik w którym będziemy parsować plik z templatką, teraz troche wyjaśnień co do metod

$tpl = new HTML_Template_ITX('./templates');

W tym momencie tworzymy obiekt klasy HTML_Template_ITX i musimy do konstruktora klasy wysłać ścieżkę w której mamy nasze pliki z szablonami, ./ mówi nam że jest to katalog z którego wykonujemy skrypt, następnie folder templates, w którym mamy nasz plik z szablonem. Nie ma innej możliwości podania klasie lokalizacji folderu z szablonami, więc należy o tym pamiętać.
Następna linijka:

$tpl->loadTemplatefile('index.tpl',true,true);

Tutaj natomiast podajemy nazwę szablonu którego ma użyć w danym skrypcie, funkcja loadTemplatefile jak widać pobiera 3 argumenty, pierwszy to nazwa templatki jako string, druga natomiast przyjmuje wartości boolean, czyli true lub false, dla true usuwa nieznane zmienne z pliku z szablonem, czyli jak damy jakąś zmienną {KTOS} a nie nadamy jej wartości poprzez setVariable, to parses usunie ją, dla false parses zostawi zmienną i wyświetli się nam w postaci {KTOS}, trzeci argument, też przyjmuje wartości boolean, odpowiada za parsowanie bloków w sensie usuwa lub zostawia bloki, już tłumaczę, dla true parser usunie bloki nie dotknięte przez funkcję setCurrentBlock(), lub touchBlock() lub parse(). Ale do tego wrócimy. Dla false zostawi te bloki, i je wyświetli (manual o tym nic nie pisze, ale tak jest
Idźmy dalej:

$tpl->setCurrentBlock('start');

Tutaj jak sama nazwa funkcji wskazuje, ustawiamy jaki blok w templatce chcemy parsować, trzeba wziąć pod uwagę, to że wielkość słów nie ma znaczenia, lecz nie mogą się w nazwie bloku znaleźć Polskie znaki diakrytyczne. Później pokaże jak to można zrobić, tak więc czy napiszemy StArT, czy START, czy jakkolwiek inaczej parser nam to ładnie przewinie, dodam że do nazw można dodawać liczby 0-9, _ (podkreślnik), – (minus) oraz . (kropka).

$tpl->setVariable('imie','Andrzej');

Tutaj natomiast mamy do czynienia z ustawianiem zmiennej imie na string Andrzej, zostanie ona podmieniona a później wyświetlona, należy jednak zapamiętać że nie powinno się stosować takich samych nazw bloków jak i zmiennych, z doświadczenia wiem, że może to nam narobić boruty, i nawet jeżeli mamy 2 bloki, każdy z bloków nazywa się inaczej, to nie wolno stosować takich samych nazw zmiennych w tych blokach! Bardzo ważne i należy się tego trzymać!

$tpl->parseCurrentBlock('start');

Tutaj mamy dziwną sprawę, ponieważ funkcja jest nazwana jako void, co jest bardzo dziwne, ponieważ funkcje typu void niczego nie zwracają, a tu i tak funkcja zwraca nam true więc wartość boolean przy poprawnym rezultacie, no i w przeciwnym wypadku FALSE lub IT_Error, sprawdziłem IT_Error.php, dziedziczy z klasy PEAR_Error, w której nie ma wyjątków, więc co jak co try {} catch {} nam nie pomogą. Dostaniemy gołym php’owym błędem w twarz. Co do podawania nazwy bloku który parsujemy, nie daje on nic, ale daje nam, jeżeli mamy np parę zagnieżdżonych bloków w sobie (np podwójne Menu, potrójne, poczwórne …), to później nam łatwiej jest się odnaleźć który to już blok zamknęliśmy.

$tpl->show();

Funkcja ta, może ale nie musi przyjmować wartość typu string, która jest nazwą bloku, czyli parsujemy jakąś templatkę i nie chcemy parsować wszystkiego na raz, tylko pojedyncze bloki bo takie mamy widzimisię, to podajemy jako string nazwę każdego z poszczególnych bloków. Jeżeli natomiast zastosujemy na końcu po implementacji całego szablonu, parser przeleci wszystkie bloki, i je zwróci jako gotowy kod HTML’a. Btw kolejna funkcja typu void.

Plik szablonu

Przerobiliśmy cały kod z pliku index.php, teraz zostało nam zobaczyć jak wygląda, teraz przyszedł czas na szablon.
Tak więc nazwaliśmy sobie szablon: index.tpl, tak więc w katalogu templates tworzymy sobie ten plik szablonu a w nim następujący kod:

1
2
3
4
5
6
7
8
9
10
11

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" >
<title>System szablonów ITX</title>
</head>
<body>
<!-- BEGIN start -->
Witaj {imie}!
<!-- END start -->
</body>
</html>

Jak już zdążyliście zauważyć bloki zaczyna się komentarzami w HTML’u, wyraźnie zaznaczamy rozpoczęcie kodu bloku przez słowo BEGIN i zakończenie END, zmienne wstawiamy w znaki klamer { }
Teraz to już nam nic nie zostało do zrobienia jak tylko odpalenie skryptu, i zobaczyć jak pięknie działa. W ten oto sposób oddzieliliśmy kod PHP od kodu HTML.

W następnych częściach więcej przykładów oraz opisu funkcji.