Spis treści

AKTUALNOŚCI
Ze świata PHP 6
Deweloperzy poszukiwani? Przedstawiamy garść najciekawszych wiadomo-
ści dla deweloperów PHP.
... bardzo dobra znajomość PHP4/5 oraz MySQL, do-
bra znajomość HTML oraz JavaScript, doświadczenie
w tworzeniu aplikacji WWW z wykorzystaniem Zend Fra- Opis CD
mework... Zawartość CD 10
Tak już niedługo może brzmieć ogłoszenie poten-
Prezentujemy zawartość płyty i sposób działania
cjalnego pracodawcy poszukującego Programisty PHP.
najnowszej wersji naszej dystrybucji PHP Solu-
Zend, firma „od PHP”, wypuszcza „prawdziwy” framework dla PHP tions Live.
– Zend Framework. Narzędzie do szybkiego i wyjątkowo łatwego pisa-
nia w PHP. Wszyscy oczekiwali po tym narzędziu bardzo wiele i ... nie
zawiedli się. Mimo że projekt znajduję się jeszcze w głębokiej fazie be- WYWIAD
ta, zyskał już setki zwolenników, którzy ze zniecierpliwieniem czekają na Rozmowa z Dmitrim Stogovem 12
kolejne wersje rozwojowe, jak również na te stabilne. A wsparcie gwa-
rantują mu najwięksi deweloperzy PHP, sama firma Zend oraz ogrom- Dariusz Pawłowski
na społeczność PHP. Można byłoby więc zaryzykować twierdzenie, że Dmitry Stogov jest jednym z inżynierów rozwojo-
Zend Framework już wkrótce stanie się pewnego rodzaju standardem. wych w firmie Zend i szefem rosyjskiego zespo-
Taki stan rzeczy z pewnością ułatwiłby i ustandaryzował tworzenie oraz łu tej firmy. Należy do grona twórców Zend Engi-
rozwijanie aplikacji WWW. Wielu programistów zaczęłoby poniekąd roz- ne 2. Stworzył też Turck MMCache i szereg roz-
mawiać wspólnym językiem, a znajomość Frameworka byłaby dodatko- szerzeń SOAP i Perl dla PHP5.
wym atutem lub nawet wymogiem na rynku pracy w kategorii Programi-
sta PHP. Zakłada się bowiem, że jego znajomość pozwoli na zbudowanie
praktycznie każdej aplikacji w PHP. Czy tak się stanie? Z odpowiedzią POCZĄTKI
na to pytanie musimy jeszcze trochę poczekać. Już teraz jednak, w arty- Obiektowość w PHP
kule Piotra Szarwasa, przedstawimy Wam możliwości nowego narzędzia na przykładzie IRCBota 14
i praktyczne przykłady jego użycia.
Marcin Staniszczak
W obecnym numerze przedstawimy też konkurencyjne dla Zend Fra-
W dalszym ciągu wiele osób nie próbowało pro-
mework rozwiązanie: eZ components, będące platformą do tworzenia
gramowania obiektowego. Oto artykuł, który po-
zaawansowanych aplikacji klasy Enterprise. Główny deweloper projek-
wstał, by wprowadzić w świat obiektowości i
tu, Tobias Schlitt, przedstawi Wam praktyczne wykorzystanie najważniej-
PHP5 . Krok po kroku piszemy aplikację wpro-
szych komponentów frameworka. wadzającą do tego modelu programowania.
Na koniec prawdziwa niespodzianka – Kryptografia w PHP. Zdziwie-
ni? Zaskoczeni? Nic więcej nie zdradzę. APIlity: zarządzanie reklamami
Google AdWords z poziomu PHP 26
Serdecznie zapraszam do lektury!
Thomas Steiner
Dariusz Pawłowski
Załóżmy, że prowadzimy rozbudowane kampa-
nie marketingowe w oparciu o Google AdWords.
Zarządzanie nimi przy użyciu zwykłej strony in-
ternetowej jest mocno ograniczone i uciążliwe.
Chcielibyśmy stworzyć własnego klienta Ad-
Words, który pozwoliłby nam na elastyczne za-
rządzanie naszym kontem i automatyzację wielu
Nasz magazyn ukazuje się w czterech językach! procesów. Naprzeciw naszym oczekiwaniom wy-
chodzi Google AdWords API.
polskim niemieckim francuskim włoskim

BEZPIECZEŃSTWO
Kryptografia w PHP 34
Łukasz Lach, Michał Stanowski
Prawdopodobnie każdy z nas wie, na czym polega
kryptografia. Bierzemy porcję informacji (np. tekstu)
i szyfrujemy ją tak, aby nikt nieuprawniony nie był w
stanie jej odczytać. Z kryptografią mamy do czynie-
nia na co dzień – czy to korzystając z banku inter-
netowego, czy też wysyłając szyfrowanego maila. I
Jeśli jesteś zainteresowany zakupem licencji na wydawanie naszych pism prosimy o kontakt:
Monika Godlewska monikag@software.com.pl tel.: 48 22 887 12 66, fax: 48 22 887 10 11 to wszystko z wykorzystaniem PHP.

4 www.phpsolmag.org PHP Solutions Nr 4/2006


NARZĘDZIA
Zend Framework 42
Piotr Szarwas
Pojawienie się Zend Frameworka wzbudziło
w świecie PHP wiele emocji. Zend, jedyna praw-
dziwa firma od PHP, wypuściła – tak jak należa-
ło – prawdziwy Framework dla PHP. Wszyscy
oczekiwali po tym rozwiązaniu bardzo wiele i ...
nie zawiedli się.
eZ Components w akcji,
czyli galeria zdjęć krok
po kroku 50
Tobias Schlitt
Komponenty eZ stanowią w ogólnym ujęciu
opartą na PHP platformę do budowy rozwiązań
biznesowych. Stosowanie tej wysokiej klasy ko-
lekcji niezależnych bloków budulcowych znacz-
nie przyśpiesza proces tworzenia oprogramo-
wania we wspomnianym języku, zmniejszając
jednocześnie ryzyko załamania się projektu.
TECHNIKI
Dekorator: wzorzec projektowy
na każdą bolączkę 62
Paweł Kozłowski
Nazwa wzorca projektowego dekorator jest nie-
co myląca, ponieważ sugeruje, że będziemy
coś wzbogacać, dekorować czy upiększać. Nic
bardziej błędnego! Omawiany wzorzec znajduje
szerokie zastosowanie, niezależnie od tego, czy
projektujemy warstwę dostępu do bazy danych,
logikę biznesową lub kontroler MVC.
Metoda aktywnego rekordu 72
Jakub Sacha
Tworząc aplikacje internetowe na codzień, czę-
sto zdarza się nam operować na listach danych
np artykułów, autorów, wpisów w księdze gości,
nowości na stronie. Każda z list organizowana
jest w mniej lub bardziej złożone tabele w bazie
danych. Dużą część czasu, poświęcanego na
przygotowanie aplikacji zajmuje pisanie naprze-
miennie zapytań wstawiających lub edytujących
rekordy dla różnego rodzaju danych, różniących
się od siebie nazwami oraz ilością kolumn.
ZAPOWIEDZI
W następnym numerze 82
Zapowiedzi, artykułów, które planujemy do na-
stępnego wydania naszego pisma.
PHP Solutions Nr 4/2006
Spis treści
Pytania dotyczące
prenumeraty
tel. (22) 887 14 44
e-mail: pren@software.com.pl
Software Wydawnictwo Sp. z o.o.
dział prenumeraty
ul. Piaskowa 3
01-067 Warszawa
CD Strona WWW/Forum
tel. (22) 887 14 44 strona www: www.phpsolmag.org
e-mail: cd@software.com.pl Tu znajdą Państwo informacje
Software Wydawnictwo Sp. z o.o. dotyczące aktualnych i przyszłych
Defekty CD/DVD numerów magazynu PHP Solutions.
ul. Piaskowa 3
01-067 Warszawa Forum: www.phpsolmag.org/newforum
Zachęcamy do dyskusji na naszym
Zamówienia forum. Czekamy na propozycje
/Numery archiwalne tematów, które chcieliby Państwo
tel. (22) 887 14 44 znaleźć w najbliższym numerze pisma.
e-mail: pren@software.com.pl Zapraszamy także do wymiany
sklep on-line: www.buyitpress.com poglądów z innymi fanami PHP.
Kontakt z redakcją Cena
e-mail: redakcja@phpsolmag.org Prenumerata: 135 zł
Software Wydawnictwo Sp. z o.o. Przelew na konto nr:
Redakcja PHP Solutions
ul. Piaskowa 3
46 1440 1299 0000 0000 0391 8238
Nordea Bank Polska S.A.
01-067 Warszawa II Oddział w Warszawie
Wyróżnieni betatesterzy: Ł. Witczak, K. Trynkiewicz, K. Kaczmarczyk, Ł. Jasiński, T. Skaraczyński,
P. Sobstel, M. Nowakowska, T. Tomczyk, T. Skaraczyński, K. Bąbol, B. Czech, K. Wdowicz,
T. Malinowski, P. Plewa, W. Andruszkiewicz, A. Polit
PHP Solutions jest wydawany przez Software-Wydawnictwo Sp. z o.o.
Dyrektor Wydawniczy: Jarosław Szumski
Market Manager: Sylwia Tuśnio sylwia.tusnio@software.com.pl
Product Manager: Maciej Krawcewicz maciej.krawcewicz@phpsolmag.org
Redaktor prowadzący: Dariusz Pawłowski dpawlowski@phpsolmag.org
Redaktor : Krzysztof Sobolewski krzysztof.sobolewski@phpsolmag.org
Stali współpracownicy: Paweł Kozłowski pkozlowski@phpsolmag.org,
Kierownik produkcji: Marta Kurpiewska marta@software.com.pl
Projekt okładki: Agnieszka Marchocka
Skład i łamanie: Sławomir Zadrożny slawekz@software.com.pl
Dział reklamy: adv@software.com.pl
Prenumerata: Marzena Dmowska pren@software.com.pl
Nakład: 6 000 egz.
Adres korespondencyjny: Software-Wydawnictwo Sp. z o.o.,
ul. Piaskowa 3, 01-067 Warszawa, Polska
tel. +48 22 887 10 10, fax +48 22 887 10 11
www.phpsolmag.org cooperation@software.com.pl
Dołączoną do magazynu płytę CD przetestowano programem AntiVirenKit firmy G DATA Software Sp. z o.o.
Redakcja dokłada wszelkich starań, by publikowane w piśmie i na towarzyszących mu nośnikach informacje
i programy były poprawne, jednakże nie bierze odpowiedzialności za efekty wykorzystania ich; nie gwarantuje
także poprawnego działania programów shareware, freeware i public domain.
Uszkodzone podczas wysyłki płyty wymienia redakcja.
Wszystkie znaki firmowe zawarte w piśmie są własnością odpowiednich firm
i zostały użyte wyłącznie w celach informacyjnych.
Redakcja używa systemu automatycznego składu
Do tworzenia wykresów i diagramów wykorzystano program firmy
Osoby zainteresowane współpracą prosimy o kontakt: cooperation@software.com.pl
Druk: ArtDruk
Wysokość nakładu obejmuje również dodruki. Redakcja nie udziela pomocy technicznej w instalowaniu
i użytkowaniu programów zamieszczonych na płytach CD-ROM dostarczonych razem z pismem.
Sprzedaż aktualnych lub archiwalnych numerów pisma po innej cenie niż wydrukowana na okładce
– bez zgody wydawcy – jest działaniem na jego szkodę i skutkuje odpowiedzialnością sądową.
Pismo ukazuje się w następujących wersjach językowych:
polskiej , francuskiej , niemieckiej oraz włoskiej .
www.phpsolmag.org 5
Aktualności

Najpopularniejsze
frameworki dla PHP
Wybierz najlepszy CMS
Na stronie http://www.phpit.net/article/ten-
different-php-frameworks/ znajdziemy ze-
stawienie dziesięciu najpopularniejszych
W ybór odpowiedniego CMS-a do
stworzenia portalu/witryny może
spędzić sen z powiek nie jednemu z nas,
frameworków dla PHP. Branych pod uwa-
gę jest kilkanaście cech w tym m.in: wyko- szczególnie, że jest w czym przebierać,
rzystanie PHP5, MVC, ORM, wsparcie dla
różnych baz danych czy AJAX-a. Z kolei na a różnice i zastosowania poszczególnych
stronie http://www.phpwact.org/php/mvc_ aplikacji są znaczne. Jak sprawdzić, któ-
frameworks znajduje się zestawienie ok. 40
frameworków implementujących wzorzec ry system odpowiada naszym potrze-
MVC. Wybierajmy jednak z głową (i maga- bom i będzie najlepszy do wykorzystania
zynem PHP Solutions).
właśnie w naszym przypadku? Tego do- Poza generowaniem porównań możemy
Seagull 0.6.0RC2 wiecie się w kilku ciekawych miejscach też oceniać wybrane rozwiązania i dysku-
Pojawiła się nowa wersja frameworka w Sieci. tować na forum.
Seagull, który oferuje możliwości z pograni-
cza zwykłego frameworka i CMS-a. Seagull Na stronie www.cmsmatrix.org znaj- Szukając CMS-a warto zajrzeć rów-
po zainstalowaniu zawiera kilka praktycz- dziecie nie tylko wykaz najpopularniej- nież na www.opensourcecms.com. Au-
nych modułów, co oszczędza czas na pisa-
nie tych komponentów samodzielnie.
szych systemów CMS wraz z ich szcze- torzy nie oferują wprawdzie żadnego po-
Framework jest kompatybilny z PHP4 gółowym opisem. Najciekawsze jest równania systemów, ale za to znajdzie-
i PHP5, korzysta z pakietów PEAR-a i jest narzędzie do generowania zestawień my tam bardzo efektywny podział pro-
łatwo integrowany z innymi aplikacjami. Je-
go dużym plusem jest silne wsparcie przez – porównań wybranych CMS-ów. Li- duktów na kategorie (CMS-y typu porta-
międzynarodową społeczności i dostępno- sta wyboru jest oszałamiająca i zawiera lowgo, blogi itd.) i świetne forum, na które
ści w wielu językach (nawet w chińskim).
W najnowszej wersji m.in. naprawiono wie- 570 pozycji!!! Wystarczy zaznaczyć od 2 trzeba zajrzeć przed wdrożeniem nowego
le błędów, zapewniono pełne wsparcie dla do 10 produktów i wygenerować tabelkę, (nieznanego) CMS-a.
PostgreSQL-a.
http://seagullproject.org/
w której znajdzie się porównanie. Do ze- Dla ciekawości dodamy, że już niedłu-
stawienia pod uwagę wzięto m.in.: wyma- go w naszym magazynie pojawi się test
Praca dla programistów PHP gania systemowe, bezpieczeństwo, ła- systemów CMS, który powstanie przy
PHP-freelancers.com to portal dla ludzi po-
szukujących programistów do szybkiego wy- twość użycia, wydajność, zarządzanie, współpracy z cmsmatrix.org i php.pl. Już
konania małych i dużych projektów w PHP elastyczność czy obecność aplikacji/mo- teraz gorąco polecamy!
oraz dla samych deweloperów PHP zainte-
resowanych pracami dorywczymi – zlece-
dułów wbudowanych, takich jak kalen-
niami na wykonanie projektu lub jego czę- darz czy system do wysyłki newslettera. http://www.cmsmatrix.org
ści. Jest w czym wybierać, projekty ma-
ja bardzo zróżnicowane ceny: od 10 do kil-
ku tysięcy dolarów. I tak za napisanie klasy
do porównywania dwóch fragmentów tekstu WebGUI

i wyświetlania różnic pomiędzy nimi moż-
na otrzymać od 10 do 300 dolarów. Do pro-
jektu zgłasza się z reguły kilku dewelope-
rów oferując swoje ceny oraz czas realiza-
cji zadania.
http://www.php-freelancers.com/
Integracja Propela
z Zend Framework
Na stronie Zend Developer Zone pojawiły sie
nowe ciekawe tutoriale i artykuły. Na uwagę
zasługuje tekst opisujący integrację Prope-
la (bardzo popularne narzędzie ORM) z Zend
Frameworkiem. O Propelu pisaliśmy w nu-
merze 5/2005, a o Zend Framework możecie
przeczytać w obecnym wydaniu naszego ma-
gazynu. Wśród innych materiałów na stronie
znajdziemy też tutoriale o połączeniu
Frameworka ze Smarty (Zend Framework nie
ma póki co wbudowanego systemu szablo-
nów) i eZ components.
http://devzone.zend.com/node/view/id/184
phpDocumentor 1.3.0RC6
Ukazała się nowa wersja najbardziej popular-
nego oprogramowania do generowania doku-
mentacji aplikacji na podstawie kodu PHP.
Na temat phpDocumentora opublikowali-
śmy obszerny artykuł w numerze 5/2004
(www.buyitpress.com). Wersja 1.3.x ma być
ostatnią z pierwszej linii, bo już zapowie-
dziano wcielenie 2.x. Najnowsza wersja w
pełni wspiera PHP5, wykorzystuje PEAR::
XML_Beautifier do upiększania (formatowa-
nie komentarzy, dodawania znaków końca li-
nii itp.). kodu, koloruje kod HTML/XML czy
pozwala na wygodniejszą pracę z grafikami.
Licencja: GPL
http://pear.php.net/package/PhpDocumentor/
W
ebGUI to CMS/framework do bu-
dowania aplikacji klasy Enterpri-
se. Autorzy systemu chcieli stworzyć
CMS-a z możliwie najprostszą obsługą
i administracją, tak aby zbędny okazał
się helpdesk IT. Program zawiera in-
terfejs administracyjny z funkcją dra-
g&drop, wbudowany edytor WYSWIG
działający pod IE i Mozillą, przechowuje
historie zmian treści serwisu, co umoż-
liwia ich cofanie, jak również oferuje
HELP w JavaScript, który osobom nie- gacji w zbudowanym serwisie oraz przy-
znającym HTML-a pomoże odpowiednio jazne URL-e.
sformatować dokument. WebGUI zawiera szereg gotowych
WebGUI mile zaskakuje pod wzglę- do użycia modułów: newsy, artykuły, fo-
dem bezpieczeństwa: posiada certyfi- ra, blogi, sondy, FAQ, galerie zdjęć, ka-
kat bezpieczeństwa (OSI Certified Open lendarze czy nawet komponent agre-
Source Software), bezpieczne logowanie gujący i prezentujący oferty pracy. Sys-
(SSL), system kopii zapasowych/wersji, tem posiada również bardzo elastycz-
co umożliwia łatwe przywrócenie po- ny sklep internetowy z wbudowanymi
przednio zapisanych treści oraz komer- modułami płatności. Dostęp do różnych
cyjne wsparcie. usług/produktów, które będziemy ofero-
Aplikacja nie rozczaruje również sa- wać, może być sprzedawany np. w po-
mych deweloperów: system jest modu- staci kodów dostępu na określony okres
larny i bardzo łatwo rozszerzalny, pozwa- (np. tydzień).
la na łatwe tworzenie wersji językowych
czy nowych modułów. Wprowadzono też Licencja: GPL
możliwość tworzenia indywidualnej nawi- http://www.webgui.org

6 www.phpsolmag.org PHP Solutions Nr 4/2006


eZ publish Conference 2006
M
agazyn PHP Solutions został
głównym sponsorem konferencji
organizowanej przez firmę eZ systems,
producenta takich znanych rozwiązań
jak eZ publish i eZ components. Pierw-
sza, tegoroczna edycja odbędzie się
w Norwegii w dniach 21-23 czerwca.
W ciągu trzech dni imprezy bę-
dzie można posłuchać wykładów na te-
mat m.in.: eZ components (Derick Re-
thans, Tobias Schlitt), eZ publish (Bard
Farstad), Open Source (Zak Greant),
MySQL (Kristofer Petterson), OOP
w PHP (Marcus Börger), testowania apli-
kacji z wykorzystaniem PHPUnit3 (Seba-
stian Bergman) czy zwiększania wydaj-
ności aplikacji PHP (Ilia Alshanetsky).
TYPO3 w wersji 4
T YPO3 to popularny CMS, który po-
dobnie jak eZ publish zaliczany
jest do oprogramowania klasy Enter-
prise. W nowej wersji systemu pojawi-
ło się sporo zmian. CMS pracuje teraz
na PHP5 i posiada cały szereg nowych
funkcjonalności.
Panel administracyjny został całko-
wicie przebudowany, dzięki czemu za-
rządzanie serwisem będzie dużo ła-
twiejsze. Standardowo do dyspozycji
mamy edytory WYSWIG (HTMLArea),
opcję drag and drop do przenosze-
nia obiektów pomiędzy okienkami czy
możliwość tworzenia tzw. workspaces,
do pracy z grupą obiektów. Tworzenie
workspaces pozwala na edycję i zmia-
ny nie tylko wersji live, ale i wersji ro-
boczych, które mogą być potem do-
wolnie wykorzystane.
Grupy użytkowników mogą admi-
nistrować innymi grupami, a zarzą-
dzanie dostępem do poszczególnych
części serwisu jest teraz dużo bardziej
elastyczne.
Dodano tablicę z odniesieniami,
w której zapisane są nazwy linków
oraz obiekty na które wskazują. To po-
PHP Solutions Nr 4/2006
Poza uczestnictwem w ciekawych
wykładach, będzie również okazja do
spotkania się z najlepszymi dewelope-
rami i firmami związanymi z PHP z ca-
łego świata.
http://ez.no/company/events/ez_publish_
conference_2006
zwala na kontrolę i np. uniknięcie usu-
nięcia podstrony, do której linkujemy
z innego miejsca.
Polepszono silnik do wyszukiwa-
nia danych, dodano wsparcie dla m.in.
Oracle'a i PostgreSQL-a oraz wprowa-
dzono nowy oparty o XML system sza-
blonów – TemplaVoila. Dokonano rów-
nież refaktoryzacji kodu.
W ramach nowości warto jeszcze
wymienić możliwość generowania gra-
fiki za pomocą rozszerzenia GIFBU-
ILDER TypoScript, przechowywanie
historii zmian czy pewne ulepszenia
w zakresie bezpieczeństwa.
Dużym plusem TYPO3 była za-
wsze 100% kompatybilność z po-
przednimi wersjami. Tym razem prze-
chodząc do nowej wersji niestety nie
obejdziemy się bez małych modyfi-
kacji w zakresie CSS (content rende-
ring). Dobra wiadomość jest taka, że
można włączyć tryb kompatybilności
z wersją 3.8 i nie przejmować się ty-
mi zmianami.
Licencja: GPL
http://typo3.com/
www.phpsolmag.org
Aktualności
MobiLog
MobiLog to opensourcowe narzędzie do mo-
bloggingu (mobile weblogging), czyli zarzą-
dzania zawartością witryny z poziomu urzą-
dzenia przenośnego takiego jak telefon ko-
mórkowy czy PDA. Wystarczy pod wskazany
adres mailowy wysłać wiadomość, aby zaktu-
alizować dane na stronie WWW. Do działania
oprogramowanie potrzebuje: MySQL 4.1.1,
Perl 5.8, PHP 4.2 oraz kilka dodatkowych mo-
dułów Perla.
Licencja: BSD
http://www.accliptic.com/products/opensource/ml/
phc
phc to kompilator, który konwertuje kod PHP
na asemblera pod Linuksa. Może być uży-
ty jako np. framework C++ do rozwijania róż-
nych narzędzi (np. obfuskatory, narzędzia re-
factoringu).
phc oferuje także interfejs do modyfikacji kodu
powstałego z PHP oraz jego konwersji z powro-
tem do PHP.
Licencja: BSD
http://www.phpcompiler.org
Zend Framework wyżej niż
Microsoft .NET Framework
Na razie tylko w wyszukiwarce, ale co cieka-
we w tej Microsoftu – msn.com :). Po wpisa-
niu w wyszukiwarce słowa „framework” pro-
dukt Zenda ukazywał się jako pierwszy,
a framework Microsoftu jako drugi. Fakt ten
uchwycił Endi Gutmans i opublikował zrzut
z ekranu na swoim blogu.
http://andigutmans.blogspot.com/
NuSphere PhpED 4.5
To jeden z najlepszych IDE dla PHP. W nowej
wersji udoskonalono podświetlanie składni
dla PHP4, PHP5, XML, XHTML, HTML, CSS,
Perl, Python, Javascript, ASP, SQL, C/C++
i Smarty.
Mamy też możliwość dynamicznego wyboru
sposobu/szablonu podświetlania składni, któ-
re możemy wcześniej zdefiniować. Dodano
również wsparcie dla SQLite i Firebird (MySQL,
MSSQL, Oracle i PostgreSQL wspierane są już
od dawna).
Licencja: komercyjna, 299$
http://www.nusphere.com
PRADO 3.0.0
Po dziesięciu miesiącach oczekiwania po-
jawiła się nowa wersja frameworka PRADO
(o frameworku tym pisaliśmy w numerze
5/2005). Przypomnijmy: jest to oparty na
komponentach (component-based)
i na zdarzeniach (event-driven) framework
dla PHP5, który zwyciężył w konkursie or-
ganizowanym przez firmę Zend ponad rok
temu. W nowej wersji system został całko-
wicie przepisany, a deweloperzy położy-
li szczególny nacisk na wydajność, nieza-
wodność oraz elastyczność. PRADO zo-
stał wielokrotnie nazwany RAD-em dla pro-
gramistów PHP5 i pod wieloma względami
przypomina ASP.NET.
Licencja: BSD
http://www.pradosoft.com/
E-mail Injections
Warto przyjrzeć się budowie formularzy
kontaktowych w naszych aplikacjach i za-
bezpieczyć przed wysłaniem spamu
z naszego serwera WWW. Atak polega na
dołączeniu dowolnych nagłówków do wysy-
łanego maila, co pozwala np. na spamowa-
nie. Aby się zabezpieczyć, wystarczy od-
powiednio filtrować dane wprowadzane do
formularza.
http://securephp.damonkohler.com/index.php/
Email_Injection
7
Aktualności

Stypendium na wakacje
– Google sponsoruje
projekty Open Source
Google Summer of Code to program oferu-
jący stypendia studentom, którzy zdecydują
się na wykonywanie w czasie wakacji pro-
jektu pod opieką organizacji np. php.net.
Drupal czy Debian. Można otrzymać
5000$, z czego 4500$ dostaje student,
a 500$ opiekun projektu. Lista opiekunów
na edycję 2006 jest już zamknięta i liczy
kilkadziesiąt pozycji. W dalszym ciągu jed-
nak mogą zgłaszać się studenci. php.net
już zgłosiło kilka propozycji np. konwerter
z PHP4 na PHP5 (PHP6) (http://php.net/
ideas.php). W ramach projektu można roz-
wijać własne (rozpoczęte) projekty. Na
stronie Google znajdują się wyczerpujące
informacje mówiące o tym jak przystąpić do
programu i jakie są jego zasady.
http://code.google.com/soc/
php.MVC
php.MVC to w pełni obiektowy framework
MVC. Korzysta z Pear::DB Database Abs-
traction Layer, jest wyjątkowo bezpieczny
(aplikacje posiadają jeden tzw. entry
point). Oferuje możliwość łatwego zarzą-
dzania sekwencją akcji i statycznymi tre-
ściami. Każda aplikacja posiada XML-owy
plik konfiguracyjny. Framework implemen-
tuje klasę LookupDispatchAction(),
która mapuje butony z formularzy HTML na
odpowiednie metody logiki biznesowej (co
umożliwia ich wykonywanie). Projekt
powstał na bazie znanego ze świata Javy
frameworka Struts, co stanowi jego dosko-
nałą rekomendację.
Licencja: LGPL
http://www.phpmvc.net/
Zend Guard 4
Zend Guard to oprogramowanie, któ-
re zapewnia kompleksową ochronę ko-
du źródłowego aplikacji PHP, które chcemy
rozpowszechniać/sprzedawać. W skład pa-
kietu wchodzi enkoder (kodowanie źródła),
obfuskator (zaciemnianie kodu) oraz mene-
dżer licencji pozwalający np. na ograniczanie
czasu działania oprogramowania czy bloko-
wanie adresów IP. Dodatkowo pakiet zwięk-
sza wydajność aplikacji dzięki zastosowaniu
nowych technik optymalizacji kodu.
Licencja: komercyjna, $995
http://www.zend.com/products/zend_guard
Maguma za darmo
Maguma znana jest z dwóch komercyjnych,
profesjonalnych i silnie rozwojowych produk-
tów: Maguma Workbench oraz
Maguma Studio. Na sourceforge.net
(http://sourceforge.net/projects/openstudio)
można pobrać darmową wersję Maguma
Open Studio, która różni się od Magumy Stu-
dio brakiem menedżera CVS oraz pojawiają-
cym się okienkiem z informacjami o licencji.
Niestety, tak jak jej komercyjny odpowiednik,
IDE dostępne jest jedynie pod Windows.
Licencja: MPL 1.1 (Mozilla Public License)
http://www.maguma.com
http://sourceforge.net/projects/openstudio
Zend/PHP
Conference&Expo 2006
W dniach 29 października – 2 listopada 2006
w San Jose, USA odbędzie się kolejna edycja
konferencji PHP organizowanej przez firmę
Zend. Częścią imprezy będą również warsz-
taty oraz szkolenia przygotowujące do certyfi-
katu Zend Certified Engeenier.
http://zendcon06.kbconferences.com/
Joomla
J oomla to system powstały na bazie
Mambo – bardzo popularnego, ale
też uważanego przez wielu za NIEprofe-
sjonalnego i mało bezpiecznego CMS-a.
Mambo posiada ogromną społeczność
i jest używany przez tysiące serwisów
WWW. Jest bardzo łatwy we wdrożeniu
oraz utrzymaniu. Bez problemu można
pobrać gotowy, nowy szablon graficzny
czy wersję językową systemu. Wraz z wy-
daniem 4.5.3, w sierpniu 2005 roku, część weloperów Joomla – Forge.Joomla.org.
deweloperów odeszła z Mambo, by roz- Dokonuje się częściowej refaktoryzacji ko-
począć nowy projekt – tak powstał Joom- du, polepsza dokumentację, tworzy sekcje
la. Nowe Mambo wygląda na projekt sil- online dla testerów – wszystko po to, aby
nie rozwojowy – powstają już wersje be- zapewnić lepszy rozwój projektu. Road-
ta, które oferują tzw. Multisite CMS (jedna map na stronie Joomla mówi o wielu po-
instalacja pod wiele domen) czy wsparcie ważnych zmianach, które mają nastąpić
dla 11 serwerów baz danych. Szczególny w niedalekiej przyszłości: dalsza praca
nacisk położono na kwestie bezpieczeń- nad funkcją Multisite, system kontroli wer-
stwa naprawiając wiele poważnych błę- sji, wirtualny system plików, menedżer ak-
dów w aplikacji (zlikwidowano m.in. podat- tualizacji wersji czy wsparcie dla MySQL5.
ności na SQL Injections w module Sond
i podczas aktywacji użytkownika oraz Licencja: GPL
Email Injections w funkcji „Email from http://www.joomla.org
Friend”). Powstało nawet centrum dla de- http://www.mamboserver.org
Zarządzanie projektami PHP w PHP
P anowanie nad dużą liczbą projektów
i przypisanych im zadań to nie la-
da wyzwanie dla kierownika zespołu lub
samego programisty. W PHP zosta-
ło stworzonych kilka dobrych systemów,
które usprawniają zarządzanie projektami
i zadaniami. Mamy do dyspozycji progra-
my zaawansowane takie jak dotProject
(http://www.dotproject.net/) czy phpCol-
lab (http://www.php-collab.org/), któ-
re oferują bardzo wiele opcji: dzielenie go dodanego projektu dodajemy zada-
projektów na etapy (wykres Gantta), do- nie wraz z terminem zakończenia i opi-
dawanie użytkowników z rożnymi upraw- sem. Do dyspozycji mam także m.in. li-
nieniami, fora dyskusyjne, kalendarze sty, checklisty czy możliwość przeglą-
czy menedżery plików. Wymienione pro- dania raportów i podsumowań. Pro-
gramy można łatwo rozwijać budując jekt GTD-PHP jest opensourcową wer-
własne moduły, zmieniając szablony czy sją komercyjnego oprogramowania GTD
dodając kolejną wersję językową. Sam (http://www.davidco.com/).
dotProject oferuje wsparcie dla kilkudzie- Przed ostatecznym wyborem syste-
sięciu języków. mu zachęcamy do wypróbowania wersji
Jeśli jednak potrzebujemy czegoś DEMO obecnych na stronach poszcze-
znacznie prostszego – możliwości doda- gólnych projektów.
wania projektu (wraz z kategoriami) oraz
przypisywania im zadań – to dobrym
rozwiązaniem może być lekki program
o nazwie Getting Things Done (http:// Licencja: http://gtd-php.sourceforge.net/
gtd-php.sourceforge.net/). Do działania gtd/about.php
potrzebuje PHP4/5 oraz MySQL w wer- http://www.dotproject.net/
sji 4.x. Korzystanie z programu jest http://www.php-collab.org/
bardzo proste i intuicyjne. Do każde- http://gtd-php.sourceforge.net

8 www.phpsolmag.org PHP Solutions Nr 4/2006

Opis CD
PHP Solutions Live
T ę wersję PHP Solutions Live zbudo-
waliśmy, opierając się o dystrybucję
Aurox i skrypty automatycznej generacji
(www.aurox.org/pl/live). Narzędzia dystry-
bucji, które nie znajdują się na dołączonej
do pisma płycie, instalowane są z repozy-
torium Auroxa za pomocą programu yum.
W porównaniu z poprzednią wersją
PHP Solutions Live zasadniczą zmianą
jest przejście z Fluxboksa na środowisko
Rysunek 1. Pulpit PHP Solutions Live ze skrótami do aplikacji.
Materiały dodatkowe
M ateriały dodatkowe zostały umiesz-
czone w następujących katalogach:
l Tutoriale video – trzecia część multi-
medialnego kursu, zatytułowana user
signup,
l Aplikacje – hity numeru, w bieżącym
numerze: CaRP Koi 3.5.5 – konwerter
RSS do HTML oraz Komodo IDE.
l e-books – książki i inne dokumenty
w formacie PDF
Program CaRP Koi 3.5.5 firmy GeckoTri-
be dostępny jest w pełnej wersji komer-
cyjnej w licencji dla jednego Webmaste-
ra. Jest to w pełni funkcjonalna wersja,
której można używać w komercyjnych
i prywatnych zastosowaniach, a jedynym
ograniczeniem jest to, by każdej kopii z
pisma używał tylko jeden Webmaster.
Zalecamy zapoznanie się z warunkami
10
graficzne KDE oraz dodanie wielu przy-
datnych programistom aplikacji. Teraz,
oprócz kompletnego środowiska LAMP
(Linux, Apache, MySQL, PHP) w syste-
mie gotowe do użycia są środowiska pro-
gramistyczne, takie jak: Eclipse, Nvu, Qu-
anta, BlueFish oraz wiele innych charak-
terystycznych dla KDE i Linuksa narzędzi.
PHP Solutions Live – to w pełni funk-
cjonalny system operacyjny, który znajdu-
licencyjnymi, które są dokładnie sprecy-
zowane w pliku Readme, dostarczanym
wraz z dystrybucją aplikacji. W tym sa-
mym pliku opisano szczegółowo różni-
ce pomiędzy wersją 3.5.5 oraz najnow-
szymi, dostępnymi na stronie producen-
ta – firmy Gecko Tribe. CaRP Koi 3.5.5
jest napisany w PHP dzięki czemu łatwo
można go wykorzystać na serwerze. We
wspomnianym pliku Readme, znajduje
się także opis funkcjonalności programu,
instrukcja instalacji oraz zbiór odpowie-
dzi na najczęściej zadawane przez użyt-
kowników pytania.
Druga komercyjna aplikacja za-
mieszczona na płycie to Komodo 3.5
Professional, czyli profesjonalne śro-
dowisko IDE dla programistów. Na CD
zamieściliśmy 30 – dniowy trial, któ-
ry można uruchomić przy pomocy kodu
dostępnego pod adresem: http://www.
www.phpsolmag.org
Rysunek 2. Ekran powitalny PHP
Solutions Live z opcjami uruchomienio-
wymi
je się na płycie dołączonej do pisma. Jest
to bootowalna dystrybucja Auroxa, zawie-
rająca bogaty zestaw przydatnych pro-
gramistom i webmasterom narzędzi, do-
kumentację, tutoriale i materiały dodat-
kowe do artykułów. System został przy-
gotowany w taki sposób, by zaraz po uru-
chomieniu systemu można było testować
i tworzyć nowe skrypty.
Aby zacząć pracę z PHP Solutions Li-
ve, wystarczy uruchomić komputer z CD.
Po uruchomieniu systemu zostaniemy
automatycznie zalogowani w systemie,
a po krótkiej chwili powinna uruchomić się
przeglądarka Mozilla Firefox wraz z Menu
przedstawiającym zawartość płyty zwią-
zaną z bieżącym numerem.
activestate.com /Products /Download /
Download.plex?id=Komodo
Dla tych czytelników PHP Solutions,
którzy zainteresowani są pełną wer-
sją programu, firma ActiveState oferuje
zniżkę w wysokości 100$ (standardowa
cena programu to 295$). Aby skorzy-
stać ze zniżki należy do 21 lipca;
l odwiedzić stronę
http://www.ActiveState.com/
PHPSolutions
l wybrać opcję „Buy”
l wpisać kod „PHPSOL”
W przypadku przeglądania płyty z pozio-
mu uruchomionego PHP Solutions Live,
a nie systemu operacyjnego zainstalowa-
nego na dysku komputera, wymienione
aplikacje i materiały dostępne są z podka-
talogu /mnt/cdrom.
PHP Solutions Nr 4/2006
 Na CD
Przetestuj dowolne skrypty
bez instalacji!

3 nowe książki elektroniczne

Auditing your web site security
An Introduction to Web Services Enabled with PHP HIT
PHP5 Power Programming Pełna wersja komercyjnego programu CaRP Koi
firmy Gecko Tribe o wartości około $20
Aplikacje
PHP Compiler Nowy kurs multimedialny
Komodo Professional 3.5 PHP IDE user signup

Narzędzia w dystrybucji
Kompletne środowisko LAMP

Opensource’owe IDE dla developerów:

Nvu, Bluefish, Quanta, Eclipse
i wiele innych aplikacji
na naszej stronie internetowej pod adresem www.phpsolmag.org/pl

na naszej stronie internetowej pod adresem www.phpsolmag.org/pl

Wszystkie listingi z artykułów zostały zamieszczone

Wszystkie listingi z artykułów zostały zamieszczone

Wywiad
Wywiad z Dmitrim Stogovem – programistą
Zend i twórcą Turck MMcache
Dariusz Pawłowski: Jak zaczęła się Two-
ja przygoda z PHP?
Dmitry: To było w roku 2000, kiedy
pracowałem w Sankt Petersburgu w firmie
Turck Software (wbrew nazwie firmie nie-
mieckiej, nie tureckiej). Miałem już wtedy
jakieś 10 lat doświadczenia w programo-
waniu, ale nigdy nie programowałem dla
Internetu – nie znałem języków HTML, Ja-
vaScript czy Perl, a o PHP nawet nie sły-
szałem. Gdy pewnego dnia otrzymałem
zadanie napisania aplikacji internetowej,
zacząłem próbować różnych możliwych
technologii. Spróbowałem JSP, skryp-
tów Perla, jakiegoś komercyjnego CMS-a
opartego na TCL, aż w końcu stanęło na
PHP (wtedy było to PHP3).
Moją pierwszą aplikacją w PHP był
system śledzenia czasu pracy. Całość
mieściła się z 500 wierszach kodu, chodzi-
ła na Linuksie i używała bazy IBM DB2 do
składowania danych. W ciągu dwóch lat w
Turck Software opracowaliśmy kilka apli-
kacji internetowych, z których najciekaw-
12
Dmitry Stogov jest jednym z inżynierów
rozwojowych w firmie Zend i szefem rosyjskiego
zespołu tej firmy. Należy do grona twórców Zend
Engine 2. Stworzył też Turck MMCache i szereg
rozszerzeń SOAP i Perl dla PHP5.
szy technicznie był projekt www.guestbo-
oks4all.com. Aplikacja pozwalała na two-
rzenie własnych ksiąg gości dostosowa-
nych do potrzeb konkretnej witryny bez
konieczności programowania.
DP: Jesteś autorem Turck MMCache.
Skąd wziął się pomysł projektu i jakie były
jego pierwotne założenia?
Dmitry: Potrzeba stworzenia MMCa-
che pojawiła się wraz z rosnącą popular-
nością serwisu ksiąg gości, kiedy to zaczy-
naliśmy nawet rozważać możliwość wpro-
wadzenia klastra serwerów. Na szczęście
znaleźliśmy czysto programistyczny spo-
sób wydajnego obsłużenia rosnącej licz-
by wizyt: składowanie skompilowanych
kodów stron PHP. Zaczęliśmy szukać ist-
niejących, darmowych rozwiązań. Postano-
wiliśmy odrzucić rozwiązania o zamkniętym
kodzie źródłowym, więc pozostało nam je-
dyne wówczas oprogramowanie open sour-
ce tego typu, czyli Afterburner. Niestety, da-
wał on zaledwie połowę przyrostu wydaj-
ności produktów Zend i ionCube, nie uży-
www.phpsolmag.org
wał pamięci współdzielonej i nie miał żad-
nego optymalizatora. Po dłuższym namyśle
postanowiłem więc stworzyć projekt MMCa-
che na wewnętrzne potrzeby naszego ser-
wisu ksiąg gości. Do moich głównych zain-
teresowań programistycznych należały bu-
dowa kompilatorów i optymalizacja kodu,
więc MMCache powstawał szybko i w krót-
kim czasie zaczął dawać wyniki porówny-
walne z produktami komercyjnymi. Uzna-
liśmy, że nierozsądnie byłoby trzymać tak
dobre oprogramowanie wyłącznie do użyt-
ku wewnętrznego, a zarazem nie chcieli-
śmy go sprzedawać, więc postanowiliśmy
udostępnić MMCache na licencji GPL.
Do końca mojej pracy w Turck Softwa-
re utrzymywałem projekt MMCache, a je-
go popularność gwałtownie rosła. Pod ko-
niec 2003 r. właściciel Turck Software po-
stanowił zakończyć działalność w branży
oprogramowania, a dla mnie nadeszła po-
ra rozejrzenia się za nową pracą.
DP: Obecnie jesteś szefem rosyjskie-
go zespołu firmy Zend. Jak trafiłeś do
PHP Solutions Nr 4/2006

Zenda? Czy to prawda, że Zend „kupił”
Cię, gdyż Turck MMCache stanowił kon-
kurencję dla własnych produktów Zenda?
Dmitry: I tak, i nie. Do pracy w Zen-
dzie zgłosiłem się sam. Oczywiście wie-
działem, że znają mnie jako twórcę
MMCache, więc był to dla mnie dodat-
kowy atut w negocjacjach, zwłaszcza że
wtedy nie prowadzili jeszcze działalności
na terenie Rosji. Wiedziałem też, że bę-
dę musiał zakończyć prace nad projek-
tem MMCache, ale i tak nie widziałem
już dla niego przyszłości – Zend Engine
w PHP5 zmieniał się zbyt szybko, więc
dalsze prace nad MMCache polegałyby
raczej na ciągłej adaptacji do zmian niż na
faktycznych pracach rozwojowych. Uzna-
łem więc, że więcej dobrego zdziałam pra-
cując nad samym Zend Engine.
Po kilku miesiącach pracy w Zendzie
otrzymałem taką okazję i zająłem się wpro-
wadzaniem ulepszeń modułu wykonaw-
czego w PHP-5.1 dających niemal dwu-
krotnie szybsze wykonywanie surowego
kodu PHP niż w przypadku starszych wersji.
Oczywiście nie ja sam wymyśliłem wszyst-
kie usprawnienia, ale ich implementacja jest
moim dziełem. Jestem więc bardzo zado-
wolony z pracy w Zendzie i mam nadzieję,
że firma jest równie zadowolona ze mnie.
Pod koniec 2004 r. powstał projekt
Zend Core, którego część Zend postano-
wił realizować w Rosji. Tak powstał rosyjski
zespół Zend, którego szefem zostałem ja.
DP: Nad czym obecnie pracujesz dla
Zenda?
Dmitry: Wszystkich tajemnic nie mo-
gę ujawnić, ale mniej więcej połowę cza-
su zajmuje mi praca nad PHP6 (obsłu-
ga Unikodu) i wprowadzanie ulepszeń
i poprawek w istniejących wersjach PHP
i w moich rozszerzeniach. Oczywiście
uczestniczę też w komercyjnych projek-
tach Zenda. W przeszłości miałem swój
udział w tworzeniu rodziny produktów
Zend Enabler (nie WinEnabler, ale na
przykład SunOne Enabler i Shared Ho-
sting Enabler), byłem przez jakiś czas
szefem technicznym projektu Zend Core
i wprowadziłem nieco ulepszeń w projek-
tach Zend Optimizer i Zend Accelerator.
DP: Jak wygląda Twoja codzienna
praca? Mieszkasz i pracujesz w Rosji,
więc jak kontaktujesz się z Zendem? Jak
często masz spotkania i wyjazdy?
Dmitry: Pracuję w domu, w Sankt Pe-
tersburgu. To piękne i bardzo przyjemne
PHP Solutions Nr 4/2006
miasto (może z wyjątkiem mrozu zimą,
brudu na wiosnę, komarów latem i desz-
czu na jesieni) i nie chciałbym mieszkać
nigdzie indziej.
Najczęściej zajmuję się zadaniami dłu-
goterminowymi, więc nierzadko nie kon-
taktuję się z Zendem nawet przez kilka
tygodni. Gdy kontakt jest konieczny, poro-
zumiewamy się za pośrednictwem pocz-
ty elektronicznej, MSN lub Skype’a. Głów-
ne biura Zenda znajdują się Izraelu i USA,
więc nawet zwykli pracownicy firmy komu-
nikują się przede wszystkim tymi drogami.
Zend jest główną siłą napędową roz-
woju PHP, ale w końcu nie tworzy go
w pojedynkę. Często rozmawiam ze
świetnymi programistami należącymi do
społeczności twóców PHP. Z niektórymi
spotkałem się w Paryżu na ostatnim PHP
Developers Meeting, ale często nic nie
wiem o osobie na drugim końcu łącza (nie
wiem nawet, czy to on, czy ona).
Zespół programistów rosyjskich to
w dużej mierze moi starzy znajomi (niektó-
rzy również z Turck Software). Z począt-
ku spotykaliśmy się raz w tygodniu, ale
po doszlifowaniu procesu prac nad pro-
jektami jesteśmy już w stanie rozwiązy-
wać większość trudności bez konieczno-
ści spotykania się. Obecnie spotykamy się
więc w czasie wolnym, a nie w pracy.
Uruchomienie nowego projektu wyma-
ga niekiedy wizyt w biurze Zenda w Izra-
elu. W styczniu tego roku wszystkich pra-
cowników zaproszono do Eilat na obcho-
dy szóstych urodzin firmy.
DP: Co Twoim zdaniem będzie naj-
bardziej potrzebne, by PHP osiągnął
status platformy klasy Enterprise z praw-
dziwego zdarzenia, porównywalnej na
przykład z .NET?
Dmitry: PHP nie da się bezpośred-
nio porównać ze środowiskami w rodza-
ju .NET czy J2EE. PHP to po prostu język
programowania specjalizowany dla aplika-
cji internetowych, więc bardziej na miej-
scu byłoby porównywanie go z Java Se-
rver Pages czy ASP.NET, i moim zdaniem
w tym towarzystwie PHP jest najlepsze.
Platformę klasy Enterprise powinny
jednak cechować takie zalety, jak skalo-
walność, niezawodność, łatwość utrzyma-
nia, łatwość i szybkość tworzenia aplikacji
ze sprawdzonych komponentów, dostęp-
ność licznych bibliotek i narzędzi wspoma-
gających programowanie, solidne wspar-
cie techniczne i tym podobne. Zend Tech-
www.phpsolmag.org
Wywiad
nologies i inne firmy przez cały czas mają
te cechy na uwadze i pracują nad stopnio-
wym zbliżaniem PHP do statusu rozwiąza-
nia klasy Enterprise.
Jedynym istotnym pojęciem, jakiego
brakuje w samym języku PHP, jest coś
w rodzaju modułu lub pakietu, coś co po-
zwoliłoby projektować i tworzyć rozbudo-
wane aplikacje bez konieczności zajmo-
wania się rozwiązywaniem konfliktów po-
między poszczególnymi podsystemami.
DP: Dlaczego Twoim zdaniem tak wie-
le firm unika PHP, wybierając na przykład
ASP.NET, JSP lub J2EE? Czy znasz jakiś
bank internetowy wykorzystujący PHP ja-
ko główną technologię?
Dmitry: Tu się nie zgodzę. Wiele firm
korzysta z PHP, ale używa go przede
wszystkim zgodnie z jego pierwotnym
przeznaczeniem, czyli jako technologii
tworzenia interfejsu WWW. Mniejszym fir-
mom nierzadko wystarcza samo PHP, ale
większe przedsiębiorstwa na ogół mają
bardziej rozbudowane systemy informa-
tyczne, których poszczególne elementy
korzystają z bardziej odpowiednich tech-
nologii i języków. Nie sądzę, by PHP miał
kiedykolwiek nadawać się do absolutnie
wszystkich zadań.
Co do banków internetowych, to na
pewno wiem, że takie istnieją. Na przy-
kład Dresdner Bank korzysta z aplika-
cji PHP do dostarczania klientom usług
finansowych i informacji. Z grona użyt-
kowników PHP mogę też wymienić wiele
znanych firm: Hewlett-Packard, Boeing,
Lufthansa, Disney Online, Yahoo!, Lycos,
Sprint, T-Mobile, Orange, Wall Street On-
line, Siemens...
Dlaczego tak wiele firm nadal używa
JSP, ASP czy nawet CGI, Perla, TCL i C++
do generowania treści WWW? Nie wiem,
może nie chcą mieszać różnych techno-
logii lub dopiero zaczęli rozważać PHP :).
Pewnie PHP jest jeszcze za młode.
DP: Jakie masz plany na przyszłość?
Dmitry: Podczas pracy nie mam cza-
su na rozmyślanie nad nowymi pomysła-
mi. Większość moich wysiłków skupia
się obecnie na PHP6 (obsługa Unikodu,
ulepszenia języka, dodatkowa optymali-
zacja). Gdy zacznie się zbliżać premiera
PHP6, wtedy wraz z całą społecznością
twórców PHP zaczniemy zapewne zbie-
rać nowe pomysły, które być może trafią
do PHP7.
DP: Dziękuję za rozmowę. n
13
Początki
Programowanie obiektowe
w PHP na przykładzie IRCBota
Marcin Staniszczak
W SIECI
l http://www.faqs.org/rfcs/
rfc2812.html – RFC 2812
opisujące IRC
l http://www.cybernexus.biz/
irc/default.htm – informacje o
IRC w przystępnej formie
l http://www.phppatterns.com
– strona o programowaniu
obiektowym i wzorcach pro-
jektowych w PHP
l http://www.php.net/manual/
en/language.oop5.php – ofi-
cjalny manual PHP, rozdział
nt. obiektowości w PHP5
l http://en.wikipedia.org/wiki/
Anti-pattern – antywzorce,
czyli jak NIE należy progra-
mować
14
Pewnie słyszałeś już termin programowanie
obiektowe i ktoś przedstawiał Ci jego zalety.
Dobrze, ale jak je zastosować w PHP? Wraz
z wersją PHP5 pojawiło się wiele nowych
funkcjonalności, które możesz wykorzystać
w swoich aplikacjach: pokażemy Ci, jak to
zrobić, tworząc prostą, ale użyteczną aplikację
sieciową...
W
raz z nadejściem PHP5 otrzy-
maliśmy w końcu możliwość
pisania programów obiekto-
wych z prawdziwego zdarzenia. Co wię-
cej, ta wersja PHP jest oferowana przez
coraz większą liczbę providerów, co za-
chęca coraz większą liczbę programistów
do korzystania z niej w swoich projektach.
Warto jednak pamiętać, że progra-
mowanie obiektowe wiąże się ze zmia-
ną sposobu myślenia o aplikacji. Teraz
w mniejszym stopniu myślimy o funkcjach
(zwanych w klasach metodami), czyli ze-
stawie instrukcji do wykonania konkret-
nych zadań, a w coraz większym o obiek-
tach modelujących tworzony system.
Czym jest programowanie
obiektowe?
O programowaniu obiektowym już pisali-
śmy na naszych łamach, choćby w arty-
kułach Erika Zoltana „Po co nam PHP5”,
„Medoty magiczne w PHP5”, zamiesz-
czonych w numerze 5/2005. Tym z Was,
www.phpsolmag.org
Stopień trudności: lll
którzy ich nie czytali, przybliżamy w skró-
cie ideę obiektowości. Jej podstawą jest
obiekt – odrębny, zamknięty fragment ko-
du, zawierający metody (czyli funkcje) mo-
gące przeprowadzić określone czynności
oraz pola (czyli zmienne) zwane też atry-
butami lub cechami, które przechowują
dane (np. łańcuchowe, liczbowe czy in-
ne obiekty). To, że obiekt jest zamknięty,
uniemożliwia przypadkowe interakcje je-
go metod i pól z innymi elementami pro-
gramu (np. innymi obiektami), pozwalając
jednocześnie wykorzystać obiekt w dowol-
nym miejscu aplikacji (dając tym samym
Co należy wiedzieć...
Należy znać podstawy programowania
w PHP. Przydatna będzie również znajo-
mość protokołu i usług IRC.
Co obiecujemy...
Pokażemy, jak stworzyć bota IRC-owe-
go, kładąc szczególny nacisk na demon-
strację możliwości obiektowych PHP5.
PHP Solutions Nr 4/2006
 IRCBot – programowanie obiektowe Początki

dużą elastyczność) i nazywa się enkapsu-

lacja, którą omówimy później.
 
Każdy obiekt należy do jakiejś klasy
i jest jej instancją (czyli egzemplarzem),
przykładowo obiekt lampkaPrzyMoimŁóżku 



może należeć do klasy lampkaNocna. Sko-  




jarzenia ze światem materialnym nasuwa-

ją się same: dzięki obiektom łatwo zasy-
mulujemy przedmioty i zjawiska występu-
jące w naszej rzeczywistości. Modelowa-  
  


 
 
nie rzeczywistości zaczynamy od wdraża-
nia głównych cech, a następnie przecho-



 


 



dzimy do kolejnych detali.  


  


  



Kontynuujmy nasz przykład z lampką 





 




nocną. Możemy utworzyć klasę o nazwie
lampkaNocna, która będzie zawierała me-
tody zgaś() i zapal(). Pominiemy mniej
istotne szczegóły, takie jak np. kolor czy Rysunek 1. Klasa lampka i jej klasy pochodne
kształt obudowy lampki. Następnie, chcąc
umieścić lampkę nocną w naszym progra- wystąpią we wszystkich klasach pochod- jedną z najmocniejszych zalet programo-
mie, po prostu utworzymy instancję klasy nych. W przypadku lampy będą to metody wania obiektowego.
lampkaNocna. zapal() oraz zgaś(). Moglibyśmy dodać Teraz bazując na klasie lampka mo-
Co jednak będzie, jeżeli zechcemy za- do niej również pole żarówka, ale co zrobić żemy utworzyć klasy pochodne (dziedzi-
symulować również lampę biurową, lam- z lampami, które zawierają np. świetlów- czące): lampkaNocna oraz lampkaBiurowa.
pę wiszącą czy latarnię uliczną? Czy bę- kę? Rozsądnym wyjściem byłoby utworze- Zwróćmy uwagę, jak bardzo jest to wy-
dziemy za każdym razem tworzyć no- nie drugiej klasy, np. źródłoŚwiatła, z któ- godne. Możemy teraz zasymulować jed-
wą klasę od podstaw (np. lampaWisząca rej będzie korzystać klasa lampka i która nego człowieka (klasa człowiek) potra-
i latarniaUliczna)? Mijałoby się to z sen- również będzie posiadała klasy pochodne. fiącego obsługiwać wszystkie utworzone
sem, gdyż: Dodane właśnie metody zapal() przez nas lampki. Co więcej, podczas pi-
i zgaś() istnieją wewnątrz klasy lampka. sania klasy człowiek nie musimy nawet
• część elementów tych klas (jak meto- Inna, całkowicie odrębna klasa, np. wiedzieć, jakie lampki będzie on obsługi-
dy zgaś() i zapal()) będzie się pokry- znicz, mogłaby mieć metody o takich wał, ani ile ich będzie. Istotne jest tylko,
wała, samych nazwach i nie kolidowałyby one aby dziedziczyły one po klasie lampka.
• jeśli wymodelujesz sobie człowieka w żaden sposób z metodami lampki. To Niestety, nie jest powiedziane, że
(lub robota) obsługującego lampkę, samo dotyczy pól. Dostęp do nich jest nasz człowiek będzie potrafił w pełni wy-
będziesz musiał implementować mu możliwy jedynie przy podaniu nazwy kla- korzystać każdą nową lampkę: klasa po-
obsługę każdej lampki z osobna. sy (lub jej obiektu), w której zostały zde- chodna może bowiem rozszerzać li-
finiowane. To jest właśnie enkapsulacja stę metod i pól o własne, o których nasz
Lepiej więc byłoby zacząć od utworzenia (lub hermetyzacja): zamknięcie metod człowiek nie będzie nic wiedział (pamię-
bardziej ogólnej klasy lampka, będącej ba- i pól wewnątrz klasy. Bardzo ułatwia ona tajmy, że zna on jedynie klasę lampka).
zą dla wszelkiego rodzaju dziedziczących tworzenie oprogramowania, szczegól- Zobacz Rysunek 1. Prezentujemy tam
po niej lamp, lampek, reflektorów, latarń nie dużych projektów (wystarczy sobie klasy wszystkich lampek włącznie z no-
czy latarek kieszonkowych. Ta podstawo- wyobrazić jakikolwiek interfejs graficz- wą, którą jest klasa LampkaPrzyciemniana,
wa lampa powinna zawierać wyłącznie ny, w którym najmniejszy przycisk ma kil- symulująca lampkę z regulacją jasno-
najbardziej ogólne pola i metody: te, które kadziesiąt własnych cech i funkcji) i jest ści (sciemniaczem). Obok standardo-
wych metod zapal() oraz zgaś() posia-
da ona także metody rozjaśnij() oraz
Programowanie obiektowe – historia i teraźniejszość sciemnij(). Nasz człowiek potrafiący ob-
Programowanie obiektowe jest już dojrzałą metodologią projektowania oprogramowa- służyć obiekty klasy lampka, po której
nia komputerowego. Stworzona już w 1967 roku Simula posiadała pewne cechy języka
dziedziczy nasza lampkaPrzyciemniana,
obiektowego, zaś w latach 70. ubiegłego wieku Xerox pracował nad językiem Smalltalk
– do dziś niedoścignionego wzorca w dziedzinie obiektowości. Z bardziej znanych, często będzie potrafił ją zapalić oraz zgasić, ale
stosowanych języków wystarczy wymienić C++ czy Javę. Przed pojawieniem się PHP5, nie będzie umiał jej przyciemnić czy rozja-
w PHP było znacznie gorzej: teoretycznie już w PHP4 można było korzystać z pewnych śnić. Niestety, nie można mieć wszytego.
technik obiektowych, ale było to niewydajne i zawodne. Prawdziwy, rewolucyjny przełom
Istnieją co prawda sposoby obejścia tego
nastąpił wraz z nadejściem PHP5, która oferuje nowy, solidny silnik obiektowy oraz wie-
le użytecznych cech, których poprzednio brakowało, a które czynią z PHP język obiektowy problemu, nie są one jednak tak elastycz-
z prawdziwego zdarzenia. ne i nie są w pełni zgodne z podejściem
obiektowym.

PHP Solutions Nr 4/2006 www.phpsolmag.org 15

Początki IRCBot – programowanie obiektowe

Podsumowując, najistotniejsze cechy klasy (tego, czy będzie to klasa ba-

programowania obiektowego to: zowa, czy określona klasa pochod- Szybki start IRCBota
na – można to sprawdzić) czy od ilo- Jeśli chcesz sprawdzić, jak działa nasz
• Abstrakcja – oznacza, że każda kla- ści lub typu parametrów (przeciąże- bot, pobierz jego źródła z naszej strony
WWW. Możesz go uruchomić z linii pole-
sa w programie opisuje pewien model nie parametrów). Przykładowo, meto-
ceń lub w przeglądarce internetowej.
rzeczywistości, będąc najczęściej swo- da zapal() może działać zupełnie ina- Przed uruchomieniem bota musisz
istą abstrakcją obiektów rzeczywistych czej w przypadku lampki nocnej z ża- go skonfigurować. Ustawienia znajdują
(jak nasza lampka). Dzięki temu progra- rówką, niż w przypadku lampy sufito- się w pliku Configuration.class.php. Po-
nadto musisz zmodyfikować wpis w pli-
mista może operować bezpośrednio na wej ze świetlówką.
ku admins – zmień tam nicka oraz host,
modelowanych obiektach, modyfiko- • Dziedziczenie – możliwość tworzenia spod którego będziesz się łączył z ser-
wać oraz poznawać ich aktualny stan. klas pochodnych opartych o klasę ba- werem IRC (nie dodawaj ręcznie nowych
• Enkapsulacja (hermetyzacja) – za- zową. użytkowników – po zalogowaniu się mo-
żesz nimi zarządzać za pomocą komend
mknięcie metod i pól wewnątrz klasy,
add_admin: oraz remove_admin: – pa-
co wyklucza ich ewentualne kolizje z Obiektowość w PHP5 miętaj o dwukropku).
metodami i polami innych klas. Dzięki Dzięki nowemu silnikowi PHP, Zend II, Aby uruchomić bota z linii poleceń,
niej każda klasa jest odrębnym bytem. modelo obiektowy PHP5 jest niezawod- przejdź do jego katalogu i wydaj pole-
cenie: php ConsoleBOT.class.php. Pa-
W połączeniu z możliwością określe- ny i wydajny i ma wiele nowych cech, ta-
miętaj, że aby to polecenie zadziała-
nia widoczności zmiennych (publicz- kich jak: ło, potrzebujesz odpowiednio ustawio-
ne, prywatne lub chronione – omówi- nej ścieżki PATH: musi ona wskazywać
my to później), enkapsulacja stanowi • możliwość określenia widoczności na katalog z PHP. Alternatywnie, możesz
podać pełną ścieżkę dostępu do progra-
jedną z najmocniejszych zalet progra- (ang. visibility) każdej metody czy po-
mu php (lub php.exe pod Windows).
mowania obiektowego. la, czyli dostępu do niej, podobnie jak Aby uruchomić bota w przeglądar-
• Polimorfizm – zapewnia możliwość ma to miejsce np. w Javie czy C++. ce internetowej, skopiuj jego pliki do ka-
wykonywania różnych działań przez Cecha ta określa, czy metoda (lub po- talogu, do którego ma dostęp twój ser-
wer HTTP (np. Apache lub IIS), a następ-
tę samą metodę, np. w zależności od le) ma być publiczna (dostępna dla
nie wywołaj w przeglądarce skrypt Web-
BOT.class.php. Po uruchomieniu bota
możesz się do niego zalogować – wyślij
Czym jest IRC do niego prywatną wiadomość o treści:
IRC jest jedną z usług internetowych. Protokół IRC został stworzony w roku 1988 roku
login: test. Wszelkie komendy wyda-
przez Jarkko Oikarinena. Umożliwia prowadzenie pogawędek internetowych, będąc proto-
wane botowi mają postać: komenda: pa-
plastą dzisiejszych czatów, które są dostępne na wielu witrynach internetowych. W przeci-
rametry oddzielone spacjami. Dwukro-
wieństwie jednak do czatów, IRC nie jest w żaden sposób powiązany ze stronami WWW,
pek po instrukcji jest wymagany nawet,
lecz ma swoje serwery i oprogramowanie klienckie, którego potrzebujemy do prowadzenia
gdy nie przyjmuje ona parametrów, np.
konwersacji. Najpopularniejsze programy klienckie IRC to:
disconnect:.
• mIRC – komercyjny, dość wygodny w obsłudze program dla systemu Windows (http://
www.mirc.com/)
• ViRC – darmowy, całkiem dobry i rozbudowany klient IRC dla Windows (http://
wszystkich), prywatna (dostępna tyl-
www.visualirc.net/) ko dla klasy, w której została zdekla-
• XiRCON – inny darmowy klient IRC dla Windows (http://www.xircon.com/) rowana), czy też chroniona (dostępna
• ShadowIRC – klient IRC dla Macintosha (http://www.shadowirc.com/) dla klasy, w której została zdeklarowa-
• ircII – klient IRC dla systemu UNIX (http://www.eterna.com.au/ircii/)
• Chatzilla – IRC w Twojej przeglądarce, czyli plugin dla Firefoksa oraz Mozilli (http://
na oraz jej klas pochodnych).
chatzilla.hacksrus.com/) • wprowadzenie do klas destruktorów,
które pozwalają posprzątać po likwi-
Po połączeniu się z serwerem, korzystamy z komend wydawanych w linii poleceń progra- dowanym obiekcie (powiemy o nich
mu klienckiego, z których najważniejsze to:
później),
• /server nazwa _ serwera – łączy się z wybranym serwerem, • ujednolicenie nazw konstrukto-
• /join #nazwa _ kanału – wchodzi na określony kanał (jeżeli jesteśmy połączeni rów (__construct()) i destruktorów
z serwerem),
(__destruct()) dla wszystkich klas,
• /msg nick wiadomość – wysyła prywatną wiadomość do użytkownika o określonym
nicku, • możliwość automatycznego ładowa-
• /say wiadomość – wysyła informację do aktywnego okna, dla wszystkich użytkowni- nia klas, bez konieczności używania
ków (w większości klientów wpisywanie say nie jest potrzebne). instrukcji typu include czy require
(nie jest to co prawda związane bez-
Komend IRC jest o wiele więcej. Ich pełną listę znajdziemy na stronach większości progra-
mów klienckich oraz w ich manualach. pośrednio z programowaniem obiek-
Bardzo dużo jest również serwerów IRC i są one rozsiane po całym świecie. Więk- towym, jednak często bardzo ułatwia
szość z nich jest połączona w większe sieci (będąc podłączonymi do jednego serwe- pracę),
ra z takiej sieci możemy rozmawiać z osobami podłączonymi do innych), takie jak bar-
• wprowadzenie klas abstrakcyjnych
dzo popularny w Polsce IRCNet (w każdej chwili jest tam ok. 12000 polskich użytkowni-
ków), zobacz www.irc.pl. Oto kilka polskich serwerów należących do tej sieci IRC: – war- oraz interfejsów (opiszemy je dokład-
szawa.irc.pl, krakow.irc.pl, poznan.irc.pl, lublin.irc.pl. Z serwerami tymi łączymy się korzy- niej w dalszej części artykułu),
stając z portów od 6661 do 6667. Warto także odwiedzić serwer irc.php.pl, a na nim kanał • możliwość deklarowania pól oraz me-
#php.pl – oficjalny serwer IRC polskiego serwisu o PHP – www.php.pl. Serwer ten dodat-
tod statycznych (static), dostępnych
kowo oferuje kanał #test, na którym możemy swobodnie testować swojego bota.
bezpośrednio w klasie, a nie jej instan-

16 www.phpsolmag.org PHP Solutions Nr 4/2006

 IRCBot – programowanie obiektowe Początki

cji. Teoretycznie było to możliwe już tyczące operatorów i botów wyjaśniamy

w PHP4, ale wersja 4 pozwalała na ta-
kie traktowanie dowolnych metod i pól,
co nie jest wskazane,
• możliwość deklarowania klas oraz me-
tod jako finalne (po klasach finalnych
nie można dziedziczyć, zaś metod fi-
nalnych przykryć (przedefiniować),
czyli dopasować ich zachowania do
wymagań klasy pochodnej),
• wprowadzenie obsługi błędów w po-
staci wyjątków, których tu nie opisze-
my (poświęciliśmy im inne artykuły,
w tym „Obsługa błędów za pomocą
wyjątków SPL”, z numeru „PHP Solu-
tions 2/2005).
Nowości dotyczących programowania
obiektowego jest znacznie więcej. Już te
wymienione pokazują, jak zaawansowa-
nym językiem obiektowym stał się PHP5.
Pokażemy te możliwości na przykładzie
praktycznej aplikacji: stworzymy bota dzia-
łającego w sieciach IRC.
w Ramce Opy i boty na IRC.
Dodajmy, że bot jest skryptem działa-
jącym jak klient IRC. Przeważnie pracuje
w linii poleceń, np. na tej samej maszynie,
na której stoi serwer IRC (choć nie jest to
konieczne), a wywołujemy go korzystając
z telnetu czy ssh. Nasz bot będzie mógł
działać zarówno w taki sposób, jak i za
pośrednictwem przeglądarki internetowej,
w której będzie aktywny aż do zamknię-
cia jej okna.
Czego jeszcze potrzebujemy? Zna-
jomości podstaw specyfikacji protokołu,
na którym oparte są aplikacje klienckie
IRC. Jest on dosyć dobrze opisany (m.in.
w RFC 2812), nie powinieneś więc mieć
problemu z zagłębieniem się w jego tajniki
(zob. Ramka Protokół IRC w sieci).
Koncepcja IRCBota
Zanim przystąpimy do tworzenia naszego
IRCBot-a, zastanówmy się, jakimi cechami
powinien się on wyróżniać. Są wśród nich:
Protokół IRC w sieci
Oficjalny opis protokołu klienta IRC zaj-
muje 63 strony i jest opisany w dokumen-
cie RFC 2812 pt. Internet Relay Chat:
Client Protocol. Dokument ten znajdzie-
my w wielu miejscach w Internecie, m.in.
pod adresem http://www.faqs.org/rfcs/
rfc2812.html.
Suchy opis protokołu nie jest jed-
nak zbyt przyjazny. Zachęcamy więc
do rozpoczęcia lektury od strony http://
www.cybernexus.biz/irc/default.htm.
Znajdziesz tam wprowadzenie do pro-
tokołu oraz przykładowe logi komunika-
cji klienta IRC z serwerem, wraz z wyja-
śnieniami.
• odbieranie i wykonywanie poleceń wy-
dawanych wyłącznie przez zalogowa-
nych do niego użytkowników,
• śledzenie wydarzeń (ang. events) za-
chodzących na wybranym kanale,
• możliwość pracy na wielu serwerach
i kanałach IRC jednocześnie,
• modularna budowa, pozwalająca na
dodawanie:

Tworzymy obiektowego
IRCBota
Naszego bota nazwiemy IRCBot. Będzie
to skrypt, który działa na kanale IRC uda-
jąc zwykłego użytkownika i pełniąc rozma-
ite funkcje potrzebne administratorowi, ta-
kie jak piilnowanie porządku na tym ka-
nale, nadawanie statusu Opa (operato-
ra) wybranym osobom, czy ich wyrzucanie
(wykopywanie, ang. kick) z kanału.
Jeśli nie znasz świata IRC, zajrzyj
do Ramki Czym jest IRC; szczegóły do-
Opy i boty na IRC
W IRCNecie (a także w wielu innych sie-
ciach IRC, które nie posiadają możliwo-
ści rejestrowania kanałów; dziś wiele no-
wych sieci oferuje taką funkcję), pierw-
sza osoba wchodząca na kanał otrzymu-
je status tzw. Opa (operatora czy admi-
nistratora).
Jego uprawnienia są ogromne – mo-
że on ustalać temat kanału (np. Dysku-
sja o PHP6), nadawać status Opa innym
użytkownikom kanału, wyrzucać z niego
niechciane osoby czy zabraniać im po-
nownego wstępu udzialając tzw. bana
(ang. ban znaczy zakaz) na wybranego
nicka lub hosta.
Niestety, w momencie opuszcze-
nia kanału, Op traci swoje uprawnienia.
Aby temu zaradzić, administratorzy sto-
sują boty. Jak już wspomnieliśmy, bot to
skrypt udający zwykłego użytkownika ka-
nału (niektórzy nazywają go „sztuczną in-
teligencją”, ale jest to raczej określenie
na wyrost). Jego zadaniem jest przyjmo-
wanie i wykonywanie poleceń Opa.
Listing 1. Klasa konfiguracyjna bota
<?php
class Configuration {
static public $arrConfiguration = array (
'bot' => array ( /* Konfiguracja bota */
'Nick' => 'AlaMaKota', /* Nick bota na serwerach */
'Password' => '', /* Hasło do serwera – najczęściej puste */
'Ident' => 'MSBot', /* identyfikator bota */
// Prawdziwa nazwa użytkownika (nazwa i wersja bota)
'Realname' => 'MSBot R1',
'QuitMessage' => 'Idę sobie...', // informacja pożegnalna
'Host' => 'localhost', /* Nazwa hosta z pod jakiego łączy się bot */
),
// serwery, z którymi bot ma się połączyć po uruchomieniu
'Servers' => array (
array (
'Host' => 'irc.php.pl', // host serwera
// Tablica z portami obsługiwanymi przez serwer
'Ports' => array ('6667'),
// tablica z kanałami serwerów, na które bot ma wejść
'Channels' => array ('#test'),
// czy komunikaty idą z/do serwera mają być logowane
'Logging'=>true,
),
),
/* Klasy eventy */
'Events' => array (
'KickReJoinEvent',
),
'System' => array (
/* Plik z informacjami o administartorach */
'AdminsFile' => 'Configuration\admins',
'LoggingClass' => 'FileLogging', /* klasa zapisująca logi */
'LogsDir'=>'logs/', // Katalog w którym mają być zapisywane logi
),
);
}
?>

PHP Solutions Nr 4/2006 www.phpsolmag.org 17

Początki IRCBot – programowanie obiektowe
• obsługi nowych zdarzeń (eventów wy-
stępujących na danym kanale (np. wy-
kopania użytkownika). Każde zdarze-
nie będzie obsługiwane przez odręb-
ny moduł,
• nowych komend – bot będzie odbierał
komendy wysyłane do niego jako pry-
watne wiadomości,
• możliwość pracy zarówno w linii pole-
ceń, jak i w oknie przeglądarki.
Nasza aplikacja ma być w pełni obiekto-
wa, czyli składać się z klas realizujących
określoną funkcjonalność. Zastanówmy
się teraz, jakich klas potrzebujemy.
Klasy IRCBota
Bot będzie się składał z następujących
klas:
• Configuration – zawrzemy w niej spis
wszystkich ustawień naszego progra-
mu (m.in. nazwę użytkownika, adresy
i porty serwerów, listę obsługiwanych
wydarzeń, itd.),
• IRCBot – główna klasa IRCbota, odpo-
wiadająca za inicjalizację i komunika-
cję z serwerami, a także obsługę wy-
darzeń i komend,
• Server – będzie ona zapewniała ko-
munikację z wybranym serwerem IRC
(m.in. nawiązanie i zakończenie połą-
czenia),
• Channel – klasa odpowiadająca jedne-
mu kanałowi, na którym przebywa bot,
• Event – klasa bazowa dla klas obsłu-
gujących zdarzenia,
• ILogging – nie jest klasą, lecz interfej-
sem, który jest potrzebny do logowa-
nia komunikatów,
• Admin – odpowiada za zapamiętywa-
nie i zarządzanie zalogowanymi użyt-
kownikami.
Konfiguracja
– klasa Configuration
Zaczniemy od klasy Configuration. Jak
już wiemy, jej zadaniem będzie prze-
chowywanie ustawień naszego bo-
ta: będzie się ono odbywało w zmien-
nej statycznej (ang. static) o nazwie
$arrConfiguration. Nazwa celowo roz-
poczyna się od arr (skrót od array), aby
ułatwić rozpoznawanie typu zmiennej.
Stosowanie takiej zasady ułatwia póź-
niejsze modyfikacje i pielęgnację kodu.
Zmiennej mogącej przechowywać da-
ne różnego typu nadalibyśmy przedro-
stek mix.
18
Listing 2. Klasa IRCBot
abstract class IRCBot {
static public $strVersion = '0.1.0';
protected $arrServers = array();
private $arrServerLogs = array();
private $arrEvents = array();
private $objAdmins;
public function __construct() {
$this->objAdmins = Admin::getInstance($this);
$this->registerEvent('CommandEvent');
$this->registerEvent('AdminLogoutEvent');
foreach (Configuration::$arrConfiguration['Events'] as $strEvent) {
$this->registerEvent($strEvent); }
}
public function __destruct() { $this->show(' ', ' ', '--- END --- '); }
public function run() {
foreach (Configuration::$arrConfiguration['Servers'] as $arrServer) {
$this->connect($arrServer); }
for (;;) {
if (count($this->arrServers)===0) { return; }
usleep(50000); $this->ircProc(); // przetwarzamy komunikaty z serwera
}
}
public function connect($arrServer) {
if (isset($arrServer['Logging']) && $arrServer['Logging']===true) {
$this->arrServerLogs[$arrServer['Host']] = new FileLogging($arrServer[
'Host']); }
$this->arrServers[$arrServer['Host']] = new Server($arrServer,
Configuration::$arrConfiguration['bot'], $this);
$this->arrServers[$arrServer['Host']]->connect();
}
public function getServers() { return $this->arrServers; }
protected function ircProc() {
foreach ($this->arrServers as $objServer) {
$mixData = null;
if (($objServer !== null) &&
(($arrData = $objServer->serverProc()) !== false) &&
$arrData !== true) { $this->executeEvents($objServer, $arrData); }
elseif ($objServer !== null && $arrData !== true) {
$objServer->disconnect();
$this->arrServers = array_diff_key(
$this->arrServers,array($objServer->getName()=>''));
}
}
}
public function executeEvents($objServer, $arrData) {
if (isset($this->arrEvents[$arrData['type']])) {
foreach ($this->arrEvents[$arrData['type']] as $objEvent) {
$objEvent->execute($objServer, $arrData); }
}
}
public function log($strServer, $strDirection, $strContent) { }
public function registerEvent($strEventName) {
if(file_exists(ROOT_DIR.'Events'.
DIRECTORY_SEPARATOR.$strEventName.'.class.php')) {
require_once(ROOT_DIR.'Events'.
DIRECTORY_SEPARATOR.$strEventName.'.class.php');
$objEvent = new $strEventName($this);
if (!($objEvent instanceof Event)) {
$this->show(' ',' ',"Nieznany typ klasy obsługującej zdarzenia
($strEventName)"); }
foreach ($objEvent->getEventNames() as $strEvent) {
$this->arrEvents[$strEvent][] = $objEvent; }
} else { $this->show(' ', ' ', "Brak klasy zdarzenia ($strEventName)"); }
}
abstract public function show($strServer, $strChannel, $strContent);
}
www.phpsolmag.org PHP Solutions Nr 4/2006
 Początki

Na Listingu 1 znajduje się przykłado- tej zmiennej ($arrConfiguration) oraz (po-

wa konfiguracja naszego bota. Jak widzi-
my, w zmiennej $arrConfiguration określa-
my dane bota (klucz bot, m.in. nick, hasło,
identyfikator, prawdziwą nazwę czy ho-
sta, spod jakiego łączy się bot), serwerów
(klucz Servers), z którymi się łączy, zestaw
obsługiwanych zdarzeń (klucz Events) czy
dane systemowe (klucz System), m.in.
ścieżka do pliku z informacjami o admi-
nistratorach, katalog zawierający logi czy
nazwa klasy, która je zapisuje.
Dlaczego użyliśmy zmiennej sta-
tycznej? Ze względu na łatwość dostępu
do niej: zamiast tworzyć instancję klasy
Configuration (co w tym przypadku byłoby
jedynie dodatkowym, zbędnym krokiem
do wykonania, gdyż konfiguracja jest jed-
na dla całego programu), odwołujemy się
bezpośrednio do samej klasy. Przykłado-
wo, aby odczytać nick bota, wpiszemy:
Configuration::$arrConfiguration[’bot’]
[’Nick’];
Czyli podajemy najpierw nazwę klasy za-
wierającej zmienną statyczną (Configura-
tion), a następnie, po znakach ::, nazwę
nieważ jest to tablica asocjacyjna ) jej wy-
brany klucz. Gdybyśmy chcieli odwołać
się do zmiennej statycznej bezpośrednio
z wnętrza klasy, w której ona została zde-
finiowana, użylibyśmy słowa kluczowego
self, wskazującego na bieżącą klasę:
self::$arrConfiguration[’bot’][’Nick’];
Zauważmy, że zmienne statyczne tworzy-
my z wykorzystaniem słowa kluczowego
static. Wyraz public oznacza natomiast,
że jest to zmienna publiczna, czyli dostęp
do niej jest możliwy również spoza klasy.
Słowo to możemy pominąć (zmienna jest
domyślnie typu public), ale nie należy te-
go robić, gdyż jego użycie porządkuje kod
i ułatwia pracę programistom korzystają-
cym z innych języków, takich jak Java.
Klasa IRCBot
Jak już wiemy, IRCBot to główna klasa na-
szego bota. Będzie ona odpowiadała za
nawiązywanie połączeń z serwerami, ob-
sługę (w pętli) komunikatów przychodzą-
cych z serwerów, rejestrowanie klas zda-
rzeń (eventów), a także zapisywanie lo-

Listing 3. Szablon klasy Server

class Server {
private $arrConfiguration, $arrServerConfig, $resFP, $objBot;
private $arrChannels = array(), $strPort = '';
public function __construct($arrServerConfig,$arrConfiguration,IRCBot $objBot){
if (!isset($arrServerConfig['Host']) ||
!isset($arrServerConfig['Ports'])) {
throw new Server_Exception('Server configuration error!');
}
$this->arrServerConfig = $arrServerConfig;
$this->arrConfiguration = $arrConfiguration;
$this->objBot = $objBot;
}
public function connect() { }
public function disconnect($strReason=null) { }
public function join($strChannel) {
$this->arrChannels[$strChannel]=new Channel(
$this, $this->objBot, $strChannel);
$this->arrChannels[$strChannel]->join();
return $this->arrChannels[$strChannel];
}
public function getChannel($strChannel) {
if (isset($this->arrChannels[$strChannel])) {
return $this->arrChannels[$strChannel];
} else { return false; }
}
public function getName() { return $this->arrServerConfig['Host']; }
public function getPort() { return $this->strPort; }
public function getChannels() { return array_keys($this->arrChannels); }
public function send($strCommand) { }
public function serverProc() { }
}
class Server_Exception extends Exception {}

PHP Solutions Nr 4/2006 www.phpsolmag.org 19

Początki IRCBot – programowanie obiektowe
gów w plikach oraz wyświetlanie komu-
nikatów w konsoli lub na stronie WWW.
Przyjrzyjmy się Listingowi 2.
Pierwszym, co rzuca się w oczy, jest
słowo abstract w linii deklaracji klasy.
Określa ono, że klasa jest abstrakcyjna,
co oznacza, że nie można bezpośrednio
utworzyć jej instancji. Tym określeniem
opatrzona jest również metoda show().
Po co używamy abstract? Jak pamię-
tamy, chcemy móc używać naszego bo-
ta w konsoli lub na stronie WWW. W tym
celu utworzymy klasy pochodne wobec
IRCBot, które będą się od niej różniły głów-
nie zawartością metody show(). Zadekla-
rowanie tej ostatniej jako abstract wymu-
sza jej zaimplementowanie (przypisanie
jej bloku kodu, choćby pustego) w klasie
pochodnej. Zastosowanie abstract chroni
nas więc przed utworzeniem instancji nie-
kompletnej klasy IRCBot, co wymusza pe-
wien porządek w kodzie PHP5.
Zauważmy również, że implementa-
cja większości metod jest pusta: to rów-
nież jest celowe i spowodowane tym, że
samo wdrożenie komunikacji bota z ser-
werem nie jest tematem tego artykułu,
a kompletny kod źródłowy można zoba-
czyć na naszej stronie WWW.
Przyjrzyjmy się teraz metodzie
__construct(), czyli konstruktorowi kla-
sy IRCBot. Metoda ta jest automatycznie
wywoływana podczas instancji klasy. Jej
przeznaczenie zależy wyłącznie od nas
– przeważnie dokonujemy w niej inicjali-
zacji klasy, np. przypisywania wartości do-
myślnych określonym polom. Możemy też
wykonywać w konstruktorze czynności bę-
dące celem istnienia klasy – wybór nale-
ży do nas.
Instancję klasy tworzymy natomiast za
pomocą operatora new:
$zmienna = new NazwaKlasy($parametry);
Po operatorze new podajemy nazwę
tworzonej klasy, a w nawiasie parame-
try, których oczekuje konstruktor (al-
bo pusty nawias, jeżeli ich nie wymaga).
W przypadku klasy IRCBot, konstruktor
inicjalizuje prywatne pole $objAdmins (jak
wskazuje jego nazwa, pole to ma przecho-
wywać obiekt pewnej klasy, w tym przy-
padku Admin), rejestruje standardowe zda-
rzenia, które muszą istnieć: CommandEvent
(obsługa komend przysyłanych do bota ja-
ko wiadomości prywatne przez Opa) oraz
AdminLogoutEvent (umożliwia wylogowa-
nie wybranego administratora), a następ-
20
nie w pętli foreach rejestruje inne zda- łamy metodę show(), wskutek czego w kon-
rzenia, które zostały zapisane w zmien- soli lub w oknie przeglądarki pojawi się na-
nej $arrConfiguration['Events'] w klasie pis ---- END ----. Zwróćmy teraz uwagę
Configuration. Pamiętajmy, że te ostatnie na słowo kluczowe $this, używane również
są opcjonalne, a ich dobór zależy od nas. w konstruktorze klasy IRCBot. Jest ono
Przyjrzyjmy się zdarzeniu Command- specjalną zmienną symbolizującą obiekt
Event. Ma ono swoją klasę, CommandEvent, bieżącej klasy i umożliwia odwoływanie się
która jest wykonywana w wyniku zdarze- z jego wnętrza do jego pól i metod:
nia PRIVMSG (wysłanie komunikatu prywat-
nego do bota).Analogicznie, jak przy two- $this->objAdmins()
rzeniu obiektu, podczas jego niszczenia $this->run()
PHP5 również wywołuje metodę: jej nazwą
jest zawsze __destruct(). Nie posiada ona Aby odwołać się do atrybutów lub me-
(i nie może posiadać) żadnych parame- tod danego obiektu z zewnątrz (z po-
trów. Wykorzystujemy ją do sprzątania po ziomu kodu, w którym została utworzo-
likwidowanym obiekcie klasy (np. zamyka- na instancja klasy, np. z programu głów-
nia lub kasowania plików). W klasie IRCBot nego czy wnętrza innej klasy) zamiast
użyjemy jej, aby poinformować użytkowni- $this używamy nazwy tego obiektu, np.
ka o końcu pracy bota – w tym celu wywo- $instancja->run();.
Listing 4. Klasa Channel
class Channel {
private $strChannelName, $objServer, $objBot;
public function __construct(Server $objServer, IRCBot $objBot,
$strChannelName) {
$this->strChannelName = $strChannelName;
$this->objServer = $objServer;
$this->objBot = $objBot;
}
public function join() {
$this->objBot->show($this->objServer->getName(), '',
"Joint to {$this->strChannelName} channel");
$this->objServer->send("JOIN {$this->strChannelName}");
}
public function leave() {
$this->objBot->show($this->objServer->getName(), $this->strChannelName,
"Leave {$this->strChannelName} channel");
$this->objServer->send("PART {$this->strChannelName}");
}
}
Listing 5. Klasa Event
abstract class Event {
protected $objBot;
public function __construct(IRCBot $objBot) {
$this->objBot = $objBot;
}
abstract public function getEventNames();
abstract function execute(Server $objServer, $arrData);
}
Listing 6. Przykładowa klasa obsługująca zdarzenie KICK
class KickReJoinEvent extends Event {
public function getEventNames() { return array('KICK'); }
public function execute(Server $objServer, $arrData) {
$strChannel = substr($arrData['message'], 0,
strpos($arrData['message'], ' ')+1);
$objServer->join($strChannel);
$this->objBot->show($objServer->getName(), $strChannel, 'ReJoin');
}
}
www.phpsolmag.org PHP Solutions Nr 4/2006

Warto wiedzieć, że niektóre zaawan-
sowane edytory programistyczne gro-
madzą dane o strukturze zadeklarowa-
nych klas i umożliwiają podpowiadanie
pól i metod po wpisaniu $this-> czy na-
zwy obiektu.
Po stworzeniu naszej klasy musimy
wywołać metodę run(), która urucha-
mia bota i zawiera jego główną petlę.
Nawiązuje ona połączenie z serwerami
znajdującymi się w tablicy $arrConfigura
tion['Servers'] w klasie Configuration
oraz uruchamia pętlę obsługującą zda-
rzenia pochodzące od poszczególnych
serwerów.
Do nawiązywania połączenia z ser-
werami wykorzystywana jest metoda
connect() klasy IRCBot, do której prze-
kazujemy (przez parametr) ustawienia
danego serwera:
$this->connect($arrServer);
Sama metoda connect() tworzy obiek-
ty klasy Server i zapamiętuje je w tablicy
asocjacyjnej $this->arrServers:
$this->arrServers[$arrServer['Host']]=
new Server(
$arrServer,Configuration::
$arrConfiguration['bot'],$this);
Jak widzimy, indeksami tej tablicy są ad-
resy hostów poszczególnych serwerów
– ułatwi to odwoływanie się do obiektów
konkretnych serwerów. Zauważmy też,
że zanim metoda connect() nawiąże po-
łączenie, sprawdza, czy ma ono być lo-
gowane. Jeżeli tak, tworzona jest instan-
cja odpowiedniej klasy (podanej w kla-
sie konfiguracyjnej, albo domyślnej klasy
FileLogging), do której wrócimy w dalszej
części artykułu.
Obsługa komunikatów odbieranych
z serwerów przebiega w nieskończo-
nej pętli for(;;), którą moglibyśmy też
zapisać jako while(true). Zaczynamy
w niej od sprawdzenia, czy tablica $this-
>arrServers zawiera jakiekolwiek ser-
wery (jej rozmiar, odczytany za pomocą
count() jest różny od zera): jeżeli nie, pro-
gram kończy pracę. Następnie wywołuje-
my metodę ircProc(), która dla każdego
z serwerów (w pętli foreach) znajdujących
się w tablicy $arrServers wywoła metodę
serverProc() obiektu klasy Server, a po
otrzymaniu komunikatów z serwera wy-
kona odpowiednie dla tych komunikatów
zdarzenia.
PHP Solutions Nr 4/2006
IRCBot – programowanie obiektowe Początki
Kolejną ważną metodą jest register- nazwie NazwaKlasy.class.php. Jeśli nie,
Event(). Służy ona do rejestrowania no- wyświetla informację o błędzie.
wych typów zdarzeń, czyli dodawania klas W przeciwnym wypadku metoda
je obsługujących. Nazwa klasy zdarzenia registerEvent() dołącza ten plik do
jest przekazywana przez parametr. Meto- skryptu (require_once), a następnie two-
da registerEvent() sprawdza następnie, rzy obiekt klasy o nazwie przekazanej
czy w katalogu Events znajduje się plik o w następującym parametrze:
Listing 7. Przykładowa klasa implementująca interfejs ILogging
class FileLogging implements ILogging {
private $resFP = null;
public function __construct($strFile) {
// otwieramy plik do zapisu logów
$strDir = isset(Configuration::$arrConfiguration['System']
['LogsDir']) ?Configuration::$arrConfiguration['System']
['LogsDir'] :'';
if (($this->resFP=fopen($strDir.urlencode($strFile).'.log','a'))
=== false) {
throw new IRCBot_Exception('Failed to open log file('.
$strDir.urlencode($strFile).'.log'.')');
}
$strDate = date('\[Y-m-d H:i:s\]');
fwrite($this->resFP, "\n\n$strDate\t \t==> BEGIN <==\n\n");
}
public function __destruct() { fclose($this->resFP); }
public function log($strServer, $strDirection, $strContent) {
// jeżeli istnieje komunikat, zapisujemy go w logu
if (strlen(trim($strContent))<1) {
return; }
$strDate = date('\[Y-m-d H:i:s\]');
fwrite($this->resFP, "$strDate\t$strDirection\t$strContent\n");
}
}
Listing 8. Przykładowa klasa implementująca interfejs ILogging
class Admin {
private static $objThis = null;
private function __construct(IRCBot $objIRCBot) {
$this->objIRCBot = $objIRCBot;
$this->reloadAdminsList();
}
static public function getInstance(IRCBot $objIRCBot) {
if (!isset(self::$objThis)) { self::$objThis = new self($objIRCBot); }
return self::$objThis;
}
}
Listing 9. Funkcja __autoload wczytująca automatycznie pliki z naszymi klasami
function __autoload($strClassName) {
static $arrClassesMap = array (
'Configuration' => 'Configuration/Configuration.class.php',
'IRCBot' => 'IRCBot.abstract.class.php',
'Server' => 'Server.class.php',
'Channel' => 'Channel.class.php',
'ILogging' => 'Logging.interface.php',
'FileLogging' => 'FileLogging.class.php',
'Event' => 'Event.abstract.class.php',
'Command' => 'Command.abstract.class.php',
'Admin' => 'Admin.class.php',
);
if (isset($arrClassesMap[$strClassName])) {
require($arrClassesMap[$strClassName]);
}
}
www.phpsolmag.org 21
Początki IRCBot – programowanie obiektowe

$objEvent = new $strEventName($this);
Zwróćmy uwagę na przekazanie zmiennej
$this jako parametru dla konstruktora kla-
sy zdarzenia: w ten sposób przesyłamy do
niej bieżący obiekt klasy IRCBot, z którego
następnie będziemy mogli w pełni korzy-
stać w tej klasie.
Po utworzeniu instancji klasy obsłu-
gującej zdarzenia musimy sprawdzić, czy
obiekt ten jest odpowiedniego typu. Użyje-
my w tym celu operatora instanceof, któ-
ry sprawdza, czy obiekt podany po jego le-
wej stronie jest instancją klasy określonej
po prawej (wyrażenie ma wartość true je-
żeli tak, false jeżeli nie). W naszym przy-
padku, wszystkie klasy zdarzeń będą mu-
siały pochodzić od Event:
Klasa Server
Nadszedł czas na klasę Server, która
również należy do najważniejszych klas
naszego bota. Na Listingu 3 przedsta-
wiamy, jak poprzednio, schemat klasy
(większość metod jest pusta). W przeci-
wieństwie jednak do klasy IRCBot, klasa
Server nie jest abstrakcyjna. Odpowia-
da ona za komunikację z konkretnym
serwerem IRC, a więc między innymi
za nawiązywanie (connect()) oraz koń-
czenie (disconnect()) połączenia. Znaj-
duje się w niej również metoda obsługu-
jąca żądania nadchodzące z serwera
(serverProc()) oraz umożliwiająca wy-
Listing 10. Implementacja klasy głównej bota, wyświetlająca komunikaty w oknie
konsoli
syłanie do niego komend (send()). Wej-
ście na kanał zapewnia metoda join().
W konstruktorze klasy Server zainicja-
lizujemy jej konfigurację oraz utworzymy
$objBot, instancję klasy IRCBot (przekaza-
ną przez parametr).
Sama idea działania tej klasy jest
dość prosta: tworzymy jej instancję we-
wnątrz klasy IRCBot (zob. Listing 1),
a następnie z tego samego miejsca wy-
wołujemy metodę connect(), aby na-
wiązać połączenie z serwerem. Meto-
da ta sprawdza kolejne porty z konfigu-
racji danego serwera (pobrane ze wcze-
śniej ze zmiennej $arrConfiguration

if (!($objEvent instanceof Event)){
$this->show(' ',' ',
"Nieznany typ klasy obsługującej
zdarzenia ($strEventName)");
} echo "$strDate\t$strServer\t$strChannel\t$strContent\n";
Spójrzmy teraz na metodę show() kla-
sy IRCBot. Nie posiada ona ciała (kodu)
i została zadeklarowana jako abstrakcyj-
na (abstract). Możemy się do niej odwo-
ływać w innych metodach (a także z ze-
wnątrz obiektu), ale jej kod utworzymy
dopiero w klasach pochodnych wobec
IRCBot – jak wiemy, umożliwi nam to pod-
mianę tej metody w zależności od tego,
czy chcemy, aby nasz skrypt działał w linii
poleceń, czy w przeglądarce WWW oraz
zapobiegnie uruchomieniu niekompletnej
klasy. Pamiętajmy, że w klasie dziedziczą-
cej po IRCBot będziemy musieli utworzyć
ciało metody show(), chyba, że będzie to
również klasa abstrakcyjna.
Na koniec wyjaśnijmy, czym są sło-
wa public, private oraz protected.
Pozwalają one określić dostęp (zwa-
ny widocznością) do metod i pól naszej
klasy, przed którymi zostały umieszczo-
ne. Znaczenie pierwszego z nich już zna-
my: swobodny dostęp zarówno z wnę-
trza ($this->nazwaPola), jak i z zewnątrz
obiektu ($nazwaObiektu->nazwaPola).
Z kolei private pozwala wyłącznie na
dostęp do pola lub metody w klasie, w któ-
rej zostały zadeklarowane (na zewnątrz
obiektu oraz w klasach pochodnych już
nie). Ostatnie słowo, protected, umożli-
wia dostęp do pola lub metody wyłącznie
dla naszej klasy oraz jej klas pochodnych
(jego zasięg jest więc szerszy niż w przy-
padku private).
require_once('autoload.inc.php');
class ConsoleBOT extends IRCBot {
public function __construct() { parent::__construct(); }
public function show($strServer, $strChannel, $strContent) {
$strDate = date('\[Y-m-d H:i:s\]');
}
}
$objBot = new ConsoleBOT();
$objBot->run();
Listing 11. Implementacja klasy głównej bota, wyświetlająca komunikaty w oknie
przeglądarki internetowej
require_once('autoload.inc.php');
class WebBOT extends IRCBot {
public function __construct() {
echo <<<EOT
<html><head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>IRCBot</title>
</head>
<body>
<table border="1" style="color: white;"><colgroup>
<col span="1" style="background-color: navy"/>
<col span="1" style="background-color: blue"/>
<col span="1" style="background-color: red"/>
<col span="1" style="background-color: gray"/>
</colgroup>
<tr><th>Data</th><th>Serwer</th><th>Kanał</th>
<th>Treść wiadomości</th></tr>\nEOT;
parent::__construct();
}
public function __destruct() {
echo "</table></body></html>";
foreach ($this->getServers() as $objServer) { $objServer->disconnect(); }
}
public function show($strServer, $strChannel, $strContent) {
$strDate = date('Y-m-d H:i:s');
echo
"<tr><td>$strDate</td><td>$strServer</td><td>$strChannel
</td><td>$strContent</td></tr>\n";
flush(); ob_flush();
}
}
$objBot = new WebBOT();
$objBot->run();

22 www.phpsolmag.org PHP Solutions Nr 4/2006


Rysunek 2. IRCBot w konsoli
z klasy Configuration i przekazane kla-
sie Server przez parametr konstruktora)
i łączy się przez pierwszy dostępny. Na-
stępnie informuje użytkownika o połą-
czeniu i wysyła kolejno IRC-owe po-
lecenia PASS, NICK i USER do serwera,
aby się do niego zalogować. Każdemu
poleceniu towarzyszą odpowiednie da-
ne (hasło, nick oraz zestaw: identyfika-
tor, host i prawdziwa nazwa).
Następnie wywoływana jest meto-
da join(), która tworzy obiekty klasy
Channel dla każdego kanału, z którym łą-
czy się nasz bot. Ponieważ możemy się
łączyć z wieloma serwerami, więc za-
rządzanie kanałami w klasie odpowia-
dającej każdemu serwerowi jest bardzo
dobrym wyjściem (każdy serwer może
mieć przecież wiele przypisanych do sie-
bie kanałów).
W konstruktorze klasy Server pojawi-
ła się nowość – podawanie oczekiwane-
go typu parametrów w linii nazwy (dotyczy
parametru $objBot):
public function __construct(
$arrServerConfig,
$arrConfiguration, IRCBot $objBot)
Począwszy od wersji PHP5, możemy
w taki właśnie sposób określić, jaki typ ma
mieć parametr przekazywany do metody
(niestety, nie możemy podać typu stan-
dardowego, np. string – mechanizm ten
działa wyłącznie dla klas). Daje nam to
pewność, że PHP nie pozwoli przekazać
zmiennej innego typu. Przykładowo, gdy-
byśmy spróbowali utworzyć klasę Server,
a zamiast zmiennej typu IRCBot podali np.
łańcuch (string), PHP wyświetli stosowną
informację o błędzie.
PHP Solutions Nr 4/2006
IRCBot – programowanie obiektowe
Klasa Channel
Jest to bardzo prosta klasa odpowia-
dająca jednemu kanałowi, na którym
przebywa bot (jeśli dobrze pamiętasz,
klasa Server tworzy po jednej instancji
klasy Channel dla każdego). Przedsta-
wiamy ją na Listingu 4. Przez konstruk-
tor przekazujemy jej dwa obiekty: klasy
Server oraz IRCBot, a także nazwę ka-
nału. Poza konstruktorem, klasa Channel
ma tylko dwie metody: join() (przyłącze-
nie się do kanału) oraz leave() (opusz-
czenie go). Każda z nich wywołuje zdefi-
niowaną w klasie IRCBot metodę send(),
która z kolei wysyła odpowiednią komen-
dę do serwera IRC: $this->objServer-
>send(komenda);
Dla join() jest to IRC-owa komenda
JOIN,
a dla leave() – PART.
Rysunek 3. IRCBot w przeglądarce internetowej
www.phpsolmag.org
Początki
Oczywiście, komenda zostanie wy-
słana do serwera, na którym znajduje się
kanał – w naszej strukturze klas każdy
kanał (obiekt klasy Channel) jest utworzo-
ny wewnątrz odpowiedniej instancji kla-
sy Server.
Klasa Event
O klasie Event (Listing 5) wspomnieliśmy
już przy okazji klasy IRCBot. Wykorzy-
stywaliśmy ją tam do sprawdzenia typu
klas obsługujących zdarzenia na serwe-
rach IRC. Event jest klasą abstrakcyjną,
gdyż służy wyłącznie jako baza dla innych
klas obsługujących zdarzenia. Jest rów-
nież bardzo prosta w budowie: składa się
z konstruktora, w którym przekazujemy
i inicjujemy instancję klasy IRCBot oraz
dwóch metod abstrakcyjnych:
• getEventNames() – zwraca tablicę
z nazwami zdarzeń, których wystąpie-
nie spowoduje wywołanie obiektu tej
klasy (pochodnej od Event),
• execute() – metoda ta jest wywoły-
wana, gdy wystąpi zdarzenie, które
obsługuje dana klasa (pochodna od
Event).
Ponieważ budowa tak prostej klasy abs-
trakcyjnej niewiele nam powie, przyj-
rzyjmy się dziedziczącej po niej klasie
KickReJoinEvent (dzięki extend Event), ob-
sługującej zdarzenie KICK, czyli wyrzuce-
nie z kanału (Listing 6). Klasa ta powodu-
je ponowne wejście bota na kanał, z które
go został wyrzucony. Obie metody abstrak-
23
Początki IRCBot – programowanie obiektowe
cyjne klasy Event zostały zaimplementowa-
ne w KickReJoinEvent: getEventNames()
zwraca tablicę zawierającą jeden ele-
ment: KICK, a execute() ponownie wywo-
łuje metodę join() obiektu $objServer kla-
sy Server oraz informuje o tym użytkownika
(za pomocą metody show() obiektu $this->
objBot klasy IRCBot).
Interfejs ILogging
Podczas nawiązywania połączenia z ser-
werem, klasa IRCBot uruchamia logowa-
nie komunikatów pochodzących z ser-
wera oraz wychodzących do niego (jeśli
zostało to włączone w konfiguracji). Logo-
waniem zajmuje się osobna klasa, której
nazwa jest również zapisana w konfigura-
cji. Zrobiliśmy tak, bo chcemy mieć możli-
wość wyboru sposobu zapisu logów – np.
w bazie danych czy w pliku. Klasa logu-
jąca musi mieć konstruktor oraz metodę
log(), która będzie zapisywała komunikat
i przyjmowała trzy argumenty: nazwę ser-
wera, kierunek wysyłania komunikatu (OUT
dla komend wychodzących z naszego bo-
ta oraz IN dla wiadomości przychodzących
z serwera) oraz treść komunikatu.
Aby wymusić podstawową zgodność
struktury tej klasy z naszymi oczekiwania-
mi, utworzymy interfejs o nazwie ILogging.
Klasy zajmujące się logowaniem będą
musiały go implementować. Interfejs jest
bardzo podobny do klasy, tyle że nie za-
pewnia implementacji żadnych metod, sta-
nowiąc jedynie swego rodzaju zapowiedź
ich wystąpienia. Do pewnego stopnia mo-
żemy patrzeć na interfejsy jak na klasy
w pełni abstrakcyjne, czyli posiadające wy-
łącznie metody abstrakcyjne. Trzeba pa-
miętać, iż wszystkie metody zadeklaro-
wane w interfejsie muszą być publiczne
(oczywiście słowo kluczowe public można
pominąć). A oto kod naszego interfejsu:
interface ILogging {
public function __construct($strFile);
public function log($strServer,
$strDirection,
$strContent);
}
Każda klasa może implementować dowol-
ną liczbę interfejsów (podczas gdy dzie-
dziczyć może tylko po jednej klasie). Nic
nie stoi również na przeszkodzie, aby da-
na klasa C implementowała interfejs B
i dziedziczyła po klasie A.
Na Listingu 7 przedstawiamy klasę
FileLogging, implementującą interfejs
24
ILogging. Zapisuje ona logi w pliku (przy
pomocy metody log()), którego otwarcie
następuje w jej konstruktorze, a zamknię-
cie – w destruktorze.
Klasa Admin
Klasa Admin odpowiada za zapamiętywa-
nie użytkowników zalogowanych do bota
oraz zarządzanie nimi. Jest ona więc swo-
istą implementacją sesji. Tym, co ją wyróż-
nia od innych, jest fakt, że musi ona mieć
jedną i tylko jedną instancję w całej apli-
kacji. Aby to zapewnić, stworzymy klasę
korzystając z wzorca projektowego (ang.
pattern design: gotowego przepisu na roz-
wiązanie ogólnie znanego problemu pro-
gramistycznego) o nazwie Singleton. Taka
klasa ma prywatny konstruktor, co unie-
możliwia utworzenie jej instancji za pomo-
cą operatora new, a także posiada statycz-
ną metodę zwracającą utworzoną instan-
cję klasy. Spójrzmy na Listing 8.
Jak widzimy, konstruktor klasy jest
prywatny. Do stworzenia instancji klasy
wykorzystywana jest zaś statyczna (sta-
tic) metoda getInstance(), przyjmująca
te same parametry co konstruktor. Spraw-
dza ona, czy w statycznym polu $objThis
znajduje się już utworzony obiekt naszej
klasy. Jeśli nie, to go tworzy, wykorzystu-
jąc do tego słowo kluczowe self (wskazu-
jące na aktualną klasę). Następnie zwraca
obiekt $objThis. Oto, jak należy pobrać in-
stancję klasy typu Singleton:
$obj = Admin::getInstance($parametry);
Pozostałe metody klasy są już typowe:
login() służy do oznaczenia użytkow-
nika na liście jako zalogowanego do bo-
ta, logout() do wylogowania z niego,
serverLogout() do wylogowania bota
z serwera, a reloadAdminsList() do od-
świeżenia informacji o administratorach.
Zadaniem addAdmin() jest dodanie admina
do listy, zaś do removeAdmin() należy usu-
nięcie go z niej. Wreszcie, metoda check()
sprawdza uprawnienia dostępu danego
administratora na określonym serwerze.
Automatyczne
ładowanie klas
Jak wspomnieliśmy na początku arty-
kułu, PHP5 umożliwia automatyczne ła-
dowanie klas. Aby z niego skorzystać,
należy utworzyć specjalną funkcję
o nazwie __autoload(), przyjmującą ja-
ko parametr nazwę klasy, która powinna
zostać załadowana. Następnie w tej funk-
www.phpsolmag.org
cji wczytujemy odpowiedni pliku z klasą
(na podstawie nazwy tej ostatniej). Na Li-
stingu 9 znajduje się implementacja funk-
cji __autoload() stworzona specjalnie na
potrzeby naszego projektu.
Implementacja klasy
abstrakcyjnej IRCBot
Na zakończenie musimy jeszcze utwo-
rzyć klasę, która będzie implementowa-
ła IRCBot. Musimy w niej zaimplemen-
tować metodę show(), wyświetlającą
informacje pochodzące od bota oraz kon-
struktor. Na Listingu 10 znajduje się wersja
tej klasy dla konsoli (ConsoleBOT), a na 11
– dla przeglądarki WWW (WebBOT). W obu
przypadkach, w konstruktorze znajduje się
następująca linia: parent::__construct();.
Jest to wywołanie konstruktora klasy-rodzi-
ca (parent), po której ConsoleBOT i WebBOT
dziedziczą. Przypomina ono nieco wywoła-
nie metody statycznej. Na Rysunkach 2 i 3
przedstawiamy zrzuty ekranów z przykła-
dowych sesji z IRCBotem.
Podsumowanie
Nasz IRCBot jest gotowy. Można go te-
raz uruchomić i przetestować (patrz ramka
Szybki Start). Warto również na własną rę-
kę poznawać RFC 2812 oraz inne materia-
ły na temat IRC, a także analizować klasy
odpowiadające za obsługę wydarzeń. Po-
zwoli to nam pogłębić wiedzę na temat taj-
ników IRC oraz sztuczek i kruczków przy-
datnych przy stosowaniu botów. Powin-
niśmy również nadmienić, że względna
prostota tworzenia naszej aplikacji wyni-
ka właśnie z obiektowości: z tego, że mo-
żemy logicznie podzielić funkcje przez nią
wykonywane na odrębne, łatwe do odróż-
nienia obiekty, w których będą bezpieczne
przed przypadkową modyfikacją. Zachęca-
my do dalszego poznawania programowa-
nia obiektowego (włączając w to bardziej
zaawansowane obszary, jak wzorce pro-
jektowe), w czym zawsze chętnie służymy
pomocą w postaci naszych artykułów. n
O autorze
Marcin Staniszczak jest studentem pierw-
szego roku informatyki studiów uzupełnia-
jących magisterskich na WSHE w Łodzi. W
PHP programuje od wielu lat. Jest autorem
kilkunastu publikacji o tematyce PHP i In-
ternetowej. Jest autorem frameworka MVC
dla PHP5 (web.framework) oraz systemu
szablonów dla PHP5 (web.template).
PHP Solutions Nr 4/2006
Początki

APIlity: zarządzanie reklamami

Google AdWords z poziomu PHP
Stopień trudności: lll
Thomas Steiner

Załóżmy, że prowadzimy rozbudowane

kampanie marketingowe w oparciu o Google
AdWords. Zarządzanie nimi przy użyciu zwykłej
strony internetowej jest mocno ograniczone
i uciążliwe. Chcielibyśmy stworzyć własnego
klienta AdWords, który pozwoliłby nam na
elastyczne zarządzanie naszym kontem
i automatyzację wielu procesów. Naprzeciw
naszym oczekiwaniom wychodzi Google
AdWords API.

K
orzystając z wyszukiwarek inter- nięć)? Obliczanie pozycji reklamy odby-
netowych określamy dokładnie, wa się wg następującej formuły: Ad Rank
czego szukamy. Powiedzmy, że = koszt kliknięcia * jakość wyników.

W SIECI mieszkamy w Warszawie i chcemy ku- Reklamodawcy mogą ustalić maksy-

l http://google-
apility.sourceforge.net
– strona domowa APIlity
l http://google-apility.
sourceforge.net/APIlity_
Reference_Standalone.html
– opis elementów biblioteki
APIlity
l http://groups-beta.google.
com/group/adwords-api-
php – grupa dyskusyjna
użytkowników APIlity
l http://www.google.com/apis/
adwords/index.html – strona
l
domowa AdWords API
http://groups.google.com/
group/adwords-api – grupa
dyskusyjna użytkowników
AdWords API
l http://www.google.com/
support/adwordsapi/bin/
answer.py?answer=21996
– taryfa zużycia jednostek
kwoty
pić nowy rower. Wpisujemy więc sklep
rowerowy Warszawa. Załóżmy teraz, że
Alicja prowadzi sklep rowerowy w tym
mieście: dzięki reklamom tekstowym
Google (Google text ads) możemy się
nawzajem znaleźć. Za każdym razem,
gdy podajemy przytoczoną wcześniej
frazę, podobnie jak w przypadku zwro-
tów rowery, tanie rowery, wycieczka ro-
werowa Warszawa, a nawet (celowa po-
myłka w pisowni) sklep RWoerowy, po-
winna się pojawić reklama zamieszczo-
na przez Alicję. Weźmy jednak pod uwa-
gę, że w Warszawie istnieje wiele skle-
pów rowerowych: przykładowo, oprócz
Alicji prowadzą je jeszce Robert i Ka-
mila, którzy również ogłaszają się ko-
rzystając z Google text ads. Kto lub co
decyduje o tym, czyj tekst ukaże się na
najwyższej pozycji w rankingu (wg klik-
malny koszt kliknięcia (CPC, ang. cost
per click), czyli kwotę, którą są goto-
wi za nie zapłacić. Na jakość wyników
(ang. quality score) wpływ ma nato-
miast clickthrough rate (CTR) każdego
słowa kluczowego (procent kliknięć ba-
nera w stosunku do odwiedzin na stro-
nie, na której jest on zamieszczony),
dopasowanie reklamy do wyszukiwa-
nej treści, dotychczasowa (historyczna)
Co należy wiedzieć...
Należy znać podstawy programowania
obiektowego w PHP. Przydatna będzie
również wiedza na temat SOAP i AJAX.
Co obiecujemy...
Pokażemy, jak stworzyć prostą aplikację
do okresowego sterowania kontem Go-
ogle AdWords.

26 www.phpsolmag.org PHP Solutions Nr 4/2006

 Google Apility Początki

tycznego zawieszenia całej serii reklam

Instalacja APIlity w reakcji na określone wydarzenie czy
Pobieramy APIlity spod adresu http://google-apility.sourceforge.net i rozpakowujemy do automatyzacja ustalania cen przypisa-
katalogu, do którego PHP ma dostęp.
nych do słowa kluczowego na podstawie
Wymagania zapasów magazynowych firmy.
APIlity działa zarówno na PHP4, jak i PHP5. Aby móc uzywać funkcji pobierania ra-
portów (report downloading), musimy włączyć rozszerzenie CURL (zobacz http:// Technologia wykorzystywana
www.php.net/curl). Użytkownicy PHP4 (tylko oni) potrzebują też rozszerzenia DOM XML
(http://www.php.net/domxml). W PHP5 rozszerzenie to zostało zastąpione wbudowaną w AdWords
biblioteką DOM. Podczas dołączania APIlity sprawdzi, czy te warunki są spełnione: jeże- Technologią odpowiedzialną za przesy-
li nie, ujrzymy odpowiednie ostrzeżenia. łanie danych w AdWords API jest SO-
Konfiguracja biblioteki AP – protokół oparty na XML-u i HTTP,
Każde żądanie wysłane do AdWords API wymaga uwierzytelnienia oraz pokazania tzw. szeroko stosowany przez twórców opro-
identyfikatora programisty (ang. developer token), który określa każdego dewelopera gramowania. Pisaliśmy o nim w artyku-
(reklamodawcę korzystającego z API). Zakładamy, że już masz konto wraz ze wszystki- łach: Mariaż Pythona i PHP. Tworzy-
mi wymaganymi informacjami dostępowymi. Aby ułatwić proces uwierzytelniania, APIlity
używa pliku authentication.ini.
my interfejs graficzny z wykorzystaniem
Ogólnie, agencja reklamowa ma pewną liczbę klientów, z których każdy przyznał jej SOAP (poprzedni numer) oraz XUL-owy
dostęp do swojego konta przez API. Informacje o tych klientach są zgromadzone w nale- interfejs dla PHP (3/2005). AdWords API
żącym do agencji My Client Center (MCC). Szef tego centrum jest nazywany menadże- używa SOAP 1.1 o stylu document/literal.
rem klientów (client manager). Jego główny adres emailowy identyfikuje agencję, pod-
czas gdy jego klientów identyfikują ich własne adresy emailowe. Aby więc uzyskać do-
W największym skrócie, jest to proto-
stęp do wybranego klienta, musimy się uwierzytelnić przy użyciu swojego emaila mena- kół klient-serwer, gdzie po stronie serwe-
dżera klientów hasła, identyfikatora programisty oraz adresu email tego klienta: wystar- ra istnieje aplikacja udostępniająca swo-
czy wprowadzić te dane w pliku authentication.ini i gotowe. je funkcje lub klasy (to drugie jest możliwe
w nowszych implementacjach SOAP),
wydajność słowa kluczowego oraz wiele nie lub całkowite kasowanie grup re- a po stronie klienta – program, który
innych czynników. klam (np. przy zerwaniu współpracy z nich korzysta tak samo, jak ze swo-
z określonym reklamodawcą). Raporty ich własnych funkcji lub klas: wywołuje je
Struktura konta Google wydajności umożliwiają natomiast śle- (z ew. parametrami) i uzyskuje zwraca-
AdWords dzenie suckesów konta AdWords. ny rezultat. Zestaw oferowanych funkcji
Konto Google AdWords jest podzie- lub klas jest nazywany usługami sieciowy-
lone na kampanie (reklamowe). Wra- AdWords API: mi lub webserwisem (ang. Web Services).
cając do naszego przykładu, Alicja wprowadzenie Dodatkowo, SOAP pozwala na komunika-
może wprowadzić różne strategie mar- Google dobrze wie, że do zarządzania cję między serwerem a klientem niezależ-
ketingowe dla rowerów górskich i ko- tak rozbudowanym systemem reklamo- nie od tego, w jakich językach są napisane
lażówek. Każdej kampanii przypisa- dawcom nie wystarcza zwykła strona in- aplikacje po obu stronach. Przykładowo,
na jest jedna lub więcej grup reklam. ternetowa: potrzebują API (ang. Applica- aplikacja serwerowa może być stworzona
Przykładowo, w kampanii dotyczącej tion Programming Interface), które po- w PHP, a klient w Javie czy Pythonie.
kolażówek mogą istnieć osobne gru- zwala agencji reklamowej na przesłanie Zestaw udostępnianych funkcji, ich
py dla każdego producenta. Na koniec, serii słów kluczowych za jednym zama- dokładne parametry, konwersja typów
każda grupa zawiera listę słów klu- chem i które można wykorzystać w swo- zmiennych między językami, pliki, w któ-
czowych lub kryteriów opisujących wi- ich własnych aplikacjach. Inne pożądane rych te funkcje są umieszczone, itd. moż-
trynę internetową oraz listę creatives cechy takiego API to np.: opcja automa- na określić w XML-owym pliku WSDL
(reklam tekstowych, które pokazują się
w wyszukiwarce internetowej). Każde-
mu słowu Alicja może przypisać mak- ��������������������

symalne CPC, które jest gotowa zapła- �������������������� ��������������������

cić; może też użyć domyślnego CPC �������������������� ��������������������

dla każdej grupy. Analogicznie, z każ-
dym słowem można skojarzyć odręb- �������������������� ��������������������

nego URL-a, pod który jest kierowany ������ �������������������� �������������������� �������������������� ��������������������
�����������
użytkownik klikający na reklamę, albo
��������������������
po prostu wybrać ogólny adres (np. wi-
trynę internetową sklepu rowerowego). ������������������
��������������������

Na podobniej zasadzie można do- ������������

�����������
�������������������� ��������������������

kładnie dopasować kampanie i grupy

��������������������
do potrzeb reklamodawcy. Przykłado-
���������������� ��������������������

wo, Google pozwala na prowadzenie

kampanii regionalnych oraz zawiesza- Rysunek 1. Struktura klas APIlity

PHP Solutions Nr 4/2006 www.phpsolmag.org 27

Początki Google Apility

(Web Services Definition Language), któ- gółów implementacji wykonywanych Obiekty w świecie APIlity
ry znajduje się na serwerze. Tak też czy- przez nią zadań. Jak już powiedzieliśmy, konta AdWords
ni Google AdWords. W naszym przypad- Plik Clients.php służy jako łącznik po- są podzielone na kampanie, którym są
ku, Google udostępnia zestaw funkcji między wysokopoziomowymi obiektami przypisane grupy reklam zawierające cre-
opisanych jaki AdWords API APIlity, a biblioteką NuSoap i przetwa- atives i np. słowa kluczowe lub kryteria
Utworzymy więc klienta, który bę- rzanymi przez nią komunikatami SOAP. opisujące witrynę.
dzie się łączył z AdWords przez SOAP Pozostałe klasy w bibliotece APIlity zaj- Każda kampania, podobnie jak gru-
(w PHP4 musimy w tym celu dołączyć mują się m.in. uwierzytelnianiem i obsłu- pa reklam jest opisana przez unikalne w
odpowiednią bibliotekę; w PHP5 jest gą błędów. skali światowej ID. Natomiast identyfika-
ona wbudowana) i wywoływał funkcje
AdWords API, podzielone na odrębne
Listing 1. Plik authentication.ini biblioteki APIlity
usługi, takie jak TrafficEstimatorService
czy AdGroupService. ...
Email = "yourEmail@someISP.tld"
Password = "y0uR5ecR3t"
APIlity, czyli łatwe i przyjemne
Developer_Token = "yOurD3v3l0p3RT0k3n"
tworzenie klienta AdWords. Client_Email = "yourClientsEmail@someISP.tld"
Aby uprościć tworzenie klienta AdWords
API w PHP, firma Google utworzyła Listing 2. Hello World w APIlity
bibliotekę APIlity, która ukrywa wszyst-
<?php
kie szczegóły techniczne jego usług sie-
require_once('apility.php');
ciowych. Dla Javy istnieje analogicz- // pobierz wszystkie kampanie klienta
na biblioteka google-adwords-api-client, $allCampaigns = getAllCampaigns();
dostępna również jako projekt openso- // wyświetlanie tablicy kampanii
urcowy (http://sourceforge.net/projects/ echo "<pre>";
print_r($allCampaigns);
goog-ad-api-cli/). Biblioteka APIlity umo-
echo "</pre>";
żliwia łatwe tworzenie obiektowych apli- ?>
kacji klienckich korzystających z Google
AdWords API. Pokażemy Wam, jak jej Listing 3. Przykładowy wynik działania "Hello world"
używać.
Array
( [0] => Campaign Object
System kwotowy (
AdWords API wprowadza system kwoto- [name] => Some Name
wy, który służy do zarządzania ruchem [id] => 12345678
[status] => Active
przysyłanych do serwera żądań. Każdy
[startDate] =>
reklamodawca dostaje pewną liczbę jed- 2006-03-31T11:03:21.000Z
nostek kwotowych (quota units) do wyko- [endDate]=>
rzystania w ciągu danego miesiąca. Każ- 2007-01-01T07:59:59.000Z
de żądanie wysłane do serwera AdWords [dailyBudget] => 567
[languages] => Array
(np. zapytanie o listę słów kluczowych)
( [0] => en
powoduje zużycie określonej liczby jedno- [1] => pl
stek (różniącej się w zależności od działa- [2] => fr )
nia). Kwota miesięczna podlega zmianom [geoTargetType] => countries
i zależy od różnych czynników, m.in. od [geoTargets] => Array
( [0] => UK
ilości kont, które posiadamy w systemie
[1] => PL
oraz stopnia, w jakim ich używamy. Sys- [2] => GB )
tem ten wprowadzono w celu ochrony [isEnabledOptimizedAdServing]=>
serwerów Google AdWords przed prze- [networkTargeting] => Array
ciążeniem przez nadmierny ruch. ( [0] => SearchNetwork
[1] => ContentNetwork )
[isEnabledSeparateContentBids]=>1 ) )
Struktura APIlity
Do komunikacji z AdWords API, APIli- Listing 4. Pobieranie informacji o grupach reklam
ty używa zmodyfikowanej wersji bibliote-
ki NuSoap. Strukturę jej klas przedstawia- // odczytaj pierwszą kampanię i pobierz jej grupy reklam
$allAdGroups=
my na Rysunku 1. Centralna klasa całego
$allCampaigns[0]->
projektu jest zawarta w pliku apility.php getAllAdGroups();
(oznaczona na zielono) i dołącza (inklu- echo "<pre>";
duje) wszystkie inne klasy. Każda Usługa print_r($allAdGroups);
sieciowa ma swoją własną klasę (żółta) echo "</pre>";
– ułatwia to szybkie odnalezienie szcze-

28 www.phpsolmag.org PHP Solutions Nr 4/2006

 Google Apility Początki

łanie funkcji GetAllCampaigns() obiektu

$allCampaigns (Listing 4. Pamiętajmy, że
�������
����
��
mamy już tablicę kampanii z poprzednie-
��������������������
����
go przykładu. Podobnie jak poprzednio,
otrzymany wynik będzie miał postać tabli-
������������ ����������
�� ������
�������������������� ������
���������� �������� cy asocjacyjnej (zob. Listing 5).
�������� �������������� ��������������
���� ��������� Moglibyśmy rozszerzać nasz przy-
�� �������������
������
�������
��������
������������
����������������
���� kład wywołując getAllAdGroups() na
���������
���� ��
�������
�����������
��
������������
�������������������� wszystkich obiektach kampanii, a na-
��������������������� ����
����������������
���������
������ ������������� stępnie, rekurencyjnie getAllCreatives()
������ ������������� ����������
�������������
���������
������������� �� ������ i getAllCriteria() na każdym obiek-
������ �������������������� ������
�������������������������������
������������������������������� ���������� ������
��������
cie grupy reklam, aż otrzymalibyśmy
����������������������������� ��������������
���������������������������� ���������
�������������
�������������� kompletne drzewo odzwierciedlające
����
�����
���������������� strukturę konta klienta. Zostało to zade-
���
������
��������
��
��������������������
monstrowane w dołączonym do APIlity
������������
��������
�������������
����������
przykładowym projekcie.
���� ������
������

Obsługa błędów
��������
��������������

Rysunek 2. Hierarchia obiektów APIlity
cja creatives, słów kluczowych oraz kry-
teriów opisujących witrynę odbywa się
za pomocą ID, które są unikalne na skalę
danego konta. Kampanie są obiekta-
mi niezależnymi, podczas gdy wszyst-
kie pozostałe obiekty posiadają odwoła-
nia do miejsc, do których należą. Zgodnie
z tą zasadą, grupy reklam przechowu-
ją ID kampanii, w ramach których istnie-
ją, creatives pamiętają ID swojej grupy re-
klam, itd. Kompletną hierarchię obiektów
przedstawiamy na Rysunku 2.
„Hello World” w APIlity
Jeżeli pobraliśmy i zainstalowaliśmy API-
lity oraz wpisaliśmy dane uwierzytelnia-
jące w pliku authentication.ini (Listing 1),
możemy pokazać jej działanie na przy-
kładzie prostej aplikacji typu Hello World.
Zaczniemy od dołączenia biblioteki APIlity
w kodzie: require _ once('apility.php');
i umieszczenia jej w tym samym folderze,
co nasza aplikacja. Nasz przykład, który
przedstawiamy na Listingu 2, będzie po-
bierał mającą postać tablicy asocjacyjnej
Listing 5. Przykładowy wynik
"rozszerzonego hello world"
Array
( [0] => AdGroup Object
( [maxCpc] => 1
[maxCpm] =>
[maxContentCpc] =>
[name] => sdsdsd
[id] => 279945007
[belongsToCampaignId]=>10838947
[status] => Active
) )
i programowanie defensywne
Gdy mamy do czynienia z działający-
mi zdanie Usługami sieciowymi, obsłu-
listę wszystkich naszych kampanii wy- ga i usuwanie błędów staje się szczegól-
wołując funkcję getAllCampaigns(); oraz nie istotne. APIlity pozwala zarówno na
wyświetlał ją w przeglądarce interneto- straight-forward programming, jak i pro-
wej. Jeżeli Twoje konto zawiera tylko jed- gramowanie defensywne. Przyjęta w tej
ną kampanię, wynik powinien wyglądać bibliotece konwencja mówi, że w wypad-
jak na Listingu 3. ku niepowodzenia (błędu) funkcja zwra-
No dobrze, a jak zobaczyć wszyst- ca fałsz (false), jeśli natomiast wszystko
kie grupy reklam? To proste: jak wie- jest OK:
my, każda grupa należy do jakiejś
kampanii. Wystarczy więc zapytać kam- • funkcja zwraca żądany rezultat (jeśli
panie o przypisane im grupy reklam: słu- powinna go zwracać),
ży do tego metoda getAllAdGroups() • funkcja zwraca prawdę (true), jeżeli
utworzonego poprzednio przez wywo- nie ma zwracać niczego innego.
Listing 6. Krok 1: tworzymy listę kryteriów słów kluczowych dla naszego konta
<?php
require_once('apility.php');
function getAllCriteriaOfAccount() {
// pobieramy wszystkie kampanie
// w wypadku niepowodzenia tego podstawowego kroku zwracamy false
if ( !$allCampaigns = getAllCampaigns() ) return false;
// pobieramy wszystkie grupy reklam przypisane do danej kampanii
for($i=0; $i<sizeOf($allCampaigns); $i++) {
$campaign = $allCampaigns[$i];
// w wypadku błędu omiń aktualną iterację
if ( !$allAdGroupsOfCampaign[$i] = $campaign->getAllAdgroups() ) continue;
}
// inicjalizujemy tablicę do przechowywania kryteriów słów kluczowych
$allCriteriaOfAccount = array();
// pobierz słowa kluczowe zawarte w każdej kampanii i każdej grupie reklam
for($i=0; $i<sizeOf($allAdGroupsOfCampaign); $i++) {
for($j=0; $j<sizeOf($allAdGroupsOfCampaign[$i]); $j++) {
$adGroup = $allAdGroupsOfCampaign[$i][$j];
// w wypadku błędu po prostu pomijamy aktualną iterację
if ( !$allCriteria = $adGroup->getAllCriteria() ) continue;
foreach($allCriteria as $criterion) {
array_push($allCriteriaOfAccount, $criterion);
} }
} return $allCriteriaOfAccount; }
?>

PHP Solutions Nr 4/2006 www.phpsolmag.org 29

Początki Google Apility

Odstępstwem od tej reguły są pro-

Listing 7. Krok 2: odpowiednie wydarzenie powoduje zmianę maksymalnego ste funkcje pobierania obiektów (object
CPCs get-functions), ponieważ wymagają one
<?php
poprawnie utworzonego obiektu. Przy-
// zmienne globalne określające początek i koniec przerwy na lunch (pory lunchu) kładowo, funkcja addCampaign() doda-
$lunchStartTime = "11:00:00"; je i zwraca jako rezultat nową kampa-
$lunchEndTime = "13:00:00"; nię. Jeśli więc wszystko poszło dobrze,
$sleepTime = 15; // czekaj 15 minut pomiędzy cyklami sprawdzenia
funkcja powinna zwrócić obiekt kampa-
function startDaypartingDaemon($lunchStartTime, $lunchEndTime,
$sleepTime,$allCriteria=null,$bidsRaised=false,$bidsLowered=false){
nii jako rezultat. Jeśli dodawanie się nie
/* przy pierwszym uruchomieniu demona daypartingu odczytaj kryteria słów powiodło (np. AdWords API nie chce
/* kluczowych przez wywołanie API. Potem słowa kluczowe będą przekazywane przyjąć naszej kampanii), zwróconym
/* i zwracane przy każdym wywołaniu rekurencyjnym */ wynikiem będzie false.
if ( is_null($allCriteria) ) {
Możemy więc programować na dwa
echo "Dayparting Daemon started.<br />\n";
ob_flush(); flush();
sposoby. Pierwszym jest programowanie
// jeśli poniższe zawiedzie, nie mamy dostępu do konta defensywne:
if (!$allCriteria=getAllCriteriaOfAccount()){
exit("Brak połączenia z kontem"); if($campaignObject=addCampaign(...)){
}else{echo "Dane konta zostały pomyślnie załadowane.<br />\n"; }
// obsługa błędu
}
}
// sprawdź, czy nadeszła pora lunchu
$now = time(); print_r($campaignObject);
// nadeszła pora lunchu
if (($now >= makeUnixTimeStamp($lunchStartTime)) && a drugim straight-forward programming:
($now <= makeUnixTimeStamp($lunchEndTime))) {
// jeśli stawki nie zostały podniesione, to je podnieś
$campaignObject = addCampaign(...);
if (!$bidsRaised) {
if ( !raiseBids($allCriteria)) { print_r($campaignObject);
exit("Błąd podnoszenia maksymalnego CPC dla słowa kluczowego.");
}else{ Wszystkie błędy są wrzucane na stos
echo "Pora lunchu rozpoczęta, <font color='red'>
błędów, który przechowuje informacje
podnoszę</font> stawki.<br />\n";
$bidsRaised = true;
o nich w standardowy sposób, jako
$bidsLowered = false; obiekty błędów. Daje to dużą elastycz-
} ność gromadzenia i przetwarzania da-
} else echo "Stawki zostały już podniesione. nych o błędach, gdyż na podstawie
Pora lunchu nadal trwa.<br />\n";
tych obiektów łatwo możemy np. wyge-
// czas pracy; jeśli stawki nie zostały jeszcze obniżone, to je obniż
}else{
nerować plik tekstowy, HTML czy XML
if (!$bidsLowered) { zawierający potrzebne informacje, co
if (!lowerBids($allCriteria)) { umożliwi sporządzanie raportów.
exit("Błąd obniżania maksymalnego CPC dla słów kluczowych.");
}else{
Dalsze możliwości
echo "Pora lunchu zakończona, <font color='green'>
obniżam</font> stawki.<br />\n";
Na podstawie dotychczasowej wie-
$bidsLowered = true; $bidsRaised = false; dzy, używając APIlity stworzysz wy-
} godną stronę WWW (frontend) do za-
}else echo "Stawki został już obniżone. Czas pracy wciąż trwa.<br />\n"; rządzania swoim kontem, narzędzie do
}
przesyłania całego zestawu słów klu-
// wypisz zawartość bufora i poczekaj
ob_flush();
czowych za jednym zamachem (bulk
flush(); uploader), aplikację pozwalającą spo-
sleep($sleeptime * 60); rządzać raporty jednym kliknięciem
// wywołanie rekurencyjne; uwaga: talblica $allCriteria jest już wypełniona, i wiele innych. Warto też wspomnieć
// a bity statusu przechowują informację o tym, czy stawki zostały zmienione
o możliwości eksportu słów kluczo-
startDaypartingDaemon($lunchStartTime, $lunchEndTime, $sleepTime,
$allCriteria, $bidsRaised, $bidsLowered);
wych do plików Excela lub ich importu
} z Excela do bazy AdWords.
// ta funkcja konwertuje czas w formacie (12:00:00) na uniksowy timestamp Wielu reklamodawcom to wystarcza:
function makeUnixTimeStamp($isoTime) { prawdziwe możliwości zaczynają się jed-
$timeComponents = split(":", $isoTime);
nak dopiero przy wprowadzeniu elemen-
return mktime($timeComponents[0], $timeComponents[1],$timeComponents[2],
date("m"), date("d"), date("Y"));
tów interakcji i automatyzacji.
}
// uruchom demona (będzie działał “w nieskończoność”) Budujemy większy
startDaypartingDaemon($lunchStartTime, $lunchEndTime, $sleepTime); projekt
?>
W języku osób zajmujących się rekla-
mami (nie tylko internetowymi), day-

30 www.phpsolmag.org PHP Solutions Nr 4/2006

 Google Apility Początki

�����
��������������������
����������������
�������������������� ��������������������
������������� ��������������
�������������������� ��������������������
��������������
�������������������� �������������������� ��
������
�� ���
�����������
�������������������� �������������������� ����
�������������������� ��������������������
��
�������������������� ���
�������� ��
������� ������������������
��������������������
��
������������
�����������
�������������������� ��������������������
���
��� ���������������� ��������������������
��������������������

��������������������

�������������������� ��������������������

�������������������� ��������������������

�������������������� ��������������������

������ �������������������� �������������������� ����

�������������������� ��������������������
�����������

��������
��������������������
����������������
������������������
�����������
��������������������
����������������
�������������������� ��������������������
������������

���������������� ��������������������
��������������������
�������������������������������

�����������������������������������������������������

Rysunek 3. Zasada działania APIlitAx

parting polega na dzieleniu dnia na Koncepcja szy. Nie musimy jednak tego robić każ-
określone części, różniące się rodza- Naszym celem jest stworzenie najprost- dego dnia, o ile nie zmieniamy naszych
jem wyświetlanych reklam. Reklamy szego demona zajmującego się daypar- słów kluczowych. W zastosowaniach
te są często adresowane do określo- tingiem. Będzie on działał przez całą do- praktycznych, dane byłyby przechowy-
nego odbiorcy, z uwzględnieniem wy- bę, a w godzinach pomiędzy 11 a 13 pod- wane w lokalnej bazie danych (działają-
konywanych przez niego o określonej nosił CPC każdego kryterium słowa klu- cej po stronie naszego klienta AdWords
porze zajęć. Pamiętacie o Alicji, któ- czowego np. o 20 groszy. API) i okresowo aktualizowane na pod-
ra prowadzi sklep rowerowy? Więk- Krok 1: nasze zamierzenie zrealizu- stawie informacji z AdWords. W naszej
szość rowerzystów cięzko pracuje (lub jemy na poziomie kryteriów słów kluczo- prostej aplikacji, jednorazowo pobiera-
się uczy) w ciągu dnia, z małą przerwą wych konta Alicji, co jest bardzo proste: my kryteria słów kluczowych w funk-
na odpoczynek (lunch) i surfowanie po wystarczy rozszerzyć nasz przykład Hel- cji, która omówimy w następnym kroku.
Sieci. Dobrym pomysłem byłoby więc lo World (Listing 6). Ponieważ potrzebna Funkcja ta następnie będzie wywoływa-
podnoszenie maksymalnego CPC w nam jest jedynie lista wszystkich kryte- na rekurencyjnie (ze swojego wnętrza).
tej porze dnia, aby zwiększyć krąg od- riów słów kluczowych, nie musimy prze- Lista słów kluczowych zostanie pobra-
biorców reklamy oraz obniżanie CPC chowywać pochodzenia każdego z nich na z serwera jedynie za jej pierwszym
(a nawet całkowite zawieszanie reklam) ani tworzyć w tym celu rozbudowanej ta- wywołaniem, natomiast przy kolejnych
w momentach o większej stagnacji. blicy (informację o pochodzeniu możemy będziemy ją przekazywać przez para-
zresztą bardzo łatwo odtworzyć na pod- metr tej funkcji.
Listing 8. Krok 3: funkcje stawie pola belongsToAdGroupID każdego Krok 2: gdy już mamy wszystkie
modyfikujące obiekty obiektu kryterium). Tworząc nasz skrypt, kryteria słów kluczowych, musimy zde-
wykorzystamy taktykę programowania finiować wydarzenia powodujące pod-
<?php
defensywnego. niesienie maksymalnego CPC i jego
function raiseBids($allCriteria){
Wykonanie kroku 1. jest niezbęd- ponowne obniżenie. U nas są nimi po-
foreach($allCriteria as
$criterion) { ne, aby odczytać dane po raz pierw- czątek i koniec pory lunchu. Demon
if(!$criterion->
setMaxCpc( Listing 9. Przykładowy plik pośredniczący w PHP
$criterion->
getMaxCpc()+0.2)) <?php header("Content-type:application/xml; Charset=UTF-8"); ?>
return false; <?php
} echo utf8_encode("<?xml version='1.0' encoding='UTF-8'?>\n");
return true; include('./apility/apility.php');
} $authenticationContext->setEmail($_POST['email']);
function lowerBids($allCriteria){ $authenticationContext->setPassword($_POST['password']);
foreach($allCriteria as $authenticationContext->setToken($_POST['developerToken']);
$criterion) { $authenticationContext->setClientEmail($_POST['clientEmail']);
if(!$criterion->setMaxCpc( $campaignObject = createCampaignObject($_POST['id']);
$criterion-> if (!$campaignObject) {
getMaxCpc()-0.2)) $fault = array_pop($faultStack);
return false; $fault->printFault();
} return true; } }else { $xml .= $campaignObject->toXml(); }
?> echo utf8_encode($xml);
?>

PHP Solutions Nr 4/2006 www.phpsolmag.org 31

Początki Google Apility
zajmujący się daypartingiem będzie re-
gularnie sprawdzał, czy ta pora nade-
szła, czy nie. Jeśli nadeszła, demon
podnosi stawki (tylko raz danego dnia),
a jeśli się skończyła, obniża je (znów,
tylko raz dziennie). We wszystkich in-
nych przypadkach demon powinien po
prostu kontynuować swoje działanie.
Aby sprawdzić aktualną godzinę, użyje-
my PHP-owej funkcji time(), natomiast
do porównywania czasu wykorzysta-
my uniksowy format timestamp (zobacz
Listing 7).
Krok 3: pozostało już tylko utworzenie
funkcji modyfikujących maksymalne CPC:
raiseBids(), która służy do jego podno-
szenia oraz lowerBids(), która będzie je
obniżała (Listing 8).
Wady tego podejścia
Nasz demon zajmujący się daypartingiem
jest gotowy. Jako, że jest to prosty przy-
kład, moglibyśmy w nim wiele poprawić:
przykładowo, moglibyśmy użyć bazy da-
nych do lokalnego przechowywania kry-
teriów słów kluczowych.
Rysunek 4. Przykładowa aplikacja w APIlitAx, korzystajjąca z APIlity i AJAX-a
32
Pamiętajmy, że musimy przechowy-
wać listę wszystkich kryteriów, a pro-
tokół HTTP jest bezstanowy (ang. sta-
teless), co znaczy, że przy przełado-
waniu strony tracimy wszystkie dane.
Moglibyśmy zapisywać je w zmiennych
sesyjnych, lecz nie jest to dobrym roz-
wiązaniem, gdyż powoduje spadek wy-
dajności wraz ze wzrostem ilości da-
nych. Dałoby się również każdorazow
ściągać wszystkie dane, ale jest to zły
pomysł, gdyż jest czasochłonny oraz
oznacza konieczność wysyłania ko-
lejnych zapytań do serwera AdWords,
a każde z nich zmniejsza dostępną kwo-
tę. Krótko mówiąc, potrzebujemy trwałej
warstwy danych (ang. persistence layer)
– zespół twórców APIlity ma ją w swoich
planach. Powinna ona pozwalać na ła-
twą integrację z bazą danych. Pod adre-
sem http://www.adoptimize.de/glossar/
mysql-4.1.11.sheme.apility.0.4.html obej-
rzymy wstępną wersję schematu ba-
zy danych (w postaci kwerend tworzą-
cych tablice i wprowadzających przykła-
dowe dane).
www.phpsolmag.org
Istnieje jeszcze inna wada obecne-
go podejścia: każda operacja zajmuje
czas i gdy jest wykonywana przez Ad-
Words API, użytkownik musi czekać.
Choć nie możemy przyspieszyć odpo-
wiedzi AdWords API, powinniśmy móc
wysłać do niego skumulowaną listę żą-
dań (zapytań) i pozwolić użytkowniko-
wi na wykonywanie innych czynności
w tym czasie. Przykładowo, jedno żą-
danie może pobierać obszerny raport,
podczas gdy drugie będzie wysyłało
zestaw nowych kampanii. Wprawdzie
PHP nie jest wielowątkowe, ale uży-
wając kombinacji różnych technik mo-
żemy emulować wielowątkowe zapyta-
nia do API.
APIlity + AJAX =
APIlitAx
Jak sama nazwa wskazuje, AJAX
(Asynchronous Javascript And XML)
– jedno z najmodniejszych w tym ro-
ku słów ze świata PHP (o którym pisa-
liśmy w numerze 1/2006 w artykułach:
AJAX – wyjąkowo interaktywne i wy-
PHP Solutions Nr 4/2006
 Google Apility Początki

Przykładowy skrypt
Tworzymy konto AdWords pośredniczący PHP
Zaczynamy od założenia konta AdWords. W tym celu idziemy na stronę główną Opiszemy przykładowy skrypt pośred-
AdWords i postępujemy wg wskazówek kreatora: https://adwords.google.com/select/
niczący PHP (zob. Listing 9). Rozpo-
starter/signup/Fork.
Po utworzeniu i potwierdzeniu konta AdWords, musimy je aktywować: w tym ce- czynamy go od wysłania nagłówka,
lu trzeba wybrać opcje płatności i wysłać szczegółowe informacje z nimi związane (funkcją header()), w którym zdeklaru-
(billing information). Odtąd mamy możliwość zarządzania reklamami, ale jeszcze nie jemy zawartość strony wynikowej ja-
przez API: do tego ostatniego musimy jeszcze uzyskać dostęp. W tym celu wchodzi-
ko XML (a nie, jak domyślnie, HTML)
my na stronę https://adwords.google.com/select/ApiWelcome i wpisujemy dane nasze-
go konta i loginu. Po chwili pojawi się kreator, który pomoże nam w utworzeniu konta i ustawimy zestaw znaków na UTF-8.
My Client Center.. Następnie, w zakładce My Account pojawi się nowa strona zatytu- Od tej chwili musimy ściśle przestrze-
łowana AdWords API Center: będzie ona zawierała identyfikator programisty (develo- gać reguł XML-a: każdy tekst wypisa-
per token) oraz informacje o tym, jak używamy API (w tym kwota). W zaczęciu pracy
ny przez PHP (np. komunikat o błędzie
z AdWords API pomogą nam następujące tutoriale:
czy ostrzeżenie) spowoduje błąd jego
● http://services.google.com/awp/en_us/breeze/264836/index.html, przetwarzania. W rezultacie, żądanie
● http://services.google.com/awp/en_us/breeze/267718/index.html, XHML HTTP Request nigdy nie przy-
● http://services.google.com/awp/en_us/breeze/264848/index.html. niesie wyniku i będzie czekało w nie-
skończoność – jest to jeszcze jeden
Odpowiedzi na wiele spośród naszych pytań uzyskamy również na grupie dyskusyjnej de-
powód dla stosowania programowania
veloperów AdWords API: http://groups.google.com/group/adwords-api.
defensywnego.
Następnie dołączamy bibliotekę
APIlity (apility.php) i dokonujemy uwie-
dajne aplikacje WWW oraz advAJAX, Wymagania rzytelnienia na serwerze AdWords.
czyli praktyczne zastosowanie techno- Aby APIlitAx w ogóle działało, APIli- Uwierzytelnienie to odbywa się w spo-
logii AJAX), pozwala na asynchronicz- ty nie może być w trybie verbous (wy- sób dynamiczny, przy użyciu obiek-
ne przesyłanie danych (stąd A w na- pisywanie komunikatów na temat wy- tu globalnego $authenticationContext
zwie). X z kolei oznacza wykorzystanie konywanych czynności, błędów, itd.); oraz danych HTTP POST. Jeśli wystą-
XML-a. APIlity pozwala na łatwą kon- zwracanie przez PHP komunikatów pi błąd, wyświetlony zostanie komuni-
wersję obiektów PHP-owych na XML: o błędach również musi być wyłączone, kat o błędzie AdWords API (komuni-
$someAPIlityObject->toXml();. Umoż- gdyż każda taka wiadomość zniszczy- katy o błędach muszą być w formacie
liwia to przesyłanie obiektów APIlity ja- łaby strukturę XML tworzoną w pośred- XML). Jeżeli natomiast wszystko pój-
ko odpowiedzi na zapytania AJAX-a. niczącym skrypcie PHP. Aby tego unik- dzie dobrze, odebrany obiekt kampa-
Wreszcie, J oznacza JavaScript. nąć, APIlity oferuje tzw. Silence Stealth nii APIlity zostanie przekonwertowa-
Jak połączyć AJAX-a i APIlity? Mode, w którym wszystkie ostrzeżenia ny na XML.
Jest to całkiem proste: po stronie ser- PHP, jak i komunikaty APIlity zostają Niezbędny kod źródłowy JavaScript
wera mamy AdWords API, a po stronie wyłączone. oraz działająca aplikacja przykładowa
klienta –przeglądarkę WWW. Pomię- Błędy AdWords API są natomiast zostały zamieszczone na stronach pro-
dzy nimi jest APIlity. W przeglądarce cały czas przechwytywane, ale nie jektu na licencji BSD.
WWW mamy zupełnie zwyczajną stro- wyświetlane. Jeżeli używamy APIli-
nę internetową zawierającą formularze ty jako biblioteki osadzonej (ang. em- Podsumowanie
i tekst. Za każdym razem, gdy użyt- bedded), dobrym pomysłem jest prze- Możliwości Google AdWords API są
kownik wysyła zmiany, raport, itd., uru- chowywanie informacji o tych błędach ogromne: możemy śmiało powiedzieć,
chamiane jest żądanie XML HTTP Re- w XML-u. że jego wprowadzenie stworzyło nową
quest: przesyła ono parametry funk- Dodatkowo, z natury Silence Ste- jakość w zarządzaniu reklamami in-
cji APIlity jako zwyczajne dane HTTP alth Mode wynika, że błędy niezwiąza- ternetowymi. Wiedza o tym systemie,
POST. ne z API są trudne do znalezienia. Po- którą Wam przekazaliśmy, stanowi so-
Istnieje też pośrednicząca w trans- winniśmy więc przyłożyć szczególną lidną podstawę do tworzenia bardziej
misji strona PHP, która przetwarza uwagę do zapobiegania im: pośredni- rozbudowanych projektów: zachęcamy
dane POST i wywołuje odpowiednią czący skrypt PHP powinien działać do własnych eksperymentów i życzy-
funkcję natywną APIlity. Dostarcza i przynajmniej generować poprawnego my samych sukcesów w biznesie. n
ona również rezultaty funkcji w forma- XML-a – nawet, jeżeli nie wysłano pa-
cie XML lub JSON, co pozwala na ła- rametru POST.
twe przetwarzanie odpowiedzi przez Najłatwiej to sprawdzić uruchamia-
przeglądarkę internetową. Ponieważ jąc ten plik jako niezależny, poza na- O autorze
ten skrypt PHP znajduje się na lokal- szym systemem. W znalezieniu typo-
nym serwerze WWW, na którym zain- wych błędów, takich jak variable undec- Thomas Steiner pracuje dla Google,
Inc. jako inżynier oprogramowania i po-
stalowano również APIlity, wirtualizu- lared (niezadeklarowana zmienna) po- pularyzator AdWords API. Odpowiada
je on w pewnym sensie AdWords API, może nam też wyłączanie i włączanie za opensourcowy projekt APIlity.
pozwalając jednemu użytkownikowi Silence Stealth Mode podczas debu- Kontakt z autorem: tomac@google.com
wysyłać wiele żądań. gowania skryptu.

PHP Solutions Nr 4/2006 www.phpsolmag.org 33

Bezpieczeństwo

Kryptografia w PHP
Stopień trudności: lll
Łukasz Lach, Michał Stanowski

Prawdopodobnie każdy z nas wie, czym jest

kryptografia. Bierzemy porcję informacji
(np. tekstu) i szyfrujemy ją tak, aby nikt
nieuprawniony nie był w stanie jej odczytać.
Z kryptografią mamy do czynienia na co dzień
– czy to korzystając z banku internetowego, czy
też wysyłając szyfrowanego maila. I to wszystko
z wykorzystaniem PHP.

W
ikipedia definiuje kryptogra-
fię jako „naukę zajmującą się
układaniem szyfrów”. W prak-
tyce jest to konwersja jednej informacji
w drugą za pomocą złożonych obliczeń ma-
tematycznych (szyfrowanie) oraz ewentual-
na konwersja tejże informacji do stanu pier-
wotnego (deszyfrowanie). W kontekście
aplikacji internetowych jest to dość często
spotykana dziedzina, zarówno w małych,
jak i w dużych, komercyjnych serwisach
– podczas logowania się do banku interne-
W SIECI towego wpisywane przez nas dane przesy-
łane są bezpiecznym, szyfrowanym łączem
SSL, a wysyłając poufne wiadomości e-ma-
l http://php.net/mcrypt il korzystamy z systemu PGP, chroniącego
– MCrypt ich treść przed osobami trzecimi.
l http://php.net/mhash
tykule pokażemy, w jaki sposób można
efektywnie korzystać ze wspomnianych
funkcji na podstawie trzech praktycznych
przykładów.
System bezpiecznego
logowania
Zacznijmy od stworzenia bezpieczne-
go systemu logowania. Jest to idealny
przykład na wykorzystanie funkcji kryp-
tograficznych dostępnych w PHP. W na-
Co należy wiedzieć...
Przydatna będzie podstawowa znajo-
mość zagadnień kryptografii oraz PHP.

PHP zawiera szereg funkcji pozwala-

– MHash
l http://phpsec.org/
– PHP Security Consortium
l http://php.net/security
– Bezpieczeństwo PHP
l http://pajhome.org.uk/crypt/
md5
– funkcje haszujące dla JS
jących na szyfrowanie i generowanie ha-
szów dowolnych łańcuchów znaków czy
zawartości plików. Część z nich dostęp-
na jest natywnie, jednak duża większość
przy wykorzystaniu zewnętrznego rozsze-
rzenia, dołączonego do PHP. W tym ar-
Co obiecujemy...
Z artykułu dowiesz się, jak zbudować
bezpieczny system logowania oraz apli-
kację do składowania i szyfrowania pli-
ków na serwerze WWW. Na przykła-
dach tych przedstawimy najpopularniej-
sze i najlepsze rozwiązania kryptogra-
ficzne w PHP.

34 www.phpsolmag.org PHP Solutions Nr 4/2006


szym, bezpiecznym systemie hasło wpisa-
ne przez użytkownika przesyłane będzie
w formie funcji skrótu, nawet dwukrotnie:
za pierwszym razem przez algorytm MD5,
a następnie HMAC-MD5.
Przesyłana wartość będzie prawidłowa
tylko i wyłącznie raz, ponieważ klucz pu-
bliczny, potrzebny w procesie szyfrowania,
będzie za każdym razem unikalny – dyna-
micznie tworzony po stronie serwera.
Taki system okaże się bardzo pożą-
dany, kiedy na serwerze nie posiadamy
SSL, a chcemy przesyłać zaszyfrowane
dane. W przeciwieństwie do tradycyjnego
systemu logowania, ten skutecznie ochro-
ni użytkowników przez atakami typu snif-
fing, polegających na podsłuchaniu infor-
macji wymienianych pomiędzy klientem
a serwerem, a co w konsekwencji pozwa-
la na przejęcie wpisanej nazwy użytkowni-
ka oraz hasła i wykorzystanie ich do za-
logowania. Dodatkowo, wszystkie hasła
przechowywane będą jedynie w postaci
skrótu MD5, także ich ewentualne pozna-
nie przez osoby niepowołane jest całkowi-
cie niegroźne (przyjmując oczywiście, że
hasła mają przyzwoitą długość, czyli przy-
najmniej 10 znaków). Podstawowe infor-
macje dotyczące funkcji haszujących za-
wiera Ramka Algorytmy i funkcje haszu-
jące. Na Rysunku 1 przedstawiliśmy sche-
mat tworzonego systemu bezpiecznego
logowania.
W naszym przykładzie skorzystamy
również z wersji HMAC algorytmu MD5.
HMAC-MD5 jest rozszerzeniem funkcji
skrótu MD5 i pozwala na dołączenie do-
datkowego, dowolnego klucza. Wygenero-
wany w ten sposób łańcuch znaków mo-
że być wówczas przesłany do odbiorcy,
który, posiadając owy sekretny klucz, mo-
że sprawdzić poprawność przesłanego
ciągu. W naszym systemie logowania al-
�����
������
�����
���������
������
�����������
���������
Rysunek 1. Schemat działania systemu bezpiecznego logowania
PHP Solutions Nr 4/2006
Kryptografia w PHP Bezpieczeństwo
Algorytmy i funkcje haszujące
Funkcją haszującą (czy też funkcją skrótu) nazywamy funkcję, która dowolnemu łańcu-
chowi znaków przyporządkowuje inną, unikalną wartość nazywaną powszechnie haszem
(ang. hash) lub skrótem. Algorytm skrótu jest jednokierunkowy, otrzymanie pierwotnej war-
tości na podstawie wcześniej wygenerowanego skrótu wymaga ogromnej mocy oblicze-
niowej i jest praktycznie niemożliwe. Istotną właściwością funkcji skrótu jest to, że zmiana
choć jednego znaku łańcucha wejściowego, bez względu na jego długość, powoduje wy-
generowanie całkiem innej wartości skrótu.
Nie posiadając dołączonego do PHP rozszerzenia MHash mamy do dyspozycji pięć
standardowo dostępnych funkcji pozwalających generować hasze dla trzech, najbardziej
popularnych algorytmów – CRC32, MD5 oraz SHA1. Najnowsza wersja PHP5 udostęp-
niać będzie ponadto rozszerzenie Hash (http://php.net/hash), które zawiera praktycznie
wszystkie algorytmy dostępne w MHash, a przy tym jest domyślnie zintegrowane z PHP
i nie wymaga żadnych dodatkowych bibliotek czy konfiguracji. Jednak póki co rozszerze-
nie Hash jest dostępne wyłącznie do testów i nie powinno być powszechnie wykorzysty-
wane tym bardziej, że zarówno sama zasada jego działania, jak i lista dostępnych algoryt-
mów może się jeszcze zmienić.
Mimo to, dostępne natywnie w PHP algorytmy haszowania są w zupełności wystar-
czające, bez różnicy na rozmiar tworzonego projektu. Algorytmy takie jak CRC32 i MD5
są powszechnie i z powodzeniem wykorzystywane do tworzenia sum kontrolnych plików
lub poufnych danych, które muszą być dostępne jedynie w postaci umożliwiającej walida-
cję (np. hasła). Tabela 1 zawiera algorytmy dostępne natywnie w PHP oraz poprzez roz-
szerzenie MHASH.
gorytm HMAC wykorzystamy do wygene- wygenerowanie nowego klucza, a co za
rowania skrótu hasła, dołączając do nie- tym idzie, stworzony w oparciu o niego
go losowy klucz wygenerowany po stro- hasz będzie miał całkiem inną wartość.
nie serwera. PHP nie posiada implemen- Co nam to daje? Otóż nawet w przypad-
tacji HMAC algorytmu MD5, także musimy ku podsłuchania danych przez osobę
ją najpierw napisać opierając się o dostęp- trzecią, zdobyte w ten sposób informa-
ną dokumentację (http://www.ietf.org/rfc/ cje będą całkowicie bezużyteczne. Skup-
rfc2104.txt). Kod źródłowy funkcji hmac_md5 my się najpierw na części HTML kodu
przedstawiliśmy na Listingu 1. źródłowego, która umieszczona jest na
Dodatkowym atutem przedstawio- Listingu 2. W pierwszych linijkach skryp-
nej implementacji jest to, że pozwala nie tu dołączamy plik języka JavaScript
tylko na wygenerowanie skrótu HMAC- o nazwie md5.js, który zawiera dwie klu-
MD5, ale również HMAC-SHA1, tak więc czowe dla nas funkcje – hex_md5 oraz
mamy do dyspozycji dwa dodatkowe al- hex_hmac_md5, będące odpowiednika-
gorytmy do wykorzystania w naszych mi funkcji md5 i hmac_md5, dostępnych od
projektach. strony skryptu PHP. Poniżej umieszczo-
W naszym systemie zakładamy, że ny jest kod źródłowy funkcji parseForm,
przesłane przez użytkownika hasło w po- która wywoływana jest tuż przed przesła-
staci skrótu HMAC-MD5 będzie prawdzi- niem formularza. Formularz ten zawarty
we tylko i wyłącznie raz. Ponowne otwar- jest w części body dokumentu i zawiera
cie czy przeładowanie strony spowoduje cztery istotne pola:
• key – pole typu hidden zawierają-
���������� ce wygenerowany po stronie serwe-
��� ��������
ra unikalny klucz, wykorzystywany na
���������� etapie logowania przez wersję HMAC
�����
����������� ��������� funkcji haszującej,
���������
• js – pole typu hidden, którego wartość
����������
określa, czy przeglądarka użytkowni-
������������ ka obsługuje JavaScript. Jego domyśl-
ną wartością jest 0 (zero), zamieniane
przed przesłaniem na 1 (jeden) w koń-
cowych linijkach funkcji doLogin,
• username – pole typu text, zawierają-
ce wpisaną nazwę użytkownika,
www.phpsolmag.org 35
Bezpieczeństwo Kryptografia w PHP
• password – pole typu password, zawie-
rające wpisane hasło.
Rola pola js jest bardzo ważna – w przy-
padku, gdy jego wartość jest równa 0, wie-
my, że dane nazwy użytkownika i hasła
przesłane zostały w postaci jawnej, jed-
nak mimo to nadal jesteśmy się w stanie
bezproblemowo zalogować. Wróćmy jed-
nak do kodu źródłowego omawianej funk-
cji. W przypadku nie podania nazwy użyt-
kownika lub hasła, wyświetlamy stosowny
komunikat i przenosimy kursor do pustego
pola. W innym wypadku modyfikujemy za-
wartość pola zawierającego hasło na hasz
HMAC-MD5 skrótu MD5 wpisanego hasła
oraz unikalnego klucza, dostępnego w po-
lu key. Dodatkowo ustawiamy wartość po-
la js na 1 i zezwalamy na wysłanie formu-
larza zwracając wartość true.
Zobaczmy teraz, co dzieje się po stro-
nie serwera – pełny kod PHP opisywane-
go przykładu znajduje się na Listingu 3.
Główna część skryptu to funkcja doLogin,
której zadaniem jest sprawdzenie nazwy
użytkownika i hasła. W przypadku nie po-
dania którejkolwiek z tych danych zwraca-
my wartość -1. Następnie sprawdzamy po-
prawność przesłanego z poziomu formula-
rza klucza (pole key) z tym zapisanym
w sesji. Jeśli do tego momentu wszyst-
ko zakończyło się pomyślnie, nawiązuje-
my połączenie z bazą danych i pobiera-
my nazwę użytkownika i skrót MD5 hasła.
Jeśli osoba o poszukiwanej nazwie użyt-
kownika nie istnieje, zwracamy wartość -3.
W innym wypadku dokonujemy sprawdze-
nia poprawności przesłanego hasła w za-
leżności od tego, czy przeglądarka użyt-
kownika wykonała funkcję JavaScript. Je-
śli hasło się zgadza, zwracamy nazwę
użytkownika, jeśli nie, zwracamy wartość
-4. Wspomniane ujemne wartości liczbo-
we są wykorzystywane w głównej czę-
ści kodu do wyświetlenia odpowiedniego
komunikatu o błędzie. W przypadku, gdy
zwrócona przez funkcję doLogin wartość
jest łańcuchem znaków, traktujemy ją ja-
ko nazwę użytkownika i zapisujemy do
zmiennej sesji przekierowując jednocze-
śnie użytkownika na właściwą stronę pa-
nelu administracyjnego. Na końcu modyfi-
kujemy wartość zmiennej klucza zapisując
w niej nową, unikalną wartość.
Reasumując: z pomocą jednej funkcji
haszującej stworzyliśmy mały objętościo-
wo skrypt o wielkich możliwościach, za-
pewniający użytkownikom logującym się
do naszego serwisu wysoki poziom bez-
36
pieczeństwa. Przyjrzyjmy się teraz innej Podstawy kryptografii
funkcji dostępnej natywnie w PHP, pozwa- – crypt
lającej na szyfrowanie łańcuchów znaków Wbrew przypuszczeniom funkcja crypt
za pomocą takich algorytmów jak DES czy pozwala na szyfrowanie w jedną stronę,
Blowfish. Mowa tu o funkcji crypt nie ma funkcji decrypt, która pozwoliła-
Listing 1. Implementacja algorytmu HMAC-MD5 dla PHP
<?php
define('HMAC_MD5', 1);
define('HMAC_SHA1', 2);
function hmac($string, $key, $algorithm = HMAC_MD5) {
$algorithm = $algorithm == HMAC_MD5 ? 'md5' : 'sha1';
if (function_exists('hash_hmac'))
return hash_hmac($algorithm, $string, $key);
if (isset($key{64}))
$key = pack('H*', $algorithm($key));
$key = str_pad($key, 64, "\0");
$iPad = str_repeat("\x36", 64);
$oPad = str_repeat("\x5c", 64);
return $algorithm(($key ^ $oPad).pack('H*', $algorithm(($key ^ $iPad) .
$string)));
}
function hmac_md5($string, $key) {
return hmac($string, $key, HMAC_MD5);
}
?>
Listing 2. Kod HTML systemu bezpiecznego logowania
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="PL">
<head>
<title>PHP Solutions :: hmac_md5</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<script type="text/javascript" src="md5.js"></script>
<script type="text/javascript">
function $(id) { return document.getElementById(id) }
function parseForm() {
var u = $('username'), p = $('password');
if (u.value == '') {
alert('Podaj nazwę użytkownika.');
u.focus(); return false;
}
if (p.value == '') {
alert('Podaj hasło.');
p.focus(); return false;
}
p.value = hex_hmac_md5($('key').value, hex_md5(p.value));
$('js').value = 1; return true;
}
</script></head><body>
<?php
if (!empty($errorString))
echo '<div id="error">'.$errorString.'</div>';
?>
<form method="post" action="login.php" onsubmit="return parseForm()"><div>
<input type="hidden" name="key" id="key" value="<?php echo $_
SESSION['key'] ?>" />
<input type="hidden" name="js" id="js" value="0" />
<label for="username">Nazwa użytkownika:</label>
<input type="text" name="username" id="username" /><br />
<label for="password">Hasło:</label>
<input type="password" name="password" id="password" /><br />
<input type="submit" value="OK" />
</div></form></body></html>
www.phpsolmag.org PHP Solutions Nr 4/2006
 Kryptografia w PHP Bezpieczeństwo

by na odszyfrowanie informacji. W prakty-

Listing 3. Kod PHP systemu bezpiecznego logowania ce więc jest to kolejna funkcja haszująca.
Zobaczmy, jak na jej podstawie możemy
<?php
zbudować znacznie prostszy skrypt uwie-
function doLogin() { rzytelniania, oparty o protokół HTTP i al-
// Nie podano nazwy użytkownika lub hasła gorytm DES.
if (empty($_POST['username']) || Zasada działania każdego systemu
empty($_POST['password']))
uwierzytelniania jest niemal identyczna.
return -1;
$js = $_POST['js']; Po podaniu nazwy użytkownika i hasła
$key = $_SESSION['key']; skrypt dokonuje porównania tych danych
z informacjami przechowywanymi w bazie
// Klucz przesłany w rządaniu HTTP nie zgadza się z tym danych lub pliku. Najczęściej, ze wzglę-
// zapisanym w sesji
dów bezpieczeństwa, hasło użytkownika
if ($key != $_POST['key'])
return -2; nie jest przechowywane w postaci jawnej
– do bazy zapisujemy hasz hasła. Do two-
// Wyszukanie rekordu administratora rzenia tego rodzaju haszy możemy użyć
// o podanej nazwie użytkownika funkcji crypt. Jest ona standardowo do-
$mysql_handle = mysql_connect('host', 'username',
stępna w każdej instalacji PHP, więc nie
'password')
or die(mysql_error()); ma potrzeby ponownej komplikacji PHP,
mysql_select_db('test', $mysql_handle) czy modyfikacji pliku konfiguracyjnego.
or die(mysql_error()); Spróbujmy na początek stworzyć pro-
$mysql_result = mysql_query('SELECT username, password sty przykład oparty o funkcję crypt. Jego
FROM admin
kod źródłowy znajduje się na Listingu 4.
WHERE username = "'.mysql_real_escape_string(
$_POST['username'], $mysql_handle).'"'); Przy każdym przeładowaniu strony/
skryptu uzyskamy unikalną wartość ha-
// Brak rekordu administratora sza. Dzieje się tak dlatego, że za każdym
// o podanej nazwie użytkownika razem tworzony jest losowy ciąg znaków
if (mysql_num_rows($mysql_result) == 0)
– $salt – niezbędny w procesie tworze-
return -3;
$row = mysql_fetch_assoc($mysql_result); nia skrótu. Od drugiego argumentu wywo-
łania omawianej funkcji zależy jaki algo-
// Walidacja hasła w zależności od tego, rytm zostanie wykorzystany. I tak dla dwu-
// czy wykorzystany został JavaScript znakowej wartości zmiennej $salt będzie
if ($js) {
to standardowy algorytm DES, dla dzie-
require 'hmac_md5.php';
if (hmac_md5($row['password'], $key) != $_POST['password']) więcioznakowej – algorytm DES w wersji
return -4; rozszerzonej. Aby wykorzystać algorytm
} else { MD5, za zmienna $salt musi składać się
if (md5($_POST['password']) != $row['password']) z dwunastu znaków z początkowym łań-
return -4;
cuchem $1$, zaś dla algorytmu Blowfish
}
// Logowanie powiodło się, zwracamy nazwę użytkownika będzie to szesnaście znaków rozpoczy-
return $row['username']; nając od $2$ lub $2a$. Zmienna $salt jest
} później dołączana na początek wygenero-
session_start(); wanego skrótu.
$errorString = '';
Wróćmy do naszego przykładu,
$loginResult = doLogin();
switch ($loginResult) { w którym chcemy stworzyć skrypt uwie-
case -1: break; rzytelniania poprzez protokół HTTP. Na-
case -2: $errorString = zwy użytkowników i ich hasła trzymane
'Nieprawidłowa wartość klucza'; break; będą w pliku tekstowym (Listing 5).
case -3: $errorString =
Warto wspomnieć najpierw o cieka-
'Nieprawidłowa nazwa użytkownika'; break;
case -4: $errorString = wej właściwości funkcji crypt. Jeśli spró-
'Nieprawidłowe hasło'; break; bujemy stworzyć hasz informacji przesła-
default: nej przez użytkownika (przykładowo ha-
$_SESSION['username'] = $loginResult; sła) podając jako $salt hasz trzymany
header('Location:
w bazie danych lub pliku (wzorzec hasła),
http://server.com/admin/panel.php');
die(); funkcja powinna zwrócić nam identyczny
} skrót. Sytuacja ta ma miejsce tylko wtedy,
$_SESSION['key'] = md5(uniqid(rand(), true)); gdy podane hasło jest zgodne z tym wy-
korzystywanym przy tworzeniu skrótu po
?>
raz pierwszy. Wykorzystamy tę własność
w naszym skrypcie uwierzytelniania.

PHP Solutions Nr 4/2006 www.phpsolmag.org 37

Bezpieczeństwo Kryptografia w PHP
Pamiętajmy, że uwierzytelnianie oparte na
protokole HTTP dostępne jest jedynie wte-
dy, jeśli nasze PHP działa jako moduł Apa-
che. Jeżeli jest inaczej (czyli PHP działają-
ce jako CGI), nasz przykład nie zadziała.
Przyjrzyjmy się Listingowi 6. Na po-
czątku musimy sprawdzić, czy użytkownik
przesłał już swój login i hasło. Jeżeli nie,
wysyłamy odpowiednie nagłówki HTTP,
które poinformują przeglądarkę, by wy-
świetlić odpowiednie okno logowania. Te
same nagłówki będą wysyłane, jeżeli po-
damy błędne dane logowania. Gdy użyt-
kownik przesłał nam już odpowiednie da-
ne, musimy pobrać zawartość pliku, któ-
ry pełni funkcje naszej bazy i przechowuje
hasła użytkowników. Przy pomocy funkcji
explode podzielimy pobrane dane, oddzie-
lając nazwy użytkowników i hasła. Ostat-
ni krok to pętla, która przechodzi przez
wszystkie rekordy, sprawdzając, czy użyt-
kownik może być dopuszczony do danej
strony. Aby sprawdzić poprawność hasła,
wykorzystujemy właściwość funkcji crypt
opisaną wcześniej.
Jak widać może być ona bez proble-
mu wykorzystania w celu stworzenia pro-
stego systemu uwierzytelniania. Mimo
wszystko jednak lepszym pomysłem jest
korzystanie z algorytmów takich jak MD5
czy SHA1 (czyli funkcji md5, sha1), ponie-
waż algorytm DES ma znacznie mniejszą
złożoność, a przy tym podczas tworzenia
skrótu wykorzystywane jest tylko 8 pierw-
szych znaków.
Zaawansowana
kryptografia – MCrypt
MCrypt jest rozszerzeniem PHP udostęp-
niającym metody pozwalające na szyfro-
wanie danych przy użyciu algorytmów ta-
kich jak DES, TripleDES, Blowfish, RC2
i wielu innych, lista najpopularniejszych al-
gorytmów dostępnych dla tego rozszerze-
nia umieszczona została w Tabeli 2. Opis
instalacji i konfiguracji biblioteki znajdu-
je się w Ramce Instalacja rozszerzenia
MCrypt.
MCrypt jest potężnym narzędziem,
dlatego też na jego podstawie stworzy-
my dość rozbudowany przykład. Napi-
szemy aplikację, która pozwoli nam na
przechowywanie na serwerze plików
dowolnego typu w postaci zaszyfrowa-
nej, a pobranie ich na lokalny dysk moż-
liwe będzie jedynie po podaniu właści-
wego hasła, identycznego z tym uży-
tym w procesie szyfrowania dokumen-
tu. Wszystkie dane (czyli zaszyfrowa-
38
ne pliki i szczegółowe informacje o nich, Na początek coś prostego
takie jak wielkość czy typ MIME) – szyfrujemy fragment tekstu
przechowywać będziemy w bazie da- Zanim przejdziemy do implementacji na-
nych. Zapytanie SQL tworzące odpo- szej bezpiecznej składnicy danych, po-
wiednią tabelę przedstawiliśmy na Li- znajmy schemat działania i możliwości
stingu 7. W odpowiednich kolumnach rozszerzenia MCrypt. Na Listingu 8 przed-
przechowywać będziemy nazwę pliku, stawiony został przykładowy kod PHP, któ-
datę umieszczenia w bazie, typ MIME, rego zadaniem jest szyfrowanie podanego
a także długość oryginalnego pliku, klucz łańcucha znaków przy pomocy klucza,
i sam plik w postaci zaszyfrowanej. a następnie jego odszyfrowanie.
Listing 4. Przykład wykorzystania funkcji crypt
<?php
$password = 'qwerty';
$salt = '$1$abcde$';
$hash = crypt($password, $salt);
echo $hash;
?>
Listing 5. Format danych pliku z danymi użytkowników
admin:$1$Lp5.2//.$UMLhAWJJB9fLR.FU4gSAw1
user:$1$hI3.Wd0.$thbtd1at0auCNfn7s5Bdy1
Listing 6. Skrypt walidacji danych podczas autoryzacji
<?php
define('USERS_FILE', 'users.txt');
if (isset($_SERVER['PHP_AUTH_USER']) && isset($_SERVER['PHP_AUTH_PW']))
{
$users = explode("\n", file_get_contents(USERS_FILE));
foreach($users as $user)
{
$user = explode(':', trim($user), 2);
if($user[0] == $_SERVER['PHP_AUTH_USER'])
{
if(crypt($_SERVER['PHP_AUTH_PW'], $user[1]) != $user[1])
{
header('WWW-Authenticate: Basic realm="Private"');
header('HTTP/1.0 401 Unauthorized');
exit;
}
break;
}
}
}
else
{
header('WWW-Authenticate: Basic realm="Private"');
header('HTTP/1.0 401 Unauthorized');
exit;
}
?>
Listing 7. Struktura tabeli przechowującej dane zaszyfrowanych plików
CREATE TABLE 'secure_files' (
'id' int(11) unsigned NOT NULL auto_increment,
'name' varchar(100) default NULL,
'mime_type' varchar(30) default NULL,
'date' int(10) unsigned default '0',
'length' varchar(255) default '0',
'key' varchar(32) default NULL,
'data' text,
PRIMARY KEY ('id')
) TYPE=MyISAM;
www.phpsolmag.org PHP Solutions Nr 4/2006
 Kryptografia w PHP Bezpieczeństwo

Tabela 1. Algorytmy dostępne natywnie w PHP oraz poprzez rozszerzenie MHASH sca w pamięci. Korzystamy w tym celu
Nazwa algorytmu Natywnie / Nazwa funkcji MHASH / Nazwa stałej z funkcji mcrypt_generic_init, przekazu-
jąc jej utworzone wcześniej uchwyty do
ALDER32 X – MHASH_ADLER32
modułu i wektora inicjującego, jak rów-
CRC32 X – crc32( ) X – MHASH_CRC32
nież wartość klucza, który będzie wyko-
GOST X – MHASH_GOST rzystywany w procesie szyfrowania. Klucz
HAVAL128 X – MHASH_HAVAL128 został przycięty do maksymalnej długo-
HAVAL160 X – MHASH_HAVAL160 ści obsługiwanej przez wybrany algorytm.
HAVAL192 X – MHASH_HAVAL192 Następnie wywołujemy funkcję mcrypt_
generic, której wynikiem jest zaszyfrowa-
HAVAL256 X – MHASH_HAVAL256
ny łańcuch znaków. Po wszystkim zwal-
MD4 X – MHASH_MD4 niamy zarezerwowaną pamięć funkcją
MD5 X – md5( ), md5_file( ) X – MHASH_MD5 mcrypt_generic_deinit i kończymy pra-
RIPEMD160 X – MHASH_RIPEMD160 cę z biblioteką MCrypt poprzez wywoła-
SHA1 X – sha1( ), sha1_file( ) X – MHASH_SHA1 nie mcrypt_module_close. Deszyfrowanie
informacji przebiega niemal analogicznie,
SHA256 X – MHASH_SHA256
z tą różnicą, że zamiast funkcji mcrypt_
TIGER X – MHASH_TIGER
generic stosujemy mdecrypt_generic,
TIGER128 X – MHASH_TIGER128 która przyjmuje identyczne argumenty co
TIGER160 X – MHASH_TIGER160 poprzednia.

Aby zainicjować mechanizmy bi-
blioteki Mcrypt, musimy wywołać funk-
cję mcrypt_module_open, która jako pierw-
szy argument przyjmuje nazwę algoryt-
mu, z którego chcemy skorzystać. Drugi
i czwarty parametr to ścieżki do odpowied-
nich modułów, pozwalających na skorzy-
stanie z danego algorytmu. Pozostawienie
ich pustych, jak w przykładzie, powodu-
je wykorzystanie ścieżek zdefiniowanych
w pliku konfiguracyjnym php.ini. Trzeci ar-
gument definiuje tryb, w jakim ma odby-
wać się szyfrowanie – my skorzystamy
z trybu ecb. Wszystkie możliwe tryby szy-
frowania wraz z opisem umieszczone zo-
stały w Tabeli 3. Wynik działania omawia-
nej funkcji zapisujemy w zmiennej pomoc-
niczej $td. Kolejnym krokiem jest utworze-
nie za pomocą funkcji mcrypt_create_iv
tzw. wektora inicjującego. Funkcja ta
wymaga podania rozmiaru wektora oraz
źródła danych losowych. Najlepiej skorzy-
stać ze stałej MCRYPT_RAND, ponieważ spo-
sób ten działa zarówno pod systemem
Linux jak i Windows. W tym miejscu bi-
blioteka MCrypt jest gotowa na przyjęcie
danych do zaszyfrowania. Najpierw musi-
my zarezerwować odpowiednią ilość miej-
Bezpieczna składnica danych
Posiadając już niezbędną wiedzę na te-
mat wykorzystania biblioteki MCrypt, na-
piszmy odpowiednie funkcje do naszej
aplikacji. Kod źródłowy skryptu szyfrują-
cego przesyłany plik przedstawiony jest
na Listingu 9.
Przed dodaniem rekordu do tabe-
li sprawdzamy czy użytkownik podał
wymagany klucz oraz czy sam plik został
pomyślnie przesłany na serwer. Następ-
nie tworzymy skrót klucza wykorzystując
algorytm MD5, aby później przy pobie-
raniu pliku móc szybko zweryfikować je-
go prawidłowość. Unikniemy tym samym
sytuacji, gdy ktoś ściągnie plik, po czym
okaże się, że pomylił klucze, a ściągnięty
plik jest bezużyteczny. Po odczytaniu pliku
szyfrujemy jego zawartość i dodajemy od-
powiedni wpis do bazy danych.
Zobaczmy, jak wygląda funkcja
pobierania wcześniej dodanych plików.

Instalacja rozszerzenia
MCrypt
Jeżeli posiadasz system Windows, mu-
sisz posiadać plik libmcrypt.dll do-
stępny do pobrania ze strony http://
ftp.emini.dk/pub/php/win32/mcrypt/,
a następnie umieścić go w katalogu c:
\windows\system32\. Posiadacze innych
systemów powinni odwiedzić stronę http://
mcrypt.sourceforge.net/ i pobrać źródła
biblioteki, a następnie je skompilować.
Aby korzystać z rozszerzenia MCrypt
w PHP, musimy go skompilować z dyrek-
tywą -with-mcrypt[=DIR] gdzie DIR to
ścieżka do biblioteki libmcrypt.
Rysunek 2. Strona domowa rozszerzenia MCrypt dla PHP (http://php.net/mcrypt)

PHP Solutions Nr 4/2006 www.phpsolmag.org 39

Bezpieczeństwo Kryptografia w PHP

Tabela 2. Najpopularniejsze algorytmy szyfrowania dostępne w rozszerzeniu MCrypt Najpierw dokonujemy porównania klu-
Nazwa stałej Algorytm Rozmiar Rozmiar cza nadesłanego przez użytkownika
klucza bloku z tym przypisanym do danego pliku. Jeśli
MCRYPT_3DES Potrójny DES 168 64 klucze (a w praktyce ich skróty MD5) są
identyczne możemy rozszyfrować zwar-
MCRYPT_THREEWAY 3way 96 96
tość pliku. Cały ten proces nie różni się
MCRYPT_BLOWFISH Blowfish do 448 64
znacznie od zwykłego szyfrowania i został
MCRYPT_CRYPT Szyfrowanie unikowe 104 8 już wcześniej zaprezentowany. Ponieważ
MCRYPT_DES DES 56 64 użytkownik ma mieć możliwość zapisania
MCRYPT_GOST Sowiet Gosudarswiennyj 256 64 pliku na swój dysk, koniecznie staje się
wysłanie odpowiednich nagłówków do je-
MCRYPT_IDEA International Data Encryption 128 64
Algorithm go przeglądarki. Wykorzystamy do tego
funkcję header oraz nagłówki Content-
MCRYPT_SERPENT Serpent 128, 192 128
lub 256 Type i Content-Disposition. Na koniec,
jeszcze przed wysłaniem zawartości pliku,
MCRYPT_TWOFISH Twofish 128, 192 128
lub 256 musimy usunąć ewentualne puste znaki,
które funkcje szyfrujące mogły pozostawić
na końcu pliku, a które mogłoby spowodo-
Listing 8. Przykład wykorzystania rozszerzenia MCrypt wać późniejsze błędy w jego odczycie. Ja-
ko że znamy długość oryginalnego pliku
<?php
// Nasz klucz i łańcuch znaków do zaszyfrowania (została zapisana w bazie danych), może-
$key = 'tajny klucz'; my to bez problemu wykonać przy użyciu
$plain_text = 'bardzo poufne dane, które trzeba zaszyfrować'; funkcji substr.
// Inicjacja mechanizmów szyfrujących Przedstawiony przykład pokazał,
$td = mcrypt_module_open('blowfish', '', 'ecb', '');
jak szybko możemy zaszyfrować nasze
$key = substr($key, 0, mcrypt_enc_get_key_size($td));
$iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_RAND); dane i jak przechowywać je w bazie.
// Szyfrowanie Mogą to być zarówno hasła jak i zawar-
mcrypt_generic_init($td, $key, $iv); tości całych plików. Pamiętajmy jednak,
$encrypted = mcrypt_generic($td, $plain_text); że proces szyfrowania 40MB pliku mo-
mcrypt_generic_deinit($td);
że dość znacznie obciążyć procesor,
echo $encrypted;
// Deszyfrowanie a także spowodować przepełnienie pa-
mcrypt_generic_init($td, $key, $iv); mięci przydzielonej dla PHP, co w efek-
$decrypted = mdecrypt_generic($td, $encrypted); cie spowoduje wyświetlenie komuni-
mcrypt_generic_deinit($td);
echo $decrypted;
mcrypt_module_close($td);
?>
O autorach
Listing 9. Skrypt szyfrujący przesłany plik
Łukasz Lach studiuje informatykę na
<?php
$file = $_FILES['file'];
wydziale Cybernetyki Wojskowej Aka-
if($file['error'] == UPLOAD_ERR_OK && !empty($_POST['key'])) demii Technicznej w Warszawie. Od
{ kilku lat zajmuje się tworzeniem apli-
if(!empty($_POST['name'])) kacji internetowych z wykorzystaniem
$file['name'] = $_POST['name'];
takich technologii jak PHP, XHTML,
$key = md5($_POST['key']);
$data = file_get_contents($file['tmp_name']);
JavaScript czy XML. Posiada certyfi-
$td = mcrypt_module_open('des', '', 'ecb', ''); kat Zend Certified Engineer. Jest au-
$subkey = substr($key, 0, mcrypt_enc_get_key_size($td)); torem licznych publikacji prasowych
$iv_size = mcrypt_enc_get_iv_size($td); w czasopismach polskich i zagra-
$iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
nicznych na temat tworzenia aplikacji
mcrypt_generic_init($td, $subkey, $iv);
$encrypted_data = mcrypt_generic($td, $data);
internetowych i bezpiecznym progra-
mcrypt_generic_deinit($td); mowaniu w PHP.
mcrypt_module_close($td); Michał Stanowski opanował
mysql_query("INSERT INTO 'secure_files' ('name', 'mime_type', 'date', w stopniu zaawansowanym umiejęt-
'length', 'key', 'data')
ność obiektowego tworzenia aplikacji
VALUES ('{$file['name']}', '{$file['type']}', UNIX_TIMESTAMP(),
'{$file['size']}', '$key', '".mysql_real_escape_string
w PHP5. Interesuje się bezpieczeń-
($encrypted_data)."')") or die(mysql_error()); stwem aplikacji internetowych oraz ich
} użytecznością. Swój wolny czas spę-
?> dza zwiedzając Polskę na rowerze.

40 www.phpsolmag.org PHP Solutions Nr 4/2006

 Kryptografia w PHP Bezpieczeństwo

Tabela 3. Tryby szyfrowania wspierane przez rozszerzenie

MCrypt
Nazwa stałej Opis

MCRYPT_MODE_ECB Tryb książek elektronicznych

MCRYPT_MODE_CBC Tryb łańcuchowego łączenia blo-

ków
MCRYPT_MODE_CFB Tryb sprzężenia zwrotnego szy-
frowania
MCRYPT_MODE_OFB Tryb sprzężenia zwrotnego wyj-
ścia z 8 bitami sprzężenia
MCRYPT_MODE_NOFB Tryb sprzężenia zwrotnego wyj-
ścia z liczbą bitów sprzężenia
równą rozmiarowi bloku algo-
rytmu
MCRYPT_MODE_STREAM Tryb szyfrowania strumienio-
wego

Rysunek 3. Aplikacja bezpiecznego przechowywania plików na

serwerze w postaci zaszyfrowanej

katu o błędzie i zakończenie działania skryptu. Wydłużenie

czasu szyfrowania może być również spowodowane wybra-
niem algorytmu o dużej złożoności obliczeniowej. Dobrym
rozwiązaniem jest w tym wypadku szyfrowanie pojedynczych
bloków danych. O tym, jak duży może być blok dla danego
algorytmu szyfrującego, informuje nas funkcja mcrypt_get_
block_size lub mcrypt_enc_get_block_size.

Podsumowanie
W artykule przedstawiliśmy tylko część możliwości funkcji
kryptograficznych, jakie możemy zastosować w aplikacjach
PHP. Nasze przykłady pokazały Wam, jak zabezpieczać da-
ne czy tworzyć bezpieczne systemy uwierzytelniania. W ko-
lejnych artykułach opowiemy m.in. o wykorzystaniu bibliote-
ki OpenSSL oraz wysyłaniu bezpiecznych emaili z poziomu
PHP. n

PHP Solutions Nr 4/2006 41

Narzędzia
Zend Framework
Piotr Szarwas
W SIECI
• http://framework.zend.com/
– strona główna Zend Fra-
mework
• http://www.zend.com/php_
collaboration_project – stro-
na główna PHP Collabora-
tion Project.
• http://devzone.zend.com/
– strona główna Zend Deve-
loper Zone.
• http://www.zend.com/phpide/
– z tej strony można pobrać
Eclipse PHP IDE
• http://framework.zend.com/
svn/framework/ – dostęp
do repozytorium kodu Zend
Framework poprzez WWW
i SVN.
42
Pojawienie się Zend Frameworka wzbudziło
w świecie PHP wiele emocji. Zend, jedyna
prawdziwa firma od PHP, wypuściła – tak jak
należało – prawdziwy Framework dla PHP.
Wszyscy oczekiwali po tym rozwiązaniu bardzo
wiele i... nie zawiedli się.
M
imo że cały projekt jest jeszcze
mocno rozwojowy, zdobywa co-
raz większą popularność i uzna-
nie tysięcy deweloperów z całego świata.
Czy zatem Zend Framework to rewolu-
cyjne rozwiązanie? Z wielu względów na
pewno tak: na razie można jedynie przy-
puszczać, że stanie się on pewnym stan-
dardem, przez co tworzenie i rozwijanie
aplikacji w PHP stanie się dużo wydajniej-
sze i prostsze. Wielu deweloperów może
zacząć budować aplikacje używając tego
samego, solidnego narzędzia i rozmawiać
tym samym językiem. Wsparcie Frame-
worka przez firmę Zend i jej najlepszych
deweloperów może być gwarantem suk-
cesu i powszechności użycia.
Mimo to, za wcześnie jeszcze na peł-
ną ocenę i porównywanie projektu do tak
znanych rozwiązań jak eZ components,
WACT, Solar czy Seagull. W trakcie pisa-
nia tego artykułu Zend Framework dostęp-
ny był w wersji 0.1.2, której daleko jest do
bycia kompletną i stabilną, więc walka by-
www.phpsolmag.org
Stopień trudności: lll
łaby nierówna. Porównanie to z pewno-
ścią przedstawimy w jednym z kolejnych
artykułów. Póki co zacznijmy od samego
początku.
Czy potrzebujemy
kolejnego frameworka?
Pytanie to zadawało wielu programistów,
kiedy usłyszeli o pomyśle Zenda. Wielu
z Was wie, że dla PHP istnieje już wiele
frameworków, wystarczy zajrzeć na stronę
Co należy wiedzieć...
Przydatna będzie podstawowa znajo-
mość budowy frameworków i programo-
wania obiektowego w PHP.
Co obiecujemy...
Z artykułu dowiesz się, jak zbudować
prostą aplikację do agregacji newsów
z kanałów RSS z wykorzystaniem Zend
Frameworka. Pokażemy Wam najważ-
niejsze komponenty Frameworka i po-
wiemy, czy warto używać go w środowi-
sku produkcyjnym.
PHP Solutions Nr 4/2006

http://www.phpwact.org/php/mvc_frame-
works i sprawdzić, że ich ilość w przypad-
ku frameworków MVC przekracza 40.
Czy warto więc pisać kolejny i odkry-
wać Amerykę na nowo? Pomysł jest jesz-
cze za „świeży”, aby móc powiedzieć, czy
jest potrzebny społeczności PHP, czy też
nie. Warto dodać, że Zend Framework
nie jest zwykłym framoworkiem MVC.
Jak twierdzą jego twórcy, ma rozwiązy-
wać 80% wszystkich zagadnień pojawia-
jących sie podczas pisania aplikacji webo-
wych, dlatego między innymi w jego skład
wchodzą takie komponenty jak Zend_Db,
Zend_Mail, Zend_Pdf, Zend_Log czy też
Zend_Search. Wszystkie one mają przy-
spieszyć i ułatwić pracę programisty, jak
żaden inny framework do tej pory.
Założenia i motywacje
Głównym celem projektu Zenda jest stwo-
rzenie frameworka, w którym będzie się
pisać równie łatwo jak w samym PHP
i promowanie PHP 5, a w szczególności
jego cech obiektowych. Szczególny nacisk
położono tu na bezpieczeństwo. Frame-
work ten w założeniach będzie mógł rywa-
lizować z takimi frameworkami jak Ruby
on Rails czy Spring, będzie posiadał testy
jednostkowe (Unit Tests), dobre przykłady,
dokumentację i tutoriale. Wszystko to nie
jest niczym innowacyjnym. To co jest jed-
nak wyjątkowe w przypadku Zend Frame-
owrka, to społeczność, która ma uczestni-
czyć w budowaniu kodu. Już teraz należą
do niej największe firmy IT i wielu znanych
specjalistów PHP.
Ogólna architektura
i najważniejsze składniki
Zend Framework ma budowę kompo-
nentową. Został tak zaprojektowany, aby
praktycznie każdy z jego elementów da-
ło się wykorzystać osobno. Oznacza to,
że jeżeli korzystamy już z jakiegoś frame-
worka nie musicie się w całości przesia-
dać na Zend Framework możecie wyko-
rzystać tylko te z jego elementów, które są
dla was użyteczne.
Wielu osobom framework kojarzy
się z kawałkiem kodu, który w pewnej
mniej lub bardziej skończonej formie
implementuje wzorzec architektoniczny
MVC. Tak jak wcześniej wspomnieliśmy,
Zend Framework to nie tylko imple-
mentacja wzorca MVC, to również sze-
reg bardzo przydatnych i praktycznych
PHP Solutions Nr 4/2006
Zend Framework Narzędzia
komponentów. Zaliczają sie do nich ją się w specjalnym katalogu “incubator”.
przede wszystkim: Zend_Db, Zend_Feed, Są to moduły, które nie weszły jeszcze
Zend_InputFilter, Zend_Mail, Zend_Pdf, w skład Frameworka, ale prawdopodobnie
Zend_Search, Zend_Log i Zend_Service. niedługo się w nim znajdą. Ich kod jest już
Pełna lista komponentów wraz z krótkim jednak na tyle stabilny, że można próbo-
opisem znajduje się w Tabeli 1. wać je wykorzystywać we własnych pro-
Praktycznie każdy z modułów jest na- jektach i co najważniejsze wpływać na ich
pisany tak, że jeżeli tylko istnieje taka po- funkcjonalność, chociażby poprzez wysy-
trzeba możemy nie ingerując w kod frame- łanie maili do autorów kodu.
worka dodawać do niego potrzebne nam
funkcjonalność. Możliwe jest to dzięki sta- Piszemy pierwszą
rannemu projektowaniu i wykorzystywaniu aplikację
takich technik programowania obiektowe- W artykule postanowiłem skupić się na kil-
go jak pisanie do interfejsu czy też kompo- ku komponentach, które moim zdaniem
zycja. Wraz z podstawowymi komponen- mogą być najczęściej wykorzystywane
tami dostajemy również te, które znajdu- w codziennej pracy. Zaliczyłem do nich
PHP Collaboration Project
Podczas konferencji Zend/PHP Conference and Expo 2005, która obyła się w drugiej poło-
wie października 2005 w San Francisco świat usłyszał o projekcie PHP Collaboration Pro-
ject. Celem projektu miałoby być utworzenie społeczności składającej się z firm i niezależ-
nych programistów, którzy razem stworzą narzędzia pozwalające PHP zaistnieć na poważ-
nie w świecie wielkich projektów informatycznych. Głównym motorem tego projektu stały
się trzy składniki Zend Framework, PHP Eclipse IDE i Zend Developer Zone. Zend Frame-
work miałby stać się podstawowym narzędziem zawierającym wszystkie potrzebne kom-
ponenty do napisania aplikacji webowej, PHP Eclipse IDE miałoby stanowić profesjonal-
ne środowisko programistyczne (niestety część jego składników ma być płatna), natomiast
Zend Developer Zone to miejsce wymiany idei i pomysłów dla deweloperów. Wszystko to
dostępne za darmo. Tuż po ogłoszeniu tej inicjatywy wielu programistów w swoich blo-
gach i wypowiedziach na różnych forach komentowało ten fakt i, jak to było do przewidze-
nia, świat podzielił się na kilka frakcji. Byli tacy, którzy twierdzili, że Zend chce zdominować
wolny świat PHP, byli umiarkowani sceptycy, którzy mówili, że pomysł jest dobry, ale prze-
cież jest już tyle dobrych frameworków, byli też tacy, którzy twierdzili, że to świetny pomysł
i kolejny sukces PHP. Tych, którzy chcieliby prześledzić historię tych wypowiedzi odsyłam
do archiwum serwisu phpdeveloper.org.
Zend Framework – szybki start
Kod frameworka można pobrać ze strony http://framework.zend.com/download. Aktual-
na wersja ma numer 0.1.2. Dodatkowo należy jeszcze tak skonfigurować PHP, aby ścież-
ka gdzie umieścimy katalog z frameworkiem, była uwzględniana przez funkcje require
i include przy poszukiwaniu plików. Można to zrobić na trzy sposoby w zależności od
możliwości konfiguracyjnych, do których macie dostęp:
• zmodyfikować zmienną include _ path w pliku php.ini,
• utworzyć plik .htaccess w katalogu głównym aplikacji i umieścić w nim wpis php_va-
lue include_path = '/ścieżka/do/katalogu'
• umieścić w pliku index.php wywołanie systemowej funkcji:
ini _ set( 'include _ path', ini _ get('include _ path').PATH _ SEPARATOR.'/
ścieżka/do/katalogu' );.
Aby móc korzystać z części MVC frameworka, potrzebny jest Apache z modułem mod_
rewrite. W przypadku problemów z instalacją niedziałających komponentów, czy też innych
problemów odsyłam Was do stron FAQ Frameworka (http://framework.zend.com/faq),
strony informującej o bugach (http://framework.zend.com/bugs) i dokumentacji (http://
framework.zend.com/manual). Dodatkowo wiele ciekawych informacji na temat frame-
worka możecie znaleźć w Zend Developer Zone znajdującej się pod adresem http://
devzone.zend.com/. Zawartość serwisu Zend Develor Zone jest o tyle ciekawa, że znaj-
dziecie tak szereg tutoriali i artykułów wprowadzających w tajniki programowania w PHP
i Zend Frameworka.
Warto jeszcze dodać, że jeżeli chcielibyście mieć dostęp do najświeższej wersji kodu
Zend Frameworka, od niedawna można pobrać jego kod z repozytorium SVN. Instrukcja
zawierająca informację, jak należy to zrobić dostępna jest na stronie Frameworka. Opcja
ta, jest niezwykle atrakcyjna, gdyż z mojej obserwacji wynika, że praktycznie każdego
dnia w repozytorium pojawiają się jakieś zmiany poprawiającej funkcjonalność kodu i nie
tylko.
www.phpsolmag.org 43
Narzędzia Zend Framework

Tabela 1. Najważniejsze komponenty Zend Frameworka

Zend_Controller
Zawiera klasy implementujące wzorzec MVC. Głównymi składnikami komponentu są:
Zend_Controller_Front Implementacja wzorca Front Controller wraz z wzorcem Intercepting Filter.
Zend_Controller_Router Odpowiada za dekompozycję URL-a do nazwy kontrolera i akcji, którą należy wykonać.
Zend_Controller_Dispatcher Odpowiada za znalezienie właściwego kontrolera i wywołanie w nim odpowiedniej akcji.
Zend_Controller_Action Podstawowa implementacja kontrolera akcji.
Zend_View
Komponent do budowy obiektów widoku wzorca MVC.
Zend_Db
Zestaw klas do wykonywania wszelkich operacji typu CRUD na bazach danych. Implementacja opiera się na PDO:
Zend_Db_Adabter Warstwa abstrakcji uniezależniająca od różnych dialektów baz danych.
Zend_Db_Select Klasa ułatwiająca budowanie złożonych zapytań SQL przy pomocy interfejsu obiektowego. Jest to bar-
dzo prosta implementacja tzw. Criteria API znanego od dawna w świecie Javy.
Zend_Db_Table, Implementacja wzorca Active Row, niestety w obecnej chwili nie działa poprawnie z PDO, wspierany
Zend_Db_Table_Row jest jedynie driver mysqli.
Zend_Feed
Komponent do przetwarzania wiadomości RSS i Atom.
Zend_Filter
Klasa zawierająca szereg statycznych metod do służących do walidacji. Przed wykorzystaniem tej klasy należy koniecznie zapoznać się z jej
kodem. Powodów jest kilka po pierwsze część metod nie ma jeszcze implementacji (np. isEmail i isUri). Cześć metod do poprawnego dzia-
łania wymaga ustawienia odpowiedniego setlocale. W szczególności tyczy się to tych wszystkich metod, które korzystają z klas znakowych
([:alpha:],[:alnum:]). Implementacja metody isPhone nie jest dostosowana do standardów wielu krajów Europy i nie tylko.
Zend_HttpClient
Prosty klient HTTP
Zend_InputFilter
Klasa do filtrowania danych wejściowych (np. Tablice $_GET i $_POST). Klasa korzysta ze statycznych metod klasy Zend_Filter. Warte zapa-
miętania jest, że w podstawowej konfiguracji tablice $_GET i $_POST są ustawiane na null, a do danych w nich zawartych można odwoływać
się jedynie poprzez obiekty klasy Zend_InputFilter.
Zend_Json
Klasa serializująca zmienne PHP do formatu JSON. Więcej o formacie JSON możecie przeczytać na stronie http://www.json.org.
Zend_Log
Zestaw klas do logowania wszelkiego rodzaju operacji, z możliwością jednoczesnego logowania do wielu źródeł (np. plik i ekran).
Zend_Mail
Zestaw klas do budowania i wysyłania maili wraz z załącznikami. Posiada możliwość wysyłki maili zarówno przy pomocy funkcji mail jak
i bezpośredniego połączenia z serwerem SMTP.
Zend_Mime
Klasa zawierająca szereg użytecznych metod do współpracy z wiadomościami MIME.
Zend_Pdf
Komponent zawiera klasy do dynamicznej budowy plików PDF. Niestety wspierane są jedynie znaki ISO-8859-1, tak więc dla wielu ta klasa
jest póki co bezużyteczna.
Zend_Search
Jest to implementacja znanego z Javy silnika do wyszukiwania Lucene. Komponent napisany jest całkowicie w PHP, nie wymaga do swojego
działania bazy danych. Wszystkie potrzebne mu do działania dane przechowywane są w plikach. Niestety podobnie jak Zend_Pdf rozwiązanie
to wspiera w obecnej chwili jedynie znaki ISO-8859-1. Autorzy piszą, że dodanie wsparcia dla innych stron kodowych jest na ich liście TODO.
Zend_Service
Zestaw klas wpierających komunikację z Web Serwisami. Najważniejsze składniki komponentu to:
Zend_Service_Rest Klasa ogólnego zastosowania dla Web Serwisów typu REST
Zend_Service_Yahoo Klasa ułatwiająca korzystanie z wielu Web Serwisów Yahoo
Zend_Service_Amazon Klasa ułatwiająca korzystanie z wielu Web Serwisów Amazon
Zend_Service_Flickr Klasa ułatwiająca korzystanie z wielu Web Serwisów Flickr
Zend_XmlRpc
Komponent ułatwiający zdalne wywoływanie procedur w standardzie XML-RPC
Zend_Cache
Kod tego komponentu znajduje się w tzw. inkubatorze nie jest więc podstawowym składnikiem Frameworka. Służy do cachowania wszelkie-
go rodzaju danych, w plikach lub bazie SQLite.

44 www.phpsolmag.org PHP Solutions Nr 4/2006

Narzędzia Zend Framework
��
��
��
��
��
��
��
��
��
��
��
��
��
��
��
Rysunek 1. Struktura bazy danych do agregacji newsow z kanałów RSS
Zend_Controller, Zend_View, Zend_Db,
Zend_Log i Zend_Mail.
Wykorzystując te moduły napisze-
my prostą aplikację do agregacji newsów
z kanałów RSS. Pominiemy cześć apli-
kacji do agregacji newsów, a skupimy się
jedynie na części prezentacyjnej. Zakłada-
my, że każdy news należy do jednego ka-
nału i jednej kategorii, a kategorie są od
siebie niezależne. Struktura bazy danych
pokazana jest na Rysunku 1. Funkcjonal-
ność tej części jest następująca: użytkow-
nik może wyświetlić wszystkie newsy dla
jednej kategorii i wysłać do kogoś ema-
il z powiadomieniem o ciekawym newsie.
Każda akcja wysłania emaila jest logowa-
na w celu zbierania statystyk.
Tworzenie kodu rozpoczniemy od pli-
ku index.php, jego zawartość pokazana
jest na Listingu 1. Skrypt ten jako jedy-
ny widoczny jest przez WWW. Odpowia-
da za załadowanie wszystkich potrzeb-
nych klas Zend Frameworka przy pomo-
cy statycznej metody loadClass znajdu-
jącej się w klasie Zend. Klasa ta posia-
da jeszcze kilka pomocnych metod, któ-
re zaprezentuję w dalszej części artykułu.
Kolejnym krokiem jest konfiguracja logge-
ra, bazy danych i front kontrolera. W przy-
padku loggera zakładamy, że do logowa-
nia będzie wykorzystywany adapter logu-
jący dane do pliku log.txt znajdującego się
46
��
��
��
��
��
��
��
��
��
��
��
��
��
��
w katalogu log. Poza logowaniem do pli-
ku można jeszcze wysyłać logi na ekran
i do bazy danych. Jeżeli jest taka potrzeba
możemy napisać własny mechanizm logo-
wania, wystarczy zaimplementować inter-
fejs Zend_Log_Adapter_Interface i zare-
jestrować swój adapter tak, jak zrobiłem
to w przykładzie. Kolejny krok to konfigu-
racja bazy danych. Jest ona bardzo pro-
sta wymaga jedynie wywołania statycznej
metody factory na klasie Zend_Db. Me-
toda ta zwróci obiekt/sterownik połącze-
nia do bazy danych, na którym będzie-
my wykonywać wszystkie operacje zwią-
zanie z dostępem do danych. W naszym
przypadku zwrócony obiekt opakowuje
mechanizm PDO. Zend Framework do-
starcza jeszcze dwa dedykowane sterow-
niki dla Oracla i MySQL ten drugi działa
w oparciu o rozszerzenie mysqli. Po uru-
chomieniu połączenia do bazy danych po-
zostało nam jedynie skonfigurowanie kla-
sy Zend_Controller_Front stanowiącej
implementację wzorca Front Controller
i klasy Zend_View. Jedynymi parametrami
konfiguracyjnymi dla tych klas są ścież-
ki, w których znajdować się będą utwo-
rzone w późniejszej części artykułu kon-
trolery akcji i widoki. Podczas powyższe-
go procesu konfiguracji utworzyliśmy trzy
bardzo ważne obiekty: sterownik bazy da-
nych, widok i front kontroler. Dwa z nich
www.phpsolmag.org
musimy przekazać do niższych warstw
aplikacji. Najlepiej zrobić to wykorzystu-
jąc dwie statyczne metody znajdujące się
w klasie Zend: register i registry. Meto-
dy te wspólnie implementują powszechnie
znany wzorzec Registry, pierwsza z nim
zapisuje obiekty w rejestrze, a druga pobie-
ra je z niego. Sam rejestr jest Sigletonem
dostępnym w każdym miejscu warstwy apli-
kacji. Ostatnim elementem pliku index.php
jest wywołanie metody dispatch na obiek-
cie front kontrolera, która rozpoczyna pro-
ces przetwarzania, w wyniku którego od-
naleziona zostanie odpowiednia akcja i wi-
dok (Rysunek 2). Dla nas najważniejsza
jest wiedza, że dzięki modułowi mod_rew-
rite wszystkie odwołania do aplikacji prze-
chodzą przez index.php. Zend Framework
wyposażony jest w prosty dispatcher tych-
że odwołań na kontrolery i akcje, jego dzia-
łanie najlepiej wyjaśnić na podstawie odwo-
łań pojawiających się mojej aplikacji:
• / przekierowuje do akcji indexAction
w kontrolerze IndexController,
• /index/ przekierowuje do akcji inde-
xAction w kontrolerze IndexController,
• /index/index/ przekierowuje do akcji
indexAction w kontrolerze IndexCon-
troller,
• /mail/ przekierowuje do akcji index-
Action w kontrolerze IndexController,
PHP Solutions Nr 4/2006
 Zend Framework Narzędzia

����������������������� ��������������������������������� ������������������������ ����������������������������

�������������

�����������������

����������
�������������������

������������������������

����������������

�������������

�����������������

�������������������������

Rysunek 2. Diagram sekwencji prezentujący schemat przetwarzania odwołania do strony przez klasę Zend_Controller_Front.
Z uwagi na przejrzystość pewne mało znaczące elementy procesu zostały pominięte

• /mail/send przekierowuje do akcji sen-

dAction w kontrolerze MailController,
• /index/index/id/2 przekierowuje do ak-
cji indexAction w kontrolerze index
z parametrem id równym 2.
Podsumowując: jeżeli nie został wy-
brany żaden kontroler, dispatcher
wywoła akcję indexAction w kontrole-
rze IndexController, jeżeli została po-
dana nazwa kontrolera, a nie została
podana nazwa akcji, dispatcher wywoła
akcje indexAction w podanym kontrole-
rze. Aby przekierowania zadziałały, pli-
ki, w których znajdują się klasy kontro-
lerów, muszą mieć takie same nazwy
jak kontrolery.
Nasza aplikacja będzie składała się
z dwóch kontrolerów IndexController
i MailController. Pierwszy odpowiada za
wyświetlanie wiadomości RSS, drugi za
wysyłanie maili. Kod tych dwóch kontro-
lerów znajduje się na Listingach 2 i 3.
Wszystkie dziedziczą po abstrakcyjnej
klasie Zend_Controller_Action. Kontro-
ler IndexController zawiera dwie meto-
dy indexAction i noRouteAction. Metoda
noRouteAction ma specjalne zastoso-
wanie wywoływane przez front kontroler
(tylko w kontrolerze IndexController)
w sytuacji, gdy nie zostanie znalezio-
ny kontroler, który miał obsłużyć dane
żądanie. Każdy kontroler dziedziczący
Listing 1. Plik index.php – fundament naszej aplikacji
// dodajemy ścieżkę do Zend Framework
ini_set( 'include_path', ini_get('include_path').PATH_SEPARATOR.'../lib' );
// ładujemy główną klasę Zend (Zend.php),
// klasa ta zawiera jedynie statyczne metody.
include 'Zend.php';
// ładujemy wszystkie niezbędne klasy
Zend::loadClass('Zend_Controller_Front');
Zend::loadClass('Zend_Controller_Action');
Zend::loadClass('Zend_View');
Zend::loadClass('Zend_Db');
Zend::loadClass('Zend_Filter');
Zend::loadClass('Zend_InputFilter');
Zend::loadClass('Zend_Log');
Zend::loadClass('Zend_Log_Adapter_File');
Zend_Log::registerLogger(new Zend_Log_Adapter_File('../logs/info.txt'));
$dbParams = array ('host' => '127.0.0.1', 'username' => 'postgres',
'password' => '', 'dbname' => 'myrss');
$db = Zend_Db::factory('pdoPgsql', $dbParams);
$controller = Zend_Controller_Front::getInstance();
$controller->setControllerDirectory('../app/controllers');
$view = new Zend_View();
$view->setScriptPath('../app/views');
// zapisywanie obiektów w rejestrze
Zend::register('view',$view);
Zend::register('db',$db);
$controller->dispatch();

PHP Solutions Nr 4/2006 www.phpsolmag.org 47

Narzędzia Zend Framework
po klasie Zend_Controller_Action mu-
si implementować metodę indexAction,
w przypadku kontrolera IndexControl-
ler metoda ta odpowiada za wyświetle-
nie listy wszystkich kategorii RSS-ów
i listy RSS-ów należących do katego-
rii wybranej przez użytkownika aplika-
cji. Jeżeli żadna kategoria nie zosta-
ła wybrana zakładamy wybór pierwszej
z listy. Obiekt bazy danych i widoku,
na którym operuje akcja pobierane są
z rejestru. Dane z bazy pobieramy przy
pomocy metody query, która ma dwa
parametry, pierwszym jest zapytanie
SQL, a drugim opcjonalnym lista pa-
rametrów przekazywana do zapytania.
Działanie metody query z oboma para-
metrami prezentuje jej drugie wywołanie
w akcji index. Dzięki takiemu przekazy-
waniu parametrów są one zawsze qu-
otowane, co powoduje, że kod odpor-
ny jest na ataki SQL Injection. Metoda
query zwraca obiekt PDOStatement. Da-
ne pobrane z bazy przekazywane są
do widoku dzięki mechanizmowi ma-
gicznych metod __get i __set, który
jest wyjątkową cechą PHP. Identyczny
efekt można uzyskać wywołując metodę
assign na obiekcie widoku.
Ostatnią operacją wykonywaną
w akcji index jest wyświetlenie pliku wi-
doku. Zend Framework nie posiada me-
chanizmu szablonów, nie jest też sprzę-
żony z żadnym znanym rozwiązaniem
tego typu, dlatego jako szablony wyko-
rzystujemy standardowe pliki PHP, gdzie
językiem szablonów jest również PHP.
Przykładowy szablon pokazany jest na
Listingu 4. Szablon renderowany jest
wewnątrz obiektu widoku stąd wszystkie
dane przekazane do widoku dostępne
są pod zmienną $this, dodatkowo dzię-
ki takiemu podejściu możemy w szablo-
nie korzystać ze wszystkich metod klasy
Zend_View, należy do nich np. metoda
escape. Drugi kontroler naszej aplikacji
posiada również dwie metody: pierw-
sza, prostsza – indexAction – wyświe-
tla jedynie formularz do wysyłania ma-
ili. Druga metoda jest już znacznie cie-
kawsza, a jej głównym zadaniem jest
wysłanie maila do osoby, której adres
podamy w formularzu wysyłki i zalo-
gowanie tego faktu do pliku logu. Kod
został znacznie uproszczony – docelo-
we rozwiązanie powinno zawierać cho-
ciażby sprawdzanie, czy podany w for-
mularzu email jest faktycznie emailem.
Jak widać, wysłanie maila jest bar-
48
dzo proste, sprowadza się do utworze- Utworzenie logu jest jeszcze prost-
nia obiektu klasy Zend_Mail, ustaleniu sze, aby to zrobić wystarczy wywołać
adresata, odbiorcy, treści i tematu wia- statyczną metodę log klasy Zend_Log.
domości i w końcu wysłania maila. W najprostszym wydaniu metoda ta
Listing 2. Kod kontrolera InextController
// każda aplikacja musi posiadać kontroler o nazwie IndexController,
// jest on standardowo wywoływany wraz z akcją index w sytuacji, gdy użytkownik
// nie wymienił w URL-u ani kontrolera, ani akcji.
class IndexController extends Zend_Controller_Action {
// metoda indexAction jest wykonywana w sytuacji, gdy nie została podana
// żadna akcja w ramach kontrolera lub użytkownik wywołał akcję index.
public function indexAction() {
// pobieramy z rejestru wcześniej utworzone obiekty widoku
// i połączenia do bazy danych
$view = Zend::registry('view');
$db = Zend::registry('db');
// metoda query odpowiada za wykonywanie zapytań SQL do bazy, zwraca tzw.
// statement. Wywołanie na obiekcie statementu metody fetchAll powoduje,
// że zwrócone zostają rekordy w postaci ponumerowanej od zera tablicy
// tablic asocjacyjnych, w których kluczami są nazwy kolumn zwróconych
// w zapytaniu.
$categories = $db->query("SELECT * FROM feeds_categories
ORDER BY fc_name" )->fetchAll();
// klasa View implementuje magiczne metody __set i __get,
// dzięki którym w prosty sposób możemy w obiekcie widoku tworzyć nowe
// atrybuty, dane zapisane w tych atrybutach będą dostępne w szablonie pod
// zmienną $this->nazwa_atrybutu.
$view->categories = $categories;
// wszystkie przekazane do kontrolerów dane z zapytania dostępne są
// poprzez metodę _getParam, ma ona dwa parametry, pierwszym jest
// nazwa parametru, drugim wartość, która zostanie zwrócona w przypadku
// gdy data o podanej nazwie nie istnieje. Drugi parametr jest
// opcjonalny. Przed zapisaniem do zmiennej pomocniczej $categoryId
// parametru id filtrujemy jego zawartość, tak aby w $categoryId
// zapamiętać jedynie część liczbową id.
$categoryId = Zend_Filter::getDigits( $this->_getParam( 'id' ) );
if ( !$categoryId ){
$categoryId = $view->categories[0]['fc_id'];
}
$view->items = $db->query("SELECT feeds_items.* FROM feeds_channels
LEFT JOIN feeds_items
ON ( feeds_channels.fch_id = feeds_items.fch_id )
WHERE feeds_channels.fc_id = :fc_id
ORDER BY feeds_items.fi_pub_date",
array( "fc_id" => $categoryId ) )->fetchAll();
// metoda render odpowiada za wygenerowanie i wyświetlenie szablonu
echo $view->render('IndexView.php');
}
// metoda ta jest wywoływana w sytuacji, gdy użytkownik chciał odwołać się
// do nieistniejącego kontrolera. Metodę te wywołuje front kontroler.
public function noRouteAction() {
// w przypadku gdy zostanie wywołany nieistniejący kontroler
// przekierowujemy użytkownika na stronę główną aplikacji, czyli do
// kontrolera IndexController i metody indexAction.
$this->_redirect('/');
}
}
www.phpsolmag.org PHP Solutions Nr 4/2006
 Zend Framework Narzędzia

wymaga podania jednego parametru, dowym poziomem logowania jest DE- ne wysłanie maila, jeżeli ktoś odświeży
treści logu, jeżeli jest taka potrzeba, BUG. Po wysłaniu maila i zalogowaniu widok strony w przeglądarce.
jako drugi parametr możemy podać tego faktu, akcja sendAction przy po-
poziom logu. Dostępne jest sześć po- mocy metody _redirect przekierowuje Czy powinniśmy
ziomów, wszystkie są zdefiniowane nas automatycznie na stronę główną. przesiąść się na Zend
w klasie Zend_Log jako stałe, standar- Dzięki temu nie będzie możliwe ponow- Framework?
Pozostałe komponenty Frameworka, któ-
rych nie omówiliśmy w artykule, są rów-
Listing 3. Kod kontrolera MailController
nie proste w użyciu – do części z nich
class MailController extends Zend_Controller_Action { znajdziecie przykłady w dokumentacji lub
w kodzie, w katalogu demos.
public function indexAction() {
Pomimo że kod w Zend Framewor-
$view = Zend::registry('view');
echo $view->render('MailView.php'); ku pisze się bardzo szybko i prosto, zde-
} cydowanie za wcześnie jest na produk-
cyjne wykorzystanie tego narzędzia. Co
public function sendAction() { prawda wiele z jego elementów jest już
$view = Zend::registry('view');
w pełni funkcjonalnych, ale dewelope-
// klasa Zend_InputFilter opakowuje statyczne metody klasy rzy Frameworka mają jeszcze sporo do
// Zend_Filter, wywołana w formie takiej jak poniżej czyści tablicę zrobienia. Najważniejsze braki, i nie je-
// $_POST, wszystkie znajdujące się w niej parametry dostępne są dyne, to niedziałający dobrze kompo-
// poprzez filtrujące metody klasy Zend_InputFilter. Czyszczenie nent Zend_Db. Moduły Zend_Search
// tablicy można wyłączyć ustawiając drugi parametr konstruktora na false
i Zend_Pdf wspierają jedynie kodowanie
$post = new Zend_InputFilter($_POST);
ISO-8859-1, co czyni je bezużyteczny-
$emailTo = $post->getAlpha('emailTo'); mi dla wielu programistów. Brak mecha-
$emailFrom = $post->getAlpha('emailFrom'); nizmu szablonów, czy też integracji ze
Smarty lub PHPTAL jest dodatkowym mi-
// przygotowujemy i wysyłamy mail. Robimy to przy pomocy klasy Zend_Mail.
nusem. Sama dokumentacja ma jeszcze
Zend::loadClass('Zend_Mail');
spore braki. Dlatego na dzień dzisiejszy
$mail = new Zend_Mail('iso-8859-2'); proponuję wam pozostać przy rozwią-
$mail->addTo($emailTo); zaniach, które wykorzystujecie obecnie.
$mail->setFrom($emailFrom); Nie zapominajcie jednak o Zend Frame-
$mail->setBodyText('tekst powiadomienia');
worku – wydaje się, iż jest skazany jest
$mail->setSubject('TestSubject');
$mail->send(); na sukces: w jego rozwój zaangażowani
są znani deweloperzy i największe firmy
// rejestrujemcy w logu fakt wysłania maila. To gdzie zostanie wysłany log związane z PHP. Na pewno wrócimy do
// zależy od tego, jaki appender został zarejestrowany (plik index.php) tego tematu w kolejnych wydaniach ma-
Zend_Log::log('Został wysłany mail');
gazynu, gdyż już niedługo Zend Frame-
$this->_redirect('/'); work może stać się bardzo ważnym, albo
} nawet najważniejszym graczem na are-
nie frameworków dla PHP, a jego prak-
} tyczna znajomość może okazać się po-
trzebna przy szukaniu pracy na stanowi-
Listing 4. Przykładowy plik szablonu
sku programisty PHP. n
<!-- Nagłówek -->
<table width="90%" cellspacing="0" cellpadding="0" border="0" align="center">
<tr>
<td>
<table width="100%" cellspacing="0" cellpadding="2" border="0">
O autorze
<?php foreach( $this->items as $item ) { ?>
<tr> Piotr Szarwas jest pracownikiem
<td> SUPER-MEDIA Interactive i dokto-
<?= $this->escape( $item['fi_title'] ) ?> rantem na wydziale Fizyki Politechniki
</td>
Warszawskiej. Od 2003 roku projektuje
</tr>
<? } ?> aplikacje WWW w oparciu o PHP4/5.
</table> Obecnie zajmuje się tworzeniem fra-
</td> meworka dla PHP opartego na rozwią-
</tr> zaniach Hibernate i Spring.
Kontakt z autorem:
</table><!-- Stopka -->
piotr.szarwas@gmail.com

PHP Solutions Nr 4/2006 www.phpsolmag.org 49

Narzędzia
eZ componets w akcji, czyli
galeria zdjęć krok po kroku
Tobias Schlitt
W SIECI
l http://ez.no/doc/components/
overview
– dokumentacja API kompo-
nentów eZ
l http://ez.no/doc/components/
view/latest/(file)/tutorials.html
– materiały do nauki obsługi
komponentów eZ
l http://ez.no/community/
forum/ez_components
– forum użytkowników kom-
ponentów eZ
http://ez.no/community/
l
articles/image_manipula-
tion_with_ez_components
– artykuł na temat kompo-
nentów eZ
l http://pecl.php.net/package/
filter
– rozszerzenie do filtrowa-
nia PECL
l http://www.phppatterns.com/
docs/start
– wzorce projektowe dla
PHP
50
eZ components stanowią platformę dla PHP
do budowy aplikacji WWW klasy Enterprise.
Stosowanie tych wysokiej jakości komponentów
znacznie przyśpiesza proces tworzenia
oprogramowania zmniejszając jednocześnie
ryzyko niepowodzenia projektu.
A
plikacja webowa, którą będziemy
analizować w ramach niniejsze-
go artykułu, to prosta galeria ob-
razów. Funkcjonalność, którą będziemy
budować to tworzenie albumów oraz
wczytywanie zdjęć do tych albumów. Ga-
leria będzie ponadto skalować wczyty-
wane obrazy i tworzyć ich pomniejszone
wersje w celach prezentacyjnych.
Prezentowana aplikacja ma charak-
ter edukacyjny, jednak przy odrobinie do-
datkowego wysiłku ze strony czytelnika,
może być z powodzeniem zastosowana
w rozwiązaniach klasy produkcyjnej.
Zaczynamy!
Struktura albumów w naszej galerii, oraz
dane na temat zdjęć będą przechowywa-
ne w bazie danych. W prezentowanym
przykładzie użyłem bazy MySQL, jed-
nak czytelnik może równie dobrze sko-
rzystać z innych technologii wspieranych
przez komponenty eZ (http://ez.no/doc/
components/overview/latest). Na Listin-
www.phpsolmag.org
Stopień trudności: lll
gu 1 pokazane jest, w jaki sposób moż-
na stworzyć tabelę do składowania albu-
mów (prezentowana składnia jest specy-
ficzna dla MySQL, jednak nie powinno być
problemu z zaadoptowaniem jej do innych
rozwiązań bazodanowych).
Struktura albumu jest bardzo prosta.
Mamy tutaj pola tytuł (ang. title) i opis
(ang. description) oraz numeryczny iden-
tyfikator. Warto zwrócić w tym miejscu
uwagę na użycie modyfikatora auto_incre-
ment. Jeśli wykorzystywany silnik bazoda-
Co należy wiedzieć...
Czytelnik powinien znać język PHP
(przynajmniej na poziomie podstawo-
wym) oraz ogólne zasady projektowania
orientowanego obiektowo.
Co obiecujemy
Czytając niniejszy artykuł czytelnik na-
uczy się budować aplikację webową (ga-
lerię obrazów) z wykorzystaniem kompo-
nentów eZ.
PHP Solutions Nr 4/2006

nowy nie obsługuje tego mechanizmu, to
w prezentowanym dalej kodzie PHP na-
leżałoby wprowadzić pewne modyfikacje.
Zakładam jednak, że opcja ta jest dostęp-
na i aby nie powodować zamętu, nie będę
opisywał tego szczególnego przypadku.
Generalnie, sugeruję aby w trakcie prak-
tycznego badania rozpatrywanego przy-
kładu – szczególnie przy pierwszym czy-
taniu – pracować z bazą MySQL. Zaosz-
czędzi to czytelnikowi niepotrzebnych kło-
potów.
Na Listingu 2 zaprezentowana jest ko-
lejna tabela, tym razem służąca do prze-
chowywania informacji odnośnie poszcze-
gólnych zdjęć. Tabela ta jest bardzo pro-
sta: oprócz własnego identyfikatora zawie-
ra ona dodatkowo identyfikator powiąza-
nego albumu. Można tu również znaleźć
pola tytuł i opis.
Stwórzmy teraz podstawową strukturę
katalogów dla naszej aplikacji – propozy-
cja znajduje się w Tabeli 1.
Instalacja
Kolejnym krokiem przy realizacji naszego
zadania jest pobranie komponentów eZ.
Najprościej byłoby użyć w tymcelu insta-
latora PEAR (www.pear.php.net). Mając to
narzędzie wystarczy wpisać:
$ pear channel-discover components.ez.no
$ pear install ezc/eZComponents
Listing 1. Tabela do składowania albumów
CREATE TABLE album (
id int(11) unsigned NOT NULL auto_increment,
title varchar(200) NOT NULL default '',
description text NOT NULL,
PRIMARY KEY (id)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;
Listing 2. Tabela do przechowywania informacji na temat zdjęć
CREATE TABLE photo (
id int(11) unsigned NOT NULL auto_increment,
album int(11) NOT NULL default '0',
title varchar(200) NOT NULL default '',
description text NOT NULL,
PRIMARY KEY (id)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;
Listing 3. Pierwszy kod w naszym projekcie
require_once 'ezc/Base/base.php';
function __autoload( $className )
{ return ezcBase::autoload(
$className );
} require_once 'config.php';
PHP Solutions Nr 4/2006
eZ components Narzędzia
Tabela1. Struktura katalogów naszej aplikacji
Directory Description
actions/ Katalog actions/ będzie zawierał źródła kontrolerów dla akcji obsługi-
wanych z poziomu naszej aplikacji (używam tutaj wzorca projektowe-
go MVC).
data/ Katalog data/ będzie zawierał dane obrazów. Warto zauważyć, że ten
katalog musi mieć ustawione prawa zapisu i odczytu z poziomu serwe-
ra webowego. Trzeba pamiętać, że tego rodzaju uproszczenie nie po-
winno występować w aplikacjach o charakterze produkcyjnym.
interfaces/ W katalogu interfaces/ będziemy przechowywać interfejsy kontrolerów
dla poszczególnych akcji.
models/ Katalog models/ będzie zawierał klasy modelu, reprezentujące album i
fotografię.
pos/ Katalog pos/ ma specjalne znaczenie, jako że bedzie zawierał de-
finicje obiektów przeznaczonych do składowania (http://ez.no/doc/
components/view/latest/(file)/classtrees_PersistentObject.html). Obiek-
ty takie stanowią implementację wzorca “aktywny rekord” w katego-
riach komponentów eZ.
templates/ Katalog templates/ będzie zawierał szablony HTML (w kategoriach
MVC będzie to warstwa prezentacyjna naszego projektu).
Jeśli instalacja PEAR jest odpowiednio ez.no/doc/components/view/latest/(file)/
skonfigurowana (warto zwrócić uwagę na classtrees_UserInput.html) jest zależny od
parametr include_path), to sprawa jest filtra PECL. Najprostszym sposobem po-
praktycznie zakończona. brania tego dodatkowego pakietu jest po-
Oczywiście nie każdy użytkow- nownie użycie instalatora PEAR:
nik ma ochotę używać PEAR. Inny spo-
sób instalacji polega na pobraniu archi- $ pecl install filter-beta
wum ze strony domowej projektu (http:
//ez.no/download/ez_components) i roz- Jeśli użytkownik i w tym przypadku nie
pakowaniu go w wybranym katalogu (po- chce korzystać z PEAR, to istnieje moż-
nownie należy zwrócić uwagę, aby pa- liwość pobrania odpowiedniego pakietu
rametr include_path zawierał docelo- źródłowego (http://pecl.php.net/package/
wy katalog). Komponent UserInput (http:// filter) ze strony PECL i ręczna kompilacja
rozszerzenia. Po wykonaniu tych kroków
trzeba jeszcze odpowiednio skonfiguro-
wać plik php.ini.
Kodowanie:
pierwsze kroki
Możemy wreszcie rozpocząć kodowanie.
Na początku tworzymy plik gallery.php,
który powinien znajdować się w głów-
nym katalogu naszego projektu. Plik ten
będzie punktem wejścia do naszej ga-
lerii: do niego będziemy odwoływać się
z przeglądarki. Wewnątrz pliku umie-
ścimy podstawowe elementy nasze-
go kodu: mechanizm automatycznego
wczytywania (ang. autoload) (http://pl.
php.net/autoload), klasę głównego kon-
trolera i odwołania do kolejnych elemen-
tów funkcjonalności.
Warto w tym miejscu spojrzeć na Li-
sting 3. Na samym początku widać od-
wołanie do pliku ezc/Base/base.php.
Jest to jedyny plik powiązany z kom-
ponentami eZ, do którego będziemy
www.phpsolmag.org 51
Narzędzia eZ components

odnosić się w sposób bezpośredni. Znaj-
dują się tam podstawowe, wspólne me-
chanizmy, wykorzystywane przez wszyst-
kie komponenty eZ; między innymi wspo-
mniany wcześniej mechanizm automa-
tycznego wczytywania (aktywowany po-
przez definiowanie funkcji __autoload())
oraz kilka podstawowych wyjątków.
Główny komponent sprawujący kon-
trolę nad naszym projektem nazywa się
ezcGallery (patrz Listing 4). Klasa ta za-
wiera konstruktor i dwie metody: run()
i display(). Pierwsza ze wspomnianych
metod jest odpowiedzialna za przekazy-
wanie żądanej akcji do odpowiedniego
kontrolera roboczego, zaś druga pobiera
szablon związany z daną akcją i przeka-
zuje do niego odpowiednie parametry.
Dodatkowo wspomniana klasa ma
statyczne metody, które udostępniają
wszystkie globalne obiekty w postaci sin-
geltonów. W ten właśnie sposób obsługi-
wane są mechanizmy konfiguracji i logo-
wania, łączenie z bazą danych (getSes-
sion()) i konwersja obrazów. Dzięki sto-
sowaniu tego rodzaju podejścia możli-
we jest bardzo proste odwoływanie się
do tych mechanizmów w każdym punkcie
naszej aplikacji – bez potrzeby tworzenia
wielokrotnych instancji obiektów, na przy-
kład: ezcGallery::getSession(). W tej
części artykułu przeanalizujemy mecha-
nizm obsługi kontrolera. Obiekty typu sin-
gelton zbadamy szczegółowo w dalszej
części tekstu.
Na początek rozpatrzmy definicję tabli-
cy odwzorowującej akcje na odpowiednie
pliki z kodem źródłowym pomocniczych
kontrolerów, które są wczytywane przy
okazji występowania konkretnych żądań.
Ze względów bezpieczeństwa pliki te są
określone w sposób statyczny – umiesz-
czone bezpośrednio w kodzie. Warto za-
pamiętać prostą zasadę: nigdy nie defi-
niujmy elementów logiki aplikacji na bazie
napisu przychodzącego od użytkownika.
Poniżej przedstawiona jest definicja wspo-
mnianej tablicy:

private
Listing 4. Szkielet klasy ezcGallery
$actions = array(
class ezcGallery 'listing' => 'actions/listing.php',
{ public function __construct() 'show' => 'actions/show.php',
{...}
'create' => 'actions/create.php',
public function run()
{...} 'add' => 'actions/add.php',
public static function getConfig() 'archive' => 'actions/archive.php',
{...} ); private $currentAction;
public static function getLog()
{...}
Zmienna $currentAction przechowuje
public function display()
{...} aktualnie wybrany obiekt reprezentujący
public static function getSession() akcję. Spójrzmy na Listing 5, aby zoba-
{...} czyć jak to wygląda.
public static function getConverter() Na początek w konstruktorze, przy-
{...} }
pisujemy do zmiennej $action wartość
Listing 5. Konstruktor klasy ezcGallery listing, która określa akcję domyślną.
W dalszej kolejności sprawdzamy przy
public function __construct() użyciu dedykowanego komponentu Use-
{ $action = 'listing';
rInput, czy pojawiło się żądanie GET. Je-
if ( ezcInputForm::hasGetData() )
{ $definition = array(
śli tak, to definiujemy zbiór reguł dla Use-
'action' => new ezcInputFormDefinitionElement( rInput w celu walidacji żądania. W tym
ezcInputFormDefinitionElement::REQUIRED, 'string' przypadku oczekujemy, że w nagłów-
), ); ku pojawi się pole action, zawierające ja-
$form = new ezcInputForm( INPUT_GET, $definition );
kiś napis. Dalej tworzymy instancję obiek-
$action = ( $form->hasValidData( 'action' ) ) ? $form->action : listing';
} if ( !isset( $this->actions[$action] ) ) {
tu ezcInputForm, którego zadaniem jest
throw new Exception( "Invalid action <".htmlentities($action).">." ); obsłużenie żądania GET. W ostatnim
} kroku (końcowa sekcja bloku if), przypi-
require_once $this->actions[$action]; sujemy pobraną akcję do odpowiedniej
$this->currentAction = new $action;
zmiennej (jeśli dane były poprawne) lub
}
ustawiamy akcję domyślną (jeśli proces
Listing 6. Metoda display w klasie ezcGallery realizuje prosty mechanizm szablo- walidacji przebiegł niepomyślnie).
nowania W dalszej kolejności sprawdzamy, czy
stworzona akcja może być obsłużona.
public function display()
Jeśli tak nie jest, to rzucamy wyjątek (nie
{ $template = $this->currentAction->getTemplateVars();
ob_start();
możemy obsłużyć nieistniejącej akcji). Je-
$res = include 'templates/' . $this->currentAction->getTemplate(); śli akcja jest poprawna, to odwołujemy się
$html = ob_get_contents(); do powiązanego z nią pliku i uruchamiamy
ob_end_clean(); odpowiedni kontroler.
if ( $res === false ) { throw new Exception( 'Template error.' ); }
Proszę zwrócić uwagę, że w pre-
echo $html;
}
zentowanym przykładzie używam wyjąt-
ków, aby powiadomić użytkownika o sy-
tuacji awaryjnej. Praktyka ta nie powin-

52 www.phpsolmag.org PHP Solutions Nr 4/2006


na być stosowana w rozwiązaniach pro-
dukcyjnych ze względu na kwestie bezpie-
czeństwa – wyjątki mogą zostawić istotne
z punktu widzenia ochrony aplikacji infor-
macje! Metoda run jest dla odmiany bar-
dzo prosta. W jej ciele wywołujemy jedynie
metodę run, na stworzonym w konstrukto-
rze obiekcie reprezentującym akcję:
public function run()
{ śli ktoś z Czytelników zainstalował oma-
$this->
currentAction->run();
} tej czynności wymagane jest dodanie do
Ponieważ komponent do obsługi szablo-
nów (eZ Template) nie jest jeszcze gotowy
(przewidujemy jego dołączenie w wersji 1.1
pakietu, który powinien pojawić się latem
bieżącego roku), do obsługi widoku użyje-
my zwyczajnego kodu HTML z osadzonymi
wstawkami w języku PHP. Ten prosty me-
chanizm obsługi szablonów zrealizowany
jest w ramach metody display. Zawartość
tej metody przedstawiona jest na Listingu 6.
Każdy roboczy kontroler obsługują-
cy konkretną akcję implementuje metodę
getTemplateVars() która pozwala głów-
nemu kontrolerowi pobrać odpowiednie
obiekty wymagane do wygenerowania
odpowiedniego kodu HTML. Do obsłuże-
nia wypełnionej zawartości szablonu uży-
jemy wewnętrznego mechanizmu buforo-
wania wyjścia języka PHP, aby uniknąć
brzydkich raportów o błędach wyświetla-
nych jako zawartość stron WWW. Każ-
dy plik szablonowy ma dostęp do tablicy
$template, gdzie może znaleźć wszyst-
kie potrzebne zmienne. Kontroler kon-
kretnej akcji może również zwracać odpo-
wiednie szablony w zależności od stanu,
w którym się znajduje (na przykład w celu
zaprezentowania rezultatu po wypełnieniu
i zaakceptowaniu danych na formularzu).
Wreszcie, jeśli nie wystąpił żaden błąd,
renderowany jest wynikowy kod HTML.
Na samym końcu w pliku gallery.php uru-
chamiamy głównego kontrolera. Kod od-
Listing 7. Końcowa sekcja pliku gal-
lery.php: uruchamiamy głównego
kontrolera
try {
$gallery = new ezcGallery();
$gallery->run();
$gallery->display(); }
catch ( Exception $e )
{ die( $e->getMessage() ); }
PHP Solutions Nr 4/2006
eZ components Narzędzia
powiedzialny za tę czynność przedstawio- waliśmy w ramach przygotowań bazy da-
ny jest na Listingu 7. nych dla naszej galerii. Kod źródłowy kla-
W tym momencie podstawowa struk- sy Album przedstawiony jest na Listingu 8.
tura naszej aplikacji jest gotowa. W klasie tej można zaobserwować
trzy publiczne składowe, które odpo-
Obsługa albumów wiadają polom rekordu w bazie danych.
Teraz omówimy kod używany w celu wy- Jako że obiekty tej klasy są przeznaczo-
świetlenia strony z widokiem ogólnym al- ne do składowania, dlatego do interfejsu
bumu. Funkcjonalność ta biedzie stano- wprowadzamy dwie metody: setState()
wić domyślną akcję w naszej aplikacji. Je- i getState(). Metody te będą wykorzysta-
ne do serializacji i deserializacji modelu
wiany przykład i chciałby go przetestować obiektu do bazy danych i z powrotem.
w gotowej postaci, to przed wykonaniem Obydwie metody przyjmują jako para-
metry tablice asocjacyjne, które są wy-
bazy danych kilku testowych rekordów. korzytywane do przekazywania danych
Kod źródłowy kontrolera odpowiedzialne- w obydwie strony. Do poszczególnych
go za widok ogólny albumu umieszczo- właściwości modelu można odwołać się
ny jest w pliku actions/listing.php. Kod ten na podstawie odpowiednich kluczy.
wymaga dwóch innych plików z naszej te- Zanim przeanalizujemy źródła kontro-
stowej aplikacji. W ramach niniejszego lera akcji “Listing”, musimy zapoznać się
przykładu nie będziemy wykorzystywać z metodą ezcGallery::getSession(). Za-
mechanizmu automatycznego wczytywa- wartość tej metody przedstawiona jest na
nia, więc wspomniane pliki są dołączone Listingu 9.
w sposób manualny: Omawiana metoda nie zwraca w bez-
pośredni sposób połącznia do bazy da-
require_once 'interfaces/action.php'; nych. W zamian otrzymujemy tzw. sesję
require_once 'models/album.php'; obsługi składowania (ang. persistent ses-
sion). Między tymi dwoma klasami obiek-
Model reprezentujący album (models/ tów istnieje istotna różnica. Połączenie do
album.php) jest dziecinnie prosty i odpo- bazy danych (czyli obiekt klasy definiu-
wiada strukturze rekordu, który opraco- jącej komponent eZ Database) pozwala
Listing 8. Struktura danych reprezentująca album
class Album
{ public $id = null;
public $title = '';
public $description = 'No description available.';
public function getState()
{ return array(
'id' => $this->id,
'title' => $this->title,
'description' => $this->description,
); }
public function setState( array $properties )
{ foreach ( $properties as $key => $val )
{ $this->$key = $val; } } }
Listing 9. Definicja statycznej metody getSession() w klasie ezcGallery
public static function getSession()
{ if ( self::$persistentSession === null )
{ $db = ezcDbFactory::create(
self::getConfig()->getSetting( 'config', 'database', 'dsn' )
); ezcDbInstance::set( $db );
self::$persistentSession = new ezcPersistentSession(
ezcDbInstance::get(),
new ezcPersistentCodeManager(
self::getConfig()->getSetting( 'config', 'php', 'base' )
. DIRECTORY_SEPARATOR
. 'pos' ) );
} return self::$persistentSession; }
www.phpsolmag.org 53
Narzędzia eZ components

wykonywać na bazie danych bezpośred-
nie operacje przy pomocy języka SQL.
Sesja obsługi składowania oferuje mecha-
nizm o wiele bardziej potężny, jako że po-
zwala działać na znacznie wyższym po-
ziomie abstrakcji. Możemy przy jej pomo-
cy zapisywać, odczytywać, modyfikować
i kasować obiekty modelu, bez stosowa-
nia języka zapytań w sposób bezpośredni.
Wynikowy kod SQL jest generowany auto-
matycznie przez obiekt sesji.
Wewnątrz metody getSession()wyko-
rzystywana jest prywatna statyczna skła-
dowa $persistentSession. W ramach tej
zmiennej zachowana jest pojedyncza in-
stancja sesji oferującej abstrakcyjny in-
terfejs dostępu do bazy.
Instancja jest tworzona przy pierw-
szym odwołaniu; przy każdym kolejnym
wywołaniu metody getSession() wyko-
rzystywana jest instancja istniejąca. Do
stworzenia sesji potrzebny jest obiekt re-
prezentujący połącznie z bazą danych.
Obiekt ten jest tworzony przy pomocy
dedykowanej fabryki ezcDbFactory. Da-
ne niezbędne do sfinalizowania tego pro-
cesu są pobierane z zewnętrznego pli-
ku ini. Do pliku tego można odwołać się
przy pomocy mechanizmu obsługi konfi-
guracji. Prześledźmy szczegółowo cały
mechanizm tworzenia sesji. Na początku
wywoływana jest metoda ezcDbInstance:
:set() w celu zainicjalizowania kompo-
nentu eZ Database. Przy pomocy no-
wo uzyskanego obiektu reprezentujące-
go połączenie z bazą danych, tworzymy
sesję obsługi składowania. Drugi para-
metr przekazywany do konstruktora kla-
sy ezcPersistentSession to tzw. me-
nadżer kodu. Obiekt ten obsługuje pliki
zawierające konfigurację mechanizmu
składowania (pliki te umieszczone są
w katalogu pos/). Bazowa część ścieżki
dostępu do plików jest pobierana z kon-
figuracji. Komponenty do obsługi konfi-
guracji obsługują czytanie i zapisywanie
ustawień i opcji. W przypadku naszego
projektu wykorzystujemy plik ini, gdzie
zapisane są wszystkie ustawienia wyma-
gane przez galerię. Przykładowy plik ini
wygląda następująco:
[database]
dsn=mysql://root:
iglowinthedark@localhost/test
[php]
base=./

Listing 10. Definicja statycznej metody getConfig() w klasie ezcGallery DSN to napis określający sposób połą-
czenia z bazą danych. Pierwsza część
public static function getConfig() napisu określa rodzaj używanego sil-
{ nika bazodanowego. Dalej, zgodnie
if ( self::$config === null )
z konwencją URI, umieszczona jest na-
{ self::$config = ezcConfigurationManager::getInstance();
self::$config->init( 'ezcConfigurationIniReader', dirname( __FILE__ ) ); zwa użytkownika i hasło. Informacje
} te są potrzebne, aby połączyć się
return self::$config; } z maszyną na, której uruchomiona
jest baza danych (w większości przy-
Listing 11. Definicja obiektu składowania dla albumu
padków jest to localhost). Po ostatnim
$def = new ezcPersistentObjectDefinition(); ukośniku (“/”) podana jest nazwa doce-
$def->table = "album"; lowego repozytorium. Druga stała okre-
$def->class = "Album"; śla miejsce w którym znajdują się pli-
$def->idProperty = new ezcPersistentObjectIdProperty();
ki nagłówkowe. Zmienna base określa
$def->idProperty->columnName = 'id';
$def->idProperty->propertyName = 'id';
ścieżkę, w której składowane są klasy
$def->idProperty->generator = new ezcPersistentGeneratorDefinition( PHP. Na Listingu 10 przedstawiona jest
'ezcPersistentSequenceGenerator' ); metoda getConfig().
$def->properties['title'] = new ezcPersistentObjectProperty(); W tym przypadku ponownie wyko-
$def->properties['title']->columnName = 'title';
rzystany jest wzorzec singleton (ten
$def->properties['title']->propertyName = 'title';
$def->properties['title']->propertyType = 'string';
sam wzorzec jest również zastosowany
$def->properties['description'] = new ezcPersistentObjectProperty(); w komponencie Config. Metoda init()
$def->properties['description']->columnName = 'description'; przyjmuje nazwę klasy służącej do czy-
$def->properties['description']->propertyName = 'description'; tania konkretnego rodzaju konfigura-
$def->properties['description']->propertyType = 'string';
cji (w naszym przypadku, pliki typu ini)
return $def;
oraz katalog w którym dane konfigura-
Listing 12. Wyszukiwanie albumów cyjne są składowane. Sposób interpre-
tacji drugiego parametru jest zależny
class Listing implements Action od klasy odpowiedzialnej za odczyty-
{ private $albums;
wanie konfiguracji. Przykładowo, gdyby
public function __construct()
{} konfiguracja była składowana w bazie
public function run() danych, drugi parametr mógłby być
{ $this->albums = ezcGallery::getSession()->find( obiektem reprezentującym połączenie.
ezcGallery::getSession()->createFindQuery( 'Album' ),'Album'); Wracając na moment do Listingu 9
}
(definicja metody getSession()), Czy-
public function getTemplate()
{ return 'listing.php'; } telnik może sobie przypomnieć, w jaki
public function getTemplateVars() sposób odczytywane są ustawienia kon-
{ return array( 'albums' => $this->albums ); figuracyjne. Wygląda to w ten sposób,
} } że wywołujemy metodę getSetting()
na stworzonym obiekcie, przy czym

54 www.phpsolmag.org PHP Solutions Nr 4/2006


jako parametry podajemy: nazwę pliku
zawierającego konfigurację (bez roz-
szerzenia), nazwę sekcji w pliku ini oraz
nazwę klucza, dla którego chcemy po-
brać wartość.
Jak wspominałem wcześniej, w ce-
lu zapisania naszego modelu w bazie
danych potrzebujemy definicji klasy
ezcPersistentCodeManager. Stwórzmy
teraz w katalogu pos/ plik album.php
i umieśćmy w nim kod przedstawiony
na Listingu 11.
Każda definicja obiektu przezna-
czonego do składowania jest instancją
klasy ezcPersistentObjectDefinition.
Klasa ta posiada trzy atrybuty służące
do określenia tabeli w bazie danych
i powiązanej z nią klasy modelu oraz
mechanizmu generowania identyfika-
torów. Pierwsze dwa atrybuty są zwy-
czajnymi napisami, a ostatni jest struk-
turą (komponenty eZ emulują struktury
przy pomocy zwyczajnych klas) o na-
zwie ezcPersistentObjectIdProperty.
Elementy tej struktury to nazwa kolum-
ny i nazwa składowej oraz genera-
tor odpowiedzialny za przydzielanie
identyfikatorów dla nowo tworzonych
obiektów. W naszym przykładzie ja-
ko generatora używamy instancji klasy
ezcPersistentSequenceGenerator, któ-
ra bazuje na mechanizmie auto_incre-
ment oferowanym przez silnik MySQL.
W dalszej części pliku zdefiniowane są
pozostałe powiązania pomiędzy atrybu-
tami klas modelu oraz kolumnami tabeli
w bazie danych (ten fragment kodu ma
wysoce samoopisowy charakter, więc
nie będę go już dodatkowo wyjaśniał).
Wreszcie, w ostatniej linii, zwracamy
skonfigurowany obiekt definicji.
W tym momencie spełnione są
wszystkie potrzebne warunki do rozpo-
częcia pracy z obiektami przeznaczo-
nymi do składowania. W dalszej części
artykułu zapoznamy się ze sposobami
używania tych obiektów.
Spójrzmy teraz na Listing 12, gdzie
zdefiniowany jest kontroler odpowiedzial-
ny za wyszukiwanie albumów. Na po-
czątku zdefiniowany jest pusty (i w rze-
czywistości nieużywany) konstruktor.
Sytuacja ta jest powodowana wymogiem
narzuconym przez interfejs akcji. W me-
todzie run pobieramy wszystkie albumy
z bazy danych i składujemy je w prywat-
nej składowej o nazwie $albums.
Aby pobrać składowany obiekt,
wywołujemy metodę find() na obiekcie
PHP Solutions Nr 4/2006
eZ components Narzędzia
Listing 13. Prosty szablon
<?php include 'templates/head.php'; ?>
<table width="600">
<tr>
<td>[
<a href="gallery.php?action=create">Create album</a>]
</td>
</tr>
</table>
<ul>
<?php foreach ( $template['albums'] as $album ) { ?>
<li><a href="gallery.php?action=show&album=<?php echo $album->id; ?>">
<?php echo $album->title; ?></a>
</li>
<?php } ?>
</ul>
<?php include 'templates/foot.php'; ?>
Listing 14. Podstawowa struktura metody run() w klasie odpowiedzialnej za ope-
rację tworzenia nowego albumu
if ( ezcInputForm::hasPostData() )
{ // ...}
else {
$this->template = 'create_form.php'; }
Listing 15. Sprawdzanie danych żądania POST w metodzie run() obsługującej
operację tworzenia nowego albumu
$definition = array(
'title' => new ezcInputFormDefinitionElement(
ezcInputFormDefinitionElement::REQUIRED, 'string' ),
'description' => new ezcInputFormDefinitionElement(
ezcInputFormDefinitionElement::REQUIRED, 'string' ),
); $form = new ezcInputForm( INPUT_POST, $definition );
if ( !$form->hasValidData( 'title' ) ) {
throw new Exception( 'Title missing.' ); }
if ( !$form->hasValidData( 'description' ) ) {
throw new Exception( 'Desription missing.' ); }
Listing 16. Wstawianie nowego obiektu w metodzie run() obsługującej operację
tworzenia nowego albumu
// ten fragment kodu wykonuje finalne wstawianie obiektu
$this->album = new Album();
$this->album->title = $form->title;
$this->album->description = $form->description;
ezcGallery::getSession()->save( $this->album );
ezcGallery::getLog()->log(
"New album created with ID <{$this->album->id}>.", ezcLog::INFO,
array( 'category' => 'Create' ) );
$this->template = 'create_submit.php';
Listing 17. Tworzenie instancji obiektu reprezentującego log (ezcGallery::ge-
tLog())
public static function getLog()
{ if ( self::$log === null )
{ self::$log = ezcLog::getInstance();
$mapper = self::$log->getMapper();
$writer = new ezcLogUnixFileWriter( 'data/', 'gallery.log' );
$filter = new ezcLogFilter();
$rule = new ezcLogFilterRule( $filter, $writer, true );
$mapper->appendRule( $rule );
self::$log->source = 'Gallery';
} return self::$log; }
www.phpsolmag.org 55
Narzędzia eZ components

sesji. Metoda ta zwraca tablicę obiek- szablonu, jako że w przypadku pozosta- rzenia nowego albumu. Prześledź-
tów znalezionych na podstawie zapyta- łych akcji nie pojawia się w tym kontek- my implementację kontrolera odpowie-
nia. Przy wywołaniu metody specyfikuje- ście nic nowego. dzialnego za tę operację. Konstruktor
my też typ klasy modelu, której obiektów Pliki head.php i foot.php nie zawie- klasy jest ponownie pusty, najciekaw-
szukamy w bazie danych (drugi parametr rają żadnej interesującej zawartości, są szy fragment kodu znajduje się w cie-
przy wywołaniu find()). tam jedynie podstawowe tagi HTML. le metody run(). Ponieważ definicja
Zapytanie, którego używamy (find) Pliki te zostały wydzielone ze względu wspomnianej metody jest w tym przy-
jest fizycznie obsługiwane z poziomu na to, że są dołączane na każdej stro- padku dość rozległa, dlatego zdecy-
sesji składowania. W tym konkretnym nie naszej webaplikacji. Korzystając dowałem się zaprezentować ją w kliku
przypadku używamy bardzo uproszczo- z pętli foreach przeglądamy tablicę za- mniejszych krokach.
nej formy tego zapytania; automatycz- wierającą albumy (tę, którą jest zwra- Jak widać, główny szkielet meto-
nie wygenerowany kod SQL ma postać cana metodzie getTemplateVars()) dy stanowi instrukcja warunkowa if,
SELECT * FROM Album, jako że pobieramy i odwołujemy się poprzez publicz- w której sprawdzamy czy pojawiło się żą-
wszystkie dostępne albumy. Bardziej za- ne składowe do zawartości umiesz- danie POST (patrz Listing 14). Jeśli tak
awansowany przykład wykorzystania te- czonych w niej obiektów, aby wstrzyk- się nie stało, to powinniśmy wyświetlić
go mechanizmu będzie pokazany w dal- nąć do kodu HTML odpowiednie dane. formularz, poprzez który użytkownik bę-
szej części artykułu. Sądzę, że przedstawiony kod jest na dzie mógł wysłać wspomniane żądanie.
Metoda getTemplate() zwraca tyle prosty, iż nie wymaga dodatkowych Aby uzyskać taki a nie inny efekt, usta-
umieszczoną na stałe nazwę szablo- wyjaśnień. wiamy w odpowiedni sposób składową
nu, zaś getTemplateVars() udostępnia $template.
pobrane wcześniej albumy. Ostatnią Tworzenie nowego Fragment kodu przedstawiony na
czynnością, którą musimy wykonać jest albumu Listingu 15 pobiera dane żądania POST
implementacja szablonu. Pozwolę so- W poniższej sekcji opiszemy, w jaki i wykonuje na nich podstawowy test
bie zaprezentować tylko jeden przykład sposób realizowane jest żądanie two- sprawdzający. Podobny kod widzieliśmy
już wcześniej, w kontekście wykorzysta-
Listing 18. Konstruktor klasy reprezentującej akcję wczytywania obrazu nia komponentu UserInput. Jedyna róż-
nica między tymi dwoma fragmentami
public function __construct() polega na tym, że typy żądań są różne
{
(w poprzednim przykładzie obsługiwali-
if ( ezcInputForm::hasGetData() )
{ śmy żądanie typu GET). Kod przedsta-
$definition = array( wiony na Listingu 16 wykonuje finalną
'album' => new ezcInputFormDefinitionElement( operację wstawiania nowego obiektu do
ezcInputFormDefinitionElement::REQUIRED, 'int' bazy danych.
), );
Na początku tworzymy nowy obiekt
$form = new ezcInputForm( INPUT_GET, $definition );
if ( !$form->hasValidData( 'album' ) ) klasy modelu i zapamiętujemy go
{ throw new Exception( 'Album ID missing.' ); w kolejnej prywatnej składowej, zwa-
} $this->album = ezcGallery::getSession()->load( 'Album', $form->album ); nej album. Składowa ta przyda się nam
} później, przy generowaniu danych na
else
podstawie szablonu. W dalszej kolejno-
{ throw new Exception( 'Album ID missing.' ); }}
ści, na podstawie danych odebranych
Listing 19. Manipulating the uploaded images z formularza ustawiamy składowe
reprezentujące tytuł i opis albumu,
$this->photo = new Photo(); i tworzymy sesję składowania w celu
$this->photo->title = $form->title;
wstawienia obiektu do bazy. Dla uprosz-
$this->photo->description = $form->description;
$this->photo->create( $_FILES['photo']['tmp_name'], $this->album->id ); czenia projektu, nasza galeria nie będzie
ezcGallery::getLog()->log( oferować możliwości edycji. Funkcjonal-
"Added new photo with ID <{$this->photo->id}>.", ność taka jest stosunkowo łatwa w im-
ezcLog::INFO, plementacji; moglibyśmy ją uzyskać
array( 'category' => 'Upload' )
przy pomocy metod update(), delete()
); $this->template = 'add_submit.php';
i load() klasy ezcPersistentSession. In-
Listing 20. Tworzenie konwertera obrazów ne przydatne w tym kontekście metody
to loadIfExists() oraz saveOrUpdate().
self::$imageConverter = new ezcImageConverter(
Na końcu zapisujemy informa-
new ezcImageConverterSettings(
array(
cję o stworzeniu nowego albumu do lo-
new ezcImageHandlerSettings( 'imagemagick', 'ezcImageImagemagickHandler' gu. Sposób budowania mechanizmu
), logowania będzie opisany szczegółowo
new ezcImageHandlerSettings( 'gd', 'ezcImageGdHandler' ), w dalszej części artykułu; w tym miej-
) ));
scu pokażę tylko jak pobrać obiekt od-
powiedzialny za tę funkcjonalność i jak

56 www.phpsolmag.org PHP Solutions Nr 4/2006

 eZ components Narzędzia

z niego korzystać. Metoda log() pobiera bowy ma tutaj ustawione prawa zapisu. pojedynczego pliku, dlatego wybieramy
jako pierwszy parametr wiadomość prze- W rzeczywistych zastosowaniach prak- filtr wyłapujący wszystkie wpisy. Ostatni
znaczoną do odnotowania. Drugi para- tyka taka jest zdecydowanie niezale- parametr przekazywany do konstrukto-
metr określa charakter wpisu (w prezen- cana, głownie ze względu na wymogi ra to flaga określająca, czy w przypadku
towanym przykładzie to jest charakter bezpieczeństwa: w logach mogą znajdo- dopasowania właściwej reguły, silnik ma
informacyjny). Jako ostatni parametr wać się cenne informacje. kontynuować poszukiwania. Flaga ta jest
przekazujemy dodatkowe opcje konfi- Kolejną cześć reguły stanowi kom- przydatna, jeśli planujemy logować do
gurujące wpis. W naszym przykładzie ponent LogFilter. Komponent ten odpo- wielu źródeł jednocześnie.
określamy dodatkową kategorię. Wyge- wiada za filtrowanie wpisów w pewien Na końcu dołączamy stworzoną
nerowany wpis wygląda następująco: określony sposób. Wiadomości mogą regułę do obiektu mapper i ustawiamy
być filtrowane według charakteru, źró- domyślne źródło dla obiektu logowania.
Apr 12 19:20:19 dła oraz kategorii wpisu. Ponieważ w na- Teraz Czytelnik może się łatwo domy-
[Info] [Gallery] [Create] szym przypadku będziemy logować do śleć dlaczego w przykładowym wpisie
New album created with ID <5>.
Listing 21. Dodawanie transformacji do konwertera obrazów
Jak widać, silnik logowania dodał auto-
self::$imageConverter->createTransformation(
matycznie znacznik czasowy, a także
'photo',
wypisał charakter i kategorię wiadomo-
ści. To, w jaki sposób we wpisie znala- array(
zła się fraza “[Gallery]”, niechaj chwilowo new ezcImageFilter(
pozostanie tajemnicą (obiecuję, że nie 'scale',
array(
na długo). Na samym końcu wpisu jest
'width' => 640, 'height' => 480,
umieszczona nasza wiadomość. 'direction' => ezcImageGeometryFilters::SCALE_DOWN,
Metody getTemplate() i getTemplate- ) ), ),
Vars() nie różnią się zbytnio od swoich array('image/jpeg',));
odpowiedników w klasie do obsługi ak-
cji “Listing”, więc pominiemy w tym miej- Listing 22. Transformacja odpowiedzialna za tworzenie miniaturek wczytywa-
nych obrazów
scu ich opis. Można jedynie nadmienić,
że szablon create_submit.php odpowia- self::$imageConverter->createTransformation(
da za wyświetlenie danych albumu, zaś 'thumb',
create_form.php zawiera definicję formu-
array(
larza służącego do pobierania danych od
new ezcImageFilter(
użytkownika. 'scale',
Spójrzmy teraz, w jaki sposób budo- array(
wany jest obiekt odpowiedzialny za logo- 'width' => 150, 'height' => 113,
wanie (Listing 17). 'direction' => ezcImageGeometryFilters::SCALE_DOWN,
)
Znowu mamy w tym miejscu do czy-
),
nienia z popularnym wzorcem projekto- new ezcImageFilter(
wym typu singelton. Jeśli żądana instan- 'border',
cja logu nie istnieje, to jest ona tworzo- array( width' => 5,
na. Na początku potrzebujemy instancji 'color' => array(255, 255, 255,), )
),
obiektu odpowiedzialnego za logowanie
new ezcImageFilter(
(warto zauważyć, że jest to singelton 'colorspace',
udostępniany przez komponent Log). array(
W dalszej kolejności pobieramy z uzy- 'space' => ezcImageColorspaceFilters::COLORSPACE_SEPIA,
skanej instancji tzw. mapper. Obiekt ten )
),
jest odpowiedzialny za przypisywanie
new ezcImageFilter(
różnych rodzajów logowanych wiado- 'border',
mości do różnych wynikowych plików. array(
Aby dodać do naszego obiektu lo- 'width' => 1,
gującego nową regułę, musimy określić 'color' => array(0, 0, 0,),
)
mechanizm zapisu. W naszym przypad-
),
ku wybraliśmy obiekt piszący do pliku ),
(w konwencji systemu Unix). Konstruk- array(
tor klasy tego obiektu pobiera na wej- 'image/jpeg',
ściu nazwę katalogu, w którym log ma )
);
być składowany oraz nazwę docelowego
pliku. W naszym przykładzie wykorzystu-
jemy katalog data/, jako że serwer we-

PHP Solutions Nr 4/2006 www.phpsolmag.org 57

Narzędzia eZ components

pojawiła się fraza “[Gallery]”. W więk-

szych aplikacjach można ustawiać wiele Listing 23. Definicja metody ezcGallery::getConverter()
źródeł, jednak w naszym przypadku uży-
public static function getConverter()
jemy jednej domyślnej wartości. {
if ( !isset( self::$imageConverter ) )
Wczytywanie obrazów {
Jak dotąd mamy możliwość tworzenia self::$imageConverter = new ezcImageConverter(
new ezcImageConverterSettings(
nowych albumów, jednak to co napraw-
array(
dę nas interesuje, to funkcjonalność new ezcImageHandlerSettings( 'imagemagick', 'ezcImageImagemag
wczytywania obrazów. Operacja ta jest ickHandler' ),
zaimplementowana w ramach obsłu- new ezcImageHandlerSettings( 'gd', 'ezcImageGdHandler' ),
gi akcji „Add”, w pliku actions/add.php. )
)
Definicja klasy modelu obrazu jest prak-
);
tycznie taka sama jak w przypadku al-
bumu. Jedyną różnicę stanowi metoda self::$imageConverter->createTransformation(
create(), którą niedługo szczegółowo 'photo',
opiszemy. array(
new ezcImageFilter(
Rozważana akcja wymaga określe-
'scale',
nia konkretnego albumu, do którego bę- array(
dziemy wczytywać obraz. W zawiązku 'width' => 640, 'height' => 480,
z tym, w konstruktorze klasy umieścimy 'direction' => ezcImageGeometryFilters::SCALE_DOWN,
kod odpowiedzialny za wczytywanie al- )
),
bumu (Listing 18).
),
Ponownie wykorzystujemy kom- array(
ponent eZ UserInput w celu pobrania 'image/jpeg',
identyfikatora albumu wybranego przez )
użytkownika, jednak w odróżnieniu od );

pozostałych przykładów, tym razem

self::$imageConverter->createTransformation(
oczekujemy wartości liczbowej, a nie 'thumb',
napisu. Jeśli udało się pobrać identyfi- array(
kator, próbujemy pobrać z bazy danych new ezcImageFilter(
obiekt reprezentujący album. Warto za- 'scale',
array(
uważyć, że w tym miejscu komponent
'width' => 150, 'height' => 113,
ezcPersistentSession może rzucić wy- 'direction' => ezcImageGeometryFilters::SCALE_DOWN,
jątek ezcPersistentException, jeśli oka- )
że się, iż docelowy album nie istnieje. ),
W dalszej kolejności będziemy ob- new ezcImageFilter(
'border',
sługiwać wczytywany obraz. Mecha-
array(
nizm obsługi znajduje się w metodzie 'width' => 5, 'color' => array(255, 255, 255,),
run, w klasie reprezentującej rozważaną )
akcję. Kod podobny do źródła przedsta- ),
wionego na Listingu 19 opisywałem już new ezcImageFilter('colorspace',
array(
wcześniej, więc w tym miejscu podaru-
'space' => ezcImageColorspaceFilters::COLORSPACE_SEPIA,
jemy sobie jego dokładną analizę. )
Obsługa wczytywania plików nie ),
jest (jeszcze) obsługiwana z poziomu new ezcImageFilter(
komponentu UserInput. Z tej przyczyny 'border',
array(
musimy odczytać surowe dane z tabli-
'width' => 1, 'color' => array(0, 0, 0,),
cy FILES. Najpierw tworzymy instancję )
obiektu reprezentującego obraz i prze- ),
kazujemy do niego dane podstawowe ),
(tytuł i opis). Pozostałe wymagane ope- array(
'image/jpeg',
racje będą wykonane w ramach metody
)
create() , włącznie z zapisaniem obra- );
zu do bazy danych. }
Zanim zanurkujemy w kod źró- return self::$imageConverter;
dłowy metody create(), zróbmy ma- }

łą retrospekcję i powróćmy do defini-

cji głównego kontrolera, gdzie znaj-

58 www.phpsolmag.org PHP Solutions Nr 4/2006


duje się między innymi operacja
getConverter() . Jako że metoda ta
jest dość obszerna, przeanalizujemy
ją w kliku krokach:
public static
function getConverter()
{ W przedstawionej metodzie pobie-
if ( !isset(
self::$imageConverter ) )
{ mu. Następnie przypisujemy identyfika-
// ...
} niczych ścieżek. Potrzebne nam bę-
return
self::$imageConverter;
} i tak przechowywany w tymczasowej
Implementacja wzorca singelton ma
identyczną postać jak w przypadku
metody getSession().
Fragment kodu przedstawiony na
Listingu 20 jest odpowiedzialny za two-
rzenie nowego konwertera obrazów.
W trakcie tworzenia konwertera wyko-
rzystujemy specjalne obiekty do obsłu-
gi zewnętrznych mechanizmów filtro-
wania obrazów, takich jak dedykowane
dla PHP rozszerzenie biblioteki GD lub
program ImageMagick. W naszym przy-
kładzie korzystamy z tego drugiego
rozwiązania. Jeśli z jakichś powodów
wymagany program nie może być zain-
stalowany, to wystarczy usunąć obiekt do
jego obsługi i skorzystać z biblioteki GD.
Ponieważ wiemy z góry, jaki filtr bę-
dzie nam potrzebny, zdefiniujmy od razu
odpowiednią transformację (Listing 21).
Konwerter obrazów może być skon-
figurowany do obsługi tak zwanych
transformacji. Każda transformacja
jest identyfikowana przez nazwę i za-
wiera jeden lub więcej filtrów, oraz typ
MIME określający format wyjścia.
Nasza transformacja będzie zaapliko-
wana dla wszystkich wczytanych ob-
razów. W jej efekcie wszystkie obrazy
o rozmiarach większych niż 640x480
będą przeskalowane w dół. Dodatkowo
wszystkie obrazy będą konwertowane
do formatu JPEG. Kolejna transforma-
cja będzie odpowiedzialna za tworze-
nie miniaturek obrazów (Listing 22).
Przy generowaniu miniaturek, po-
nownie skalujemy obrazy w dół, tym ra-
zem do rozdzielczości 150x113 pikse-
li. Następnie dodajemy białą obwódkę
i konwertujemy zawartość do przestrze-
ni kolorów Sepia. Ta ostatnia transfor-
macja sprawi, że nasze obrazy będą
PHP Solutions Nr 4/2006
wyglądać jak stare, podniszczone zdję-
cia. Na samym końcu dodajemy jesz-
cze jedną, czarną obwódkę o szeroko-
ści jednego piksela – jako wykończenie
(patrz: Listing 23). Spójrzmy teraz, w ja-
ki sposób nasz konwerter obrazów wy-
korzystany jest w praktyce (Listing 24).
ramy ścieżkę wczytanego obrazu oraz
identyfikator powiązanego z nim albu-
tor albumu i definiujemy tablicę pomoc-
dą dwie: jedna dla wczytanego obrazu
i druga dla miniaturki. Wczytany plik jest
lokacji, więc możemy wykorzystać ist-
niejącą ścieżkę i wygenerujemy nową
tylko dla miniaturki. Wewnątrz bloku try
wykonujemy dwufazową transformację
obrazów.
Na Listingu 25 pokazany jest kod
źródłowy odpowiedzialny za zapisywanie
wczytanego obrazu w bazie danych. Po
pomyślnym wykonaniu tej operacji otrzy-
mujemy identyfikator. Dla uproszczenia
przykładowego kodu wczytywane obra-
zy są przechowywane pod nazwami od-
powiadającymi identyfikatorom w bazie
(z rozszerzeniem _thumb dla miniatu-
rek). Ponieważ wszystkie wynikowe ob-
razy otrzymywane po transformacji będą
zapisane w jednolitym formacie, dlatego
możemy bezpiecznie zaszyć rozszerze-
nie plików w kodzie źródłowym.
Listing 24. Wykorzystanie konwertera obrazów
public function create[ $imagePath, $album )
{
$this->album = $album;
$tmpData['photoPath'] = $imagePath;
$tmpData['thumbPath'] = tempnam( '', 'thumb' );
try
{
ezcGallery::getConverter()->transform(
'photo',
$tmpData['photoPath'],
$tmpData['photoPath'] );
ezcGallery::getConverter()->transform(
'thumb',
$tmpData['photoPath'],
$tmpData['thumbPath'] );
}
catch ( ezcImageTransformationException $e )
{
throw new Exception(
'Image conversion error: <' . $e->getMessage() . '>'
);
} }
www.phpsolmag.org
eZ components Narzędzia
Przeglądamy obrazy
Mamy już zdefiniowane albumy wypeł-
nione wczytanymi zdjęciami. Przyjem-
nie byłoby mieć jeszcze możliwość ich
przejrzenia. Akcja powiązana z tym ele-
mentem funkcjonalności jest zdefiniowa-
na w pliku show.php wewnątrz katalogu
actions/. W konstruktorze klasy pobiera-
my identyfikator albumu, który chcemy
przeglądać i wyciągamy go z bazy da-
nych (Listing 26).
Ponieważ zaprezentowany fragment
kodu jest dla nas już bardzo znajomy,
dlatego przejdziemy od razu do definicji
metody run() (Listing 27).
W ramach wspomnianej metody
realizujemy operację pobierania wszyst-
kich zdjęć dla konkretnego albumu.
W tym niewielkim fragmencie kodu po-
kazana jest kolejna ciekawa możliwość,
oferowana przez komponent Database.
Jak na razie widzieliśmy, w jaki sposób
można wykonać proste zapytanie przy
użyciu find. W tym miejscu możemy za-
obserwować, jak można zmodyfikować
to zapytanie przy pomocy dodatkowe-
go wyrażenia where. W tym celu two-
rzymy obiekt reprezentujący zapytanie
i wywołujemy na nim metodę where, spe-
cyfikując nazwę kolumny oraz poszuki-
waną wartość. Teraz możemy przeka-
zać zapytanie do metody find wywołanej
w ramach sesji obsługi składowania.
Pozostała część definicji klasy do ob-
sługi akcji wygląda jak na poprzednich
59
Narzędzia eZ components

przykładach. Szablony HTML są zdefi-
niowane w taki sposób, że prezentują
listę miniaturek z odnośnikami do peł-
nych wersji obrazów.
Obsługa skompresowa-
tego typu zadnia zajmuje się kontroler
obsługujący akcję „Archive”. Konstruk-
tor klasy wykonuje dokładnie takie same
operacje jak w przypadku obsługi akcji
„Add”. Metoda run też wygląda w tym
przypadku niemalże identycznie. Różni-
cję obiektu reprezentującego obraz, ma-
my tu wywołanie dwóch metod:
$tmpPath = $this->extractArchive(
$_FILES['archive']
['tmp_name'] );

nego archiwum ca polega na tym, że przy wczytywaniu $this->addPhotos(

Wczytywanie pojedynczych plików do archiwum mamy możliwość zdefiniowa- $tmpPath, $form->title,
naszej galerii działa już całkiem nieźle. nia szablonu tytułu i opisu dla zawartych $form->description );
Jednak wczytywanie dużej liczby obra- wewnątrz obrazów. Szablon ten może
zów jest bardzo niewygodne. Dobrze zawierać znaczniki „%s”, które będą za- Metoda extractArchive() rozpakowu-
byłoby posiadać możliwość wczytania mienione na oryginalną nazwę obrazu je wczytane archiwum do roboczego ka-
całego archiwum obrazów do galerii, (z usuniętym rozszerzeniem). Spójrzmy talogu i zwraca jego ścieżkę. Metoda
gdzie byłyby one rozpakowane i doda- teraz na interesujący nas fragment me- addPhotos() dodaje poszczególne obrazy
wane do określonego albumu. Obsługą tody run. Zamiast tworzyć jedną instan- do galerii. Na Listingu 28 przedstawione
są pierwsze kroki przygotowujące do eks-
Listing 25. Zapisanie wczytanego obrazu w bazie danych trakcji plików z archiwum.
Na początku przeprowadzamy test
ezcGallery::getSession()->save( $this ); poprawności – sprawdzamy, czy prze-
if ( rename( $tmpData['photoPath'], 'data/' . $this->id . '.jpg' ) === false ) kazana ścieżka rzeczywiście odnosi
{
się do pliku. Dalej musimy posłużyć się
throw new Exception( 'Unable to store photo.' );
} małą sztuczką programistyczną w ce-
if ( rename( $tmpData['thumbPath'], 'data/' . $this->id . '_thumb' . '.jpg' ) === false ) lu stworzenia roboczego katalogu. Po-
{ nieważ język PHP nie posiada funkcji
throw new Exception( 'Unable to store thumbnail.' ); odpowiedzialnej za przeprowadzenie te-
}
go typu operacji w sposób bezpośred-
Listing 26. Pobieranie identyfikatora albumu i wyciągnie go z bazy danych ni, dlatego musimy skorzystać z funkcji
tempnam(), po czym skasować powstały
public function __construct() pomocniczy plik i na jego miejscu stwo-
{
rzyć katalog.
if ( ezcInputForm::hasGetData() )
{
Teraz możemy rozpakować archiwum
$definition = array( (Listing 29). Wywołanie EzcArchive::
'album' => new ezcInputFormDefinitionElement( open() zwraca instancję obiektu odpo-
ezcInputFormDefinitionElement::REQUIRED, 'int' wiedzialnego za obsługę wczytanego
),
archiwum (lub rzuca wyjątek jeśli typ ar-
);
$form = new ezcInputForm( INPUT_GET, $definition );
chiwum nie zastał poprawnie rozpozna-
if ( !$form->hasValidData( 'album' ) ) ny). Składniki archiwum możemy w pro-
{ sty sposób przejrzeć przy pomocy pętli
throw new Exception( 'No valid album ID.' ); foreach. Metoda extractCurrent() roz-
}
pakowuje aktualnie wybrany składnik
$this->album = ezcGallery::getSession()->load( 'Album', $form->album );
i zapisuje go w określonej lokacji. No,
} to było naprawdę proste! Czas obsłużyć
else rozpakowane obrazy (Listing 30).
{ Przedstawiona metoda przyjmuje na
throw new Exception( 'No album selected.' );
wejściu roboczą ścieżkę, w której znaj-
}
}
dują się rozpakowane obrazy, a także
szablon tytułu i opisu dla poszczegól-
Listing 27. Pobieranie wszystkich zdjęć z zadanego albumu nych zdjęć. Metoda zbudowana jest na
bazie dużej pętli while, która iteruje po
public function run()
kolejnych składnikach w docelowym ka-
{
$query = ezcGallery::getSession()->createFindQuery talogu. W trakcie iteracji pomijamy kata-
( 'Photo' ); logi “.” oraz “..”, a także w rekurencyjny
$query->where( sposób przeglądamy podkatalogi, jeśli
$query->expr->eq takowe istnieją.
( 'album', $this->album->id )
Jeśli napotkamy plik, to próbujemy
);
$this->photos = ezcGallery::getSession()->find wykonać na nim operację, którą oma-
( $query, 'Photo' ); wialiśmy w trakcie analizy kodu obsługi
} żądania wstawienia nowego obrazu do
galerii. Jedyna różnica polega na dołą-

60 www.phpsolmag.org PHP Solutions Nr 4/2006

 eZ components Narzędzia

Listing 28. Przygotowanie do eks- Listing 30. Definicja metody addPhotos()

trakcji plików z wczytanego archi-
wum. private function addPhotos( $path, $title, $description )
{
if ( !is_uploaded_file( $file ) ) $d = dir( $path );
{ while ( ($entry = $d->read() ) !== false )
throw new Exception( {
'Illegal file upload.' ); if ( $entry == '.' || $entry == '..' )
} {
continue;
// Create a temp dir }
$path = tempnam( 'data/', $fullPath = $path . DIRECTORY_SEPARATOR . $entry;
'upload' ); if ( is_dir( $fullPath ) )
unlink( $path ); {
mkdir( $path ); $this->addPhotos( $fullPath, $title, $description );
}
Listing 29. Ekstrakcja obrazów
z archiwum else
{
try $name = substr( basename( $fullPath ), 0, strrpos( basename( $fullPath
{ ), '.' ) );
$archive = ezcArchive::open( $file try
); {
} $photo = new Photo();
catch ( ezcArchiveException $e ) $photo->title = sprintf( $title, $name );
{ $photo->description = sprintf( $description, $name );
throw new Exception( $photo->create( $fullPath, $this->album->id );
'Archive invalid.' ); $this->photos[] = clone( $photo );
} ezcGallery::getLog()->log(
foreach ( $archive as $entry ) "Added new photo with ID <{$photo->id}> from archive.",
{ ezcLog::INFO,
$archive-> array( 'category' => 'Upload' )
extractCurrent( $path ); );
} }
return $path; catch ( Exception $e )
{
$this->errors[] = $e;
// Cleanup
czeniu obsługi szablonu nazwy i opisu
@unlik( $fullPath );
dla poszczególnych zdjęć. Cała resz- }
ta kodu wygląda identycznie. W bloku }
catch składowane są wyjątki, aby na }
końcu przedstawić użytkownikowi kom- rmdir( $path );
}
pleksowy raport opisujący potencjalne
błędy. W tym samym miejscu kasujemy
również niepoprawnie obsłużony plik Podsumowanie dziane. Jeśli mielibyście ochotę w ja-
(musimy to zrobić, gdyż ze względu na Udało nam się zbudować w pełni funk- kiś sposób przyczynić się do rozwoju
powstanie sytuacji wyjątkowej funkcja cjonalną galerię obrazów w postaci tego projektu – to nic nie stoi na prze-
Photo::create() prawdopodobnie nie aplikacji webowej – i co ważne – do- szkodzie. Wystarczy napisać pod adres
obsłużyła tego pliku w poprawny spo- konaliśmy tego przy użyciu relatywnie components@lists.ez.no. n
sób). Na wszelki wypadek wyciszyłem niewielkiej ilości kodu (w porównaniu
wywołanie funkcji unlink(); nie polecam do podobnych rozwiązań, w których
stosowania tej techniki w aplikacjach kla- wszystko jest pisane od podstaw). Co
sy produkcyjnej, jednak w naszym przy- więcej, zbudowany kod cechuje się bar- O autorze
padku jest to dobry (i tani) sposób na dzo dobrą organizacją i spójną struk-
Tobias Schlitt pracuje dla eZ systems
unikniecie brzydkich komunikatów o błę- turą. Mam nadzieję, że przedstawiony jako główny programista. Do jego pod-
dach. Ostatnie wywołanie w metodzie tekst przekonał czytelników do korzy- stawowych obowiązków należy rozwi-
kasuje roboczy katalog. stania z komponentów eZ i rozjaśnił nie- janie projektu eZ components. Tobias
Szablon wykorzystany do prezen- co koncepcje na których te komponenty studiuje też informatykę na uniwersyte-
cie w Dortmund, mając za sobą praktyki
tacji wyników działania opisywanej zostały zbudowane. w Deutsche Bank, na stanowisku spe-
akcji różni się trochę od pozostałych Na koniec, gorąco zachęcam czy- cjalisty IT. Tobias jest znanym ekspertem
przykładów, jednak nadal nie wno- telników do dalszych eksperymentów w środowisku prgramistów PHP, ku cze-
si żadnego istotnego elementu nowo- z tą technologią. Zainteresowanych mu przyczyniły się jego prace nad pro-
jektem PEAR (w którym nadal zresztą
ści – dlatego nie będę go w tym miej- zapraszam na nasze forum dyskusyj- uczestniczy).
scu opisywał. ne – wszelkie komentarze są mile wi-

PHP Solutions Nr 4/2006 www.phpsolmag.org 61

Techniki
Dekorator: wzorzec projektowy
na każdą bolączkę
Paweł Kozłowski
W SIECI
• http://flexi.sourceforge.net/
– budowany przez nas fra-
mework
• http://www.picocontainer.org/
Ports – Pico
• http://www.martinfowler.com/
articles/injection.html – cie-
kawe artykuły
• http://www.phppatterns.com/
– ciekawe artykuły
62
Nazwa wzorca projektowego dekorator jest
nieco myląca, ponieważ sugeruje, że będziemy
coś wzbogacać, dekorować czy upiększać. Nic
bardziej błędnego! Omawiany wzorzec znajduje
szerokie zastosowanie, niezależnie od tego, czy
projektujemy warstwę dostępu do bazy danych,
logikę biznesową lub kontroler MVC.
J
ednym z najczęściej omawianych
i używanych wzorców projektowych
jest dekorator. Z punktu widzenia
programisty ma same zalety: jest bardzo
użyteczny, nieskomplikowany w imple-
mentacji i łatwy do przyswojenia. Obok
singletona jest to prawdopodobnie jeden
z pierwszych wzorców, z którymi stykamy
się, gdy zaczynamy studiować przykła-
dy i literaturę poświęconą zasadom pro-
jektowania. O ile jednak singleton jest ob-
winiany (często słusznie!) o promowanie
fatalnych rozwiązań, to dokładne pozna-
nie dekoratora przyczyniło się do powsta-
nia wielu ciekawych rozwiązań architekto-
nicznych.
Nazwa wzorca projektowego „deko-
rator” jest nieco myląca, ponieważ su-
geruje, że będziemy coś wzbogacać, de-
korować czy upiększać. Stąd może po-
wstać błędne przeświadczenie, że ma-
my do czynienia z tworem przydatnym
jedynie w warstwie prezentacji. Nic bar-
dziej błędnego! Omawiany wzorzec znaj-
www.phpsolmag.org
Stopień trudności: lll
duje szerokie zastosowanie, niezależnie
od tego, czy projektujemy warstwę do-
stępu do bazy danych, logikę bizneso-
wą lub kontroler MVC. Jego istotą jest
możliwość wzbogacenia funkcjonalności
obiektów danych klas w sposób dyna-
miczny, bez konieczności modyfikowania
oryginalnych obiektów.
Definicje jak zwykle brzmią zbyt su-
cho, spójrzmy więc na Listing 1, gdzie
Co należy wiedzieć...
Przydatna będzie znajomość dwóch po-
przednich artykułów z naszej serii Wzor-
ce projektowe. Czytelnik powinien mieć
wiedzę z obiektowych technik projekto-
wania aplikacji.
Co obiecujemy...
Z artykułu dowiesz się, kiedy i dlaczego
warto stosować wzorzec projektowy de-
korator. Na przykładach pokażemy, jak
stosując dekorator, bardzo łatwo i w ele-
gancki sposób dodać nową funkcjonal-
ność do aplikacji bez zbędnej modyfika-
cji kodu.
PHP Solutions Nr 4/2006

znajduje się elementarny przykład
użycia dekoratora. W przedstawio-
nym przypadku użyliśmy dekoratora do
wzbogacenia istniejącej funkcjonalno-
ści. Nie musimy jednak zbyt ściśle su-
gerować się nazwą wzorca projektowe-
go i spokojnie możemy pozwolić sobie
na całkowitą zmianę funkcjonalności
dekorowanego obiektu.
Dwa proste przykłady, przedstawio-
ne na wspomnianych listingach, obrazują
praktycznie wszystkie istotne cechy wzor-
ca, z którym się zaznajamiamy. Szczegól-
ne istotny do odnotowania jest jeden fakt:
dla klienta korzystającego z udekorowa-
nego (często mówimy również – „opako-
wanego”) obiektu obecność dekoratora
jest zupełnie przezroczysta! Klient nie jest
w stanie stwierdzić, czy korzysta z usług
oryginalnego obiektu, czy też z jego ude-
korowanej wersji. Jest to możliwe dzię-
ki zachowaniu przez dekorator interfejsu
oryginalnego obiektu. Jeśli chcielibyśmy
zapamiętać jakąś jedną zasadę czy zda-
nie opisujące dekoratory, mogłoby to być:
Dokorator zachowuje interfejs oryginalne-
go obiektu i najczęściej przyjmuje dekoro-
wany obiekt jako parametr w swoim kon-
struktorze.
Kolejną bardzo miłą cechą dekoratora
jest możliwość użycia więcej niż jednego
„opakowania” dla podstawowego obiek-
tu. Oznacza to, iż możemy składać no-
wą funkcjonalność z wielu już istniejących
elementów, bez konieczności ingerencji
w raz stworzony kod. Jest to dokładnie ta
sama filozofia, jaką spotykamy przy pracy
z powłoką w systemach uniksowych. Do-
skonale wiemy, jak wiele pożytecznych
operacji można wykonać, zaprzęgając do
wspólnej pracy elementarne narzędzia. To
samo odnosi się do dekoratorów: sprytnie
łącząc wiele prostych dodatków możemy
uzyskać funkcjonalność, o której nie śniło
się nawet twórcom piszącym klasy czy też
dekoratory (Listing 2).
Zanim przejdziemy do omówie-
nia bardziej skomplikowanych przykła-
dów, zatrzymajmy się jeszcze na chwilę
nad własnością dekoratorów, dzięki któ-
rej klient nie jest w stanie rozróżnić, czy
ma do czynienia z obiektem podstawo-
wym, czy też z opakowaną jego wersją.
Uważny Czytelnik zauważy, że ta nie-
rozróżnialność jest możliwa, ponieważ
pomiędzy dekoratorem i obiektem de-
korowanym zachodzi taka sama relacja
PHP Solutions Nr 4/2006
Wzorce projektowe: dekorator Techniki
(„jest”, ang. IS-A), jak przy dziedziczeniu. du i doprowadziła do powstania nowej
Istotnie, przykład z Listingu 2 można by funkcjonalności. Niestety, w przypadku
zapisać tylko i wyłącznie przy pomocy dziedziczenia mamy dużo trudniejsze za-
tworzenia nowych podklas (Listing 3). danie: nie obędzie się bez dosyć istotne-
Jaki jest więc sens wprowadzania zu- go przemeblowania napisanego kodu.
pełnie nowej konstrukcji programistycz- Powodem jest fakt, iż formując hie-
nej i opisywania jej jako wzorca projekto- rarchię dziedziczenia tworzymy dość
wego? Przecież to samo można uzyskać sztywne, statyczne powiązanie pomię-
przy użyciu podstawowych konstrukcji dzy poszczególnymi klasami.
programowania obiektowego. Jest jed- W przypadku dekoratorów nie ma-
na, dosyć istotna różnica pomiędzy dwo- my takiego ograniczenia: możemy do-
ma wspomnianymi podejściami. Aby ją wolnie przestawiać kolejność, dodawać
łatwo pokazać, przemodelujmy przykład nowe elementy do łańcucha i usuwać już
z Listingu 2, zmieniając kolejność zasto- istniejące. Takie zamiany są możliwe nie
sowanych dekoratorów (Listing 4). Pro- tylko w momencie ustalania struktury ko-
szę bardzo: cała operacja była wyjąt- du, ale w dowolnym momencie, nawet
kowo prosta, odbyła się bez koniecz- w czasie wykonywania skryptu. Dzięki
ności modyfikowania istniejącego ko- dekoratorom można uzyskać wszystkie
Listing 1. Prosty przykład użycia dekoratora
<?php
/**
*interfejs, ktory może być implementowany przez wiele klas
*ponieważ dekoratory również implementują ten interfejs
*klient korzystający z udekorawanej klasy nie jest w stanie
*rozróżnić, czy ma do czynienia z pierwotną, czy udekorowaną wersją
*/
interface UserDAO {
public function save(User $user);
public function findByLoginNamePassword($loginName, $password);
}
class UserDAOImpl implements UserDAO {
public function save(User $user) {
// standardowa funkcjonalność zapisywania
// danych użytkowników do DB
}
public function findByLoginNamePassword($loginName, $password){
// standardowa funkcjonalność odnajdywania
// danych użytkowników po nazwie
}
}
class UserDAOUpperCaseLoginDecorator implements UserDAO {
private $_decoratedDao;
public function __construct(UserDAO $decoratedDao){
$this->_decoratedDao = $decoratedDao;
}
public function save(User $user) {
//zadaniem dekoratora jest zapisywanie loginów
//tylko wielkimi literami
$user->setLoginName(strtoupper($user->getLoginName()));
//wywołanie oryginalnej funkcjonalności
$this->_decoratedDao->save($user);
}
public function findByLoginNamePassword($loginName, $password) {
//implementacja wyszukiwania pozostaje bez zmian
return $this->_decoratedDao->findByLoginNamePassword(
$loginName, $password);
}
}
//konstruowanie udekorowanej wersji obiektu
$dao = new UserDAOUpperCaseLoginDecorator(new UserDAOImpl());
?>
www.phpsolmag.org 63
Techniki Wzorce projektowe: dekorator
dobrodziejstwa dziedziczenia, ale w spo-
sób bardziej elastyczny.
Nie oznacza to oczywiście, iż nama-
wiamy Was, by od dzisiaj nie używać dzie-
dziczenia i pisać tylko dekoratory. Jak
każdy wzorzec projektowy, dekorator nie
powinien być stosowany tylko w celu
otrzymania bardziej elastycznej architek-
tury, ale w przypadkach, w których będzie
naprawdę pomocny. Uzbrojeni w solidne
podstawy teoretyczne możemy przyjrzeć
się wreszcie przykładom pokazującym, jak
w łatwy i efektywny sposób rozbudować
nasze aplikacje bez konieczności modyfi-
kacji ich podstawowego kodu.
Wróćmy zatem do przykładów. Jed-
ną z dobrych praktyk architektonicznych
jest dzielenie kodu aplikacji na warstwy.
W typowej aplikacji WWW, najniższą
warstwę stanowi baza danych (najczę-
ściej w postaci relacyjnej bazy danych
lub zwykłych plików). Powyżej umiesz-
czamy wartwę dostępu do danych w po-
staci obiektów DAO (ang. Data Access
Objects). Już ta jedna wspomniana war-
stwa jest okazją do zaimplementowaniu
wielu funkcjonalności w postaci deko-
ratorów. Wyobraźmy sobie, że chcemy
zapisywać czas wyszukiwania danych
w DB. Nic prostszego: zamiast mody-
fikować istniejący kod, otoczmy go do-
datkową klasą (Listing 5). A może mamy
DAO służące do zapisu danych użyt-
kowników i w pewnych przypadkach
chcemy szyfrować hasła. Proszę bar-
dzo: zamiast utrzymywać dwie zbliżone
wersje tego samego DAO, dużo efek-
tywniej rozwiążemy problem stosując
prosty dekorator – bez modyfikowania
i duplikowania istniejącego kodu.
Przykłady można mnożyć również
w innych warstwach sytemu. Jeśli pomy-
ślimy o dowolnej logice biznesowej zapi-
sującej dane, to dekoratory znajdą zasto-
sowanie przy wersjonowaniu danych, za-
pisywaniu logów zmian, kontroli dostępu
itd. Przesuwając się jeszcze jedną war-
stwę wyżej, do kontrolerów MVC, szybko
odkryjemy kolejne zastosowania: śledze-
nie zachowań użytkowników (np. ścież-
ki poruszania się po serwisie WWW) czy
sprawdzanie uprawnień. Zastosowania
i przykłady można by mnożyć w nieskoń-
czoność. Poprzestańmy więc na stwier-
dzeniu, że wzorzec dekoratora jest nie-
zwykle użyteczny i podpowiada eleganc-
kie rozwiązania dla często spotykanych
problemów związanych z dodawaniem
specyficznej funkcjonalności w różnych
64
wersjach tej samej, podstawowej apli- koratorów do dodania obsługi uprawnień
kacji. Ta mnogość i wygoda zastosowań na poziomie warstwy kontrolerów MVC.
powoduje, że w złożonej aplikacji może- Listing 6 pokazuje dwa przykładowe kon-
my mieć wiele dekoratorów dla jednego trolery oraz opakowanie z dekoratorów
obiektu. Pisanie takiej ilości dekoratorów sprawdzających uprawnienia. Przedsta-
i zarządzanie ich konfiguracją stanowi wy- wiony schemat dodawania obsługi upraw-
zwanie samo w sobie. W dalszej części nień do aplikacji jest niezwykle efektyw-
artykułu zastanowimy się więc, jak szybko ny. Po pierwsze, pozwala uruchamiać tą
pisać i konfigurować dekoratory. samą aplikację ze sprawdzaniem upraw-
Zatrzymajmy się na dłużej nad przy- nień i bez, w zależności od wymagań
wołanym przykładem zastosowania de- klienta. Z drugiej strony, taka architektura
Listing 2. Łączymy dekoratory
<?php
class UserDAOPasswordHashingDecorator implements UserDAO {
private $_decoratedDao;
public function __construct(UserDAO $decoratedDao){
$this->_decoratedDao = $decoratedDao;
}
public function save(User $user) {
//zadaniem dekoratora jest zapisywanie loginów
//tylko wielkimi literami
$user->setPassword(md5($user->getPassword()));
//wywołanie oryginalnej funkcjonalności
$this->_decoratedDao->save($user);
}
public function findByLoginNamePassword($loginName, $password) {
//przy wyszukiwaniu również szyfrujemy hasła
return $this->_decoratedDao->findByLoginNamePassword(
$loginName, md5($password));
}
}
//konstruowanie wielokrotnie udekorowanej wersji obiektu
$dao = new UserDAOUpperCaseLoginDecorator(new UserDAOPasswordHashingDecorator(
new UserDAOImpl()));
?>
Listing 3. Przykład z Listingu 2 zapisany przy pomocy nowych podklas
<?php
class UserDAOUpperCaseLogin extends UserDAOImpl {
public function save(User $user) {
$user->setLoginName(strtoupper($user->getLoginName()));
parent::save($user);
}
}
class UserDAOPasswordHashing extends UserDAOUpperCaseLogin {
public function save(User $user) {
$user->setPassword(md5($user->getPassword()));
parent::save($user);
}
public function findByLoginNamePassword($loginName, $password) {
return parent::findByLoginNamePassword($loginName, md5($password));
}
}
//konstruowanie wersji obiektu z dziedziczeniem
$dao = new UserDAOPasswordHashing();
?>
Listing 4. Zmieniona kolejność zastosowanych dekoratorów w stosunku do
Listingu 2. Tworzymy nową funkcjonalność bez modyfikacji istniejącego kodu.
<?php
$dao = new UserDAOPasswordHashingDecorator(new UserDAOUpperCaseLoginDecorator(
new UserDAOImpl()));
?>
www.phpsolmag.org PHP Solutions Nr 4/2006
Techniki Wzorce projektowe: dekorator
Rysunek 1. Uproszczony graf obiektów w naszej aplikacji
umożliwia niezależne pisania kodu biz-
nesowego i odpowiedzialnego za bez-
pieczeństwo. Wreszcie, możemy sobie
wyobrazić zastosowanie różnych silni-
ków do sprawdzania uprawnień (np. wła-
sny lub GACL). Niestety, nasze wszystkie
zachwyty trochę przybledną, jeśli uświa-
domimy sobie, że dla każdego kontrole-
ra trzeba stworzyć osobny dekorator. Nie
jest to może wielkim problemem przy pię-
ciu czy dziesięciu kontrolerach, ale sta-
je się koszmarem przy dużych aplika-
cjach, gdzie często spotkamy setki klas ty-
pu kontroler. Nasze miny staną się jesz-
cze bardziej nietęgie, jeśli uświadomimy
sobie, że każdy z dekoratorów będzie do
siebie bardzo podobny. Ponowny rzut oka
na Listing 6 faktycznie ujawnia, że w kolej-
nych dekoratorach różnią się tylko nazwy
klas i metod – zasadnicza logika pozosta-
je praktycznie bez zmian.
Bezmyślne pisanie niemal iden-
tycznych dekoratorów nie jest zajęciem
szczególnie ciekawym czy produktyw-
nym, a dodatkowo – to oczywista dupli-
kacja kodu. Musimy więc znaleźć jakiś
sposób na zautomatyzowanie żmudne-
go zajęcia. PHP5, jako język niezwykle
dynamiczny daje nam szerokie możli-
wości generowania szablonowego kodu
w locie. Spośród wielu opcji dwie wydają
się najciekawsze: użycie magicznej me-
tody __call lub generowanie całego ko-
du dekoratora w czasie działania skryp-
tu. Obie metody mają swoje wady i za-
lety, które za chwilę omówimy, ale naj-
pierw spójrzmy na Listing 7, gdzie znaj-
dują się przykładowe dekoratory (z Li-
stingu 6), zaimplementowane przy uży-
ciu obu wspomnianych metod.
Dekorator stworzony przy pomocy
__call jest dosyć prosty i pozwala pre-
zycyjnie regulować, które metody w de-
koratorze są generowane automatyczne,
a które ręcznie. Po prostu dla tych, któ-
re chcemy napisać sami, tworzymy kon-
66
Aby obejść zidentyfikowany problem,
�������������������
posłużymy się prostą koncepcyjnie me-
todą – generowaniem kodu w locie.
Spójrzmy na Listing 8, gdzie pokazujemy
���������������� użycie specjalnie przygotowanej biblio-
teki (PHPProxy, dostępnej na sourcefor-
ge.net) do generowania kodu. Jak widać,
samo jej użycie jest niezwykle proste
����������� – sprowadza się do zaimplementowania
tylko tej logiki, która ma się znaleźć w de-
koratorze – nie musimy powielać ani jed-
nego znaku kodu. Tak prosta implemen-
tacja jest możliwa dzięki istnieniu inter-
kretną metodą, a wprzypadku pozosta- fejsu ProxyInvocationHandler. W inter-
łych metod polegamy na __call. Oma- fejsie tym zdefiniowana jest tylko jedna
wiana właśnie metoda ma w zasadzie tyl- metoda – invoke($method, $args). Nie
ko jedną wadę – w ten sposób wygene- trzeba być potomkiem Sherlocka Holme-
rowane dekoratory nie mogą być użyte w sa by wydedukować, że metoda ta jest
wywołaniach funkcji i metod, dla których uruchamiana w momencie wywoływania
określono typ argumentu (a więc dla kon- metod na dekoratorze, a w argumetach
strukcji $obiekt->nazwaMetody(TypArgume otrzymujemy wszystkie niezbędne infor-
ntu $agrument);). Jest to dość poważna macje o wywołaniu – tj. nazwę metody
wada, ponieważ na początku podkreśla- i jej argumenty. Korzystając z implemen-
liśmy, iż jedną z cech dekoratora jest za- tacji interfejsu ProxyInvocationHandler
chowanie interfejsu oryginalnego obiek- z opisywanej biblioteki (Listing 9), może-
tu. Zastosowanie __call do generowania my łatwo zdecydować, czy chcemy tyl-
dekoratorów wyklucza silniejszą kontrolę ko udekorować oryginalną funkcjonal-
typów, a tym samym – interfejsów imple- ność (a więc wywołać ją podczas uru-
mentowanych przez podstawową i udeko- chamiania dekoratora), czy też stwo-
rowaną klasę. rzyć zupełnie nowy kod: cały sekret tkwi
Listing 5. Dodajemy nową funkcjonalność do zapisywania czasu wyszukiwania
danych w DB
<?php
class PerformanceLoggingUserDAO implements UserDAO {
private $_decoratedDao;
private $_startTime;
public function __construct(UserDAO $decoratedDao){
$this->_decoratedDao = $decoratedDao;
}
public function save(User $user) {
$this->startMethodExecution();
$this->_decoratedDao->save($user);
$this->stopMethodExecution('save');
}
public function findByLoginNamePassword($loginName, $password) {
$this->startMethodExecution();
return $this->_decoratedDao->findByLoginNamePassword(
$loginName, $password);
$this->stopMethodExecution('findByLoginNamePassword');
}
private function startMethodExecution(){
$this->_startTime = microtime();
}
private function stopMethodExecution($methodName){
$executionTime = microtime() - $this->_startTime;
echo "Wykonanie metody '$methodName' zajęło $executionTime <br>";
}
}
//konstruowanie udekorowanej wersji obiektu
$dao = new PerformanceLoggingUserDAO(new UserDAOImpl());
?>
www.phpsolmag.org PHP Solutions Nr 4/2006

w metodzie getDelegate(), dzieki której
możemy pobrać dekorowany obiekt i wy-
wołać na nim dowolną metodę.
Użycie biblioteki PHPProxy pozwala
generować dekoratory przy minimalnym
nakładzie pracy ze strony programisty
i przy eliminacji powtórzeń w kodzie.
Niestety, nie jest to metoda pozbawiona
wad. Po pierwsze, generowanie kodu
w czasie działania programu może być
zbyt czasochłonne w przypadku mocno
obciążonych serwisów internetowych,
gdzie wydajność jest rzeczą krytyczną.
Drugi, trochę mniej uciążliwy pro-
blem, związany jest z przypadłością
nękająca wszystkie rozwiązania oparte
o generowanie kodu. Otóż podczas wy-
konania programu uruchamiany jest
również kod, który... nie jest nigdzie
zapisany na stałe. Oznacza to, że
w pewnych warunkach śledzenie wyko-
nania programu (np. podczas wyszuki-
wania błędów) może być nieco utrud-
nione. Tak czy inaczej, mimo przedsta-
wionych wad, jest to zdecydowanie naj-
łatwiejsza metoda tworzenia wielu deko-
ratorów.
Podsumujmy naszą dotychczaso-
wą wiedzę o dekoratorach. Na wstę-
pie stwierdziliśmy, że jest to bardzo po-
żyteczny wzorzec, który może być sto-
sowany praktycznie w każdej warstwie
systemu. Jest to alternatywa do dziedzi-
czenia obiektów, umożliwiająca wzbo-
gacanie lub zmianę istniejącej funkcjo-
nalności, bez konieczności modyfikacji
raz napisanego kodu. Dekorator pada
jednak trochę ofiarą własnego sukcesu
– mnogość jego zastosowań powodu-
je, że w bardziej rozbudowanej aplikacji
możemy wykorzystać setki obiektów im-
plementujących wzorzec dekoratora.
Aby nie zginąć w tym gąszczu po-
dobnych obiektów, znaleźliśmy dwie
metody na dynamiczne generowanie
dekoratorów. Niestety, to nie koniec pro-
blemów, które musimy rozwiązać, aby
efektywnie wykorzystać dekoratory ja-
ko integralną część rozwiązania archi-
tektonicznego.
Załóżmy, że Rysunek 1 przedsta-
wia uproszczony graf obiektów w naszej
aplikacji. Obiekty te są oczywiście uło-
żone w warstwy, natomiast obiekty są
połączone między sobą siecią zależ-
ności. Już samo poprawne skonstru-
owanie takiej sieci obiektów może być
nie lada wyzwaniem, o czym Czytelnik
mógł się przekonać, śledząc mój artykuł
PHP Solutions Nr 4/2006
Wzorce projektowe: dekorator Techniki
�������������������
���
�����������
����������������
���
��������������� �����������
���
��������������������
Rysunek 2. Dodając dekoratory, wprowadzamy do omawianego grafu kolejny stopień
skomplikowania, opakowując wybrane obiekty aplikacji
Listing 6a. Dwa przykładowe kontrolery oraz opakowanie z dekoratorów
sprawdzających uprawnienia
<?php
class useraction {
private $_userService;
public function __construct(UserService $userService) {
$this->_userService = $userService;
}
public function listall(HttpRequest $request, ModelAndView $mv){
$users = $this->_userService->findAll();
$mv->addToModel('users',$users);
$mv->setView('userslist');
return $mv;
}
public function listwithexpensivequery(
HttpRequest $request, ModelAndView $mv){
$users = $this->_userService->findUserByExpensiveQuery();
$mv->addToModel('users',$users);
$mv->setView('userslist');
return $mv;
}
public function addform(HttpRequest $request, ModelAndView $mv){
$mv->setView('useraddform');
return $mv;
}
public function add(HttpRequest $request, ModelAndView $mv){
$user = new User(
$request->getParam('login'),
$request->getParam('pass'),
$request->getParam('firstname'),
$request->getParam('lastname'));
$mv->addToModel('user',$user);
try {
$this->_userService->addUser($user);
$mv->setView('useraddconfirm');
} catch (UserExistsException $e) {
$mv->addToModel('adduser_error','User exists!');
$mv->setView('useraddform');
}
return $mv;
}
}
class homepage {
public function show(HttpRequest $request, ModelAndView $mv){
$mv->setView('homepage');
return $mv;
}
}
www.phpsolmag.org 67
Techniki Wzorce projektowe: dekorator

Obiektowa linia montażowa, czyli przej-

�����������������������������������������������
rzyste i elastyczne aplikacje w PHP5,
z numeru 1/2006. Dodając dekoratory,
�������������� wprowadzamy do omawianego grafu ko-
lejny stopień skomplikowania, opakowu-
jąc wybrane obiekty aplikacji (Rysunek 2).
����������������������� �����������������������
����������������������� ����������������������� Warto przy tym zauważyć, że udekorowa-
niu będą podlegały głównie obiekty infra-
�������������
strukturalne (kontrolery, DAO itd.), a nie
domenowe. Musimy więc znaleźć jakiś ła-
Rysunek 3. W Pico zawarta jest cała konfiguracja związana z połączeniami pomiędzy
twy sposób na dodanie wielu dekoratorów
obiektami. Aby wprowadzić dodatkowy obiekt pośredniczący, musimy jedynie
przekonfigurować połączenia. w całej aplikacji, bez konieczności ręczne-
go przebudowywania połączeń.
Przy składaniu skomplikowanych
Listing 6b. Dwa przykładowe kontrolery oraz opakowanie z dekoratorów grafów obiektów doskonale sprawdza
sprawdzających
się wzorzec architektoniczny IoC (ang.
// Klasa pomocnicza dla dekoratorów, gdzie odbywa się Inversion of Control), o którym również
// właściwe sprawdzanie uprawnień pisaliśmy w wyżej wspomnianym artyku-
abstract class AbstractActionSecurityDecoratorImpl { le. Mamy szczęście, ponieważ ten sam
private $_decoratedAction;
wzorzec również znakomicie ułatwia do-
public function __construct($decoratedAction) {
$this->_decoratedAction = $decoratedAction; dawanie dekoratorów. Dlaczego? Przy-
} pomnijmy, że w przypadku stosowania
public function executeTargetActionWithSecurityCheck( wzorca IoC bardzo pomocne są bibliote-
$targetAction, HttpRequest $request, ModelAndView $mv){ ki typu kontener IoC. Te lekkie kontene-
ry biorą na siebie cały ciężar tworzenia
//tutaj tylko proste sprawdzanie, czy zalogowany,
//ale równie łatwo zintegrować np. GACL skomplikowanych grafów obiektów, dba-
session_start(); jąc przy tym o właściwe rozwiązanie za-
if ($_SESSION['user'] == null) { leżności pomiędzy obiektami. Kontener
$mv->setView('loginform'); IoC jest więc jednym, centralnym miej-
return $mv;
scem, gdzie powoływane są do życia
} else {
return $this->_decoratedAction->$targetAction($request, $mv); instancje obiektów infrastrukturalnych.
} Doskonale, o to nam właśnie chodziło.
} To scentralizowane miejsce tworzenia
} obiektów pozwala nam łatwo dodać na-
//Mimo, iż obie akcje są zupełnie inne,
sze „opakowania”. Spójrzmy na Listing
//to dekoratory są niemal identyczne!
//Oczywista duplikacja kodu! 10, gdzie znajdziemy przykład wykorzy-
class UserActionSecurityDecoratorImpl stania Pico dla PHP – lekkiego konte-
extends AbstractActionSecurityDecoratorImpl { nera IoC – do dodania dekoratorów do
public function listall(HttpRequest $request, ModelAndView $mv){ obiektów aplikacji. Jak widać, cała ope-
return $this->executeTargetActionWithSecurityCheck(
racja jest stosunkowo prosta – wystar-
'listall', $request, $mv);
} czą dwie linijki kodu.
public function listwithexpensivequery( Przeanalizujmy dokładniej przykład
HttpRequest $request, ModelAndView $mv){ z Listingu 10. Widzimy na nim początko-
return $this->executeTargetActionWithSecurityCheck( wo dwa współpracujące ze sobą obiek-
'listwithexpensivequery', $request, $mv);
ty: serwisowy i DAO. Są to obiekty infra-
}
public function addform(HttpRequest $request, ModelAndView $mv){ strukturalne, podczas dzialania aplikacji
return $this->executeTargetActionWithSecurityCheck( potrzebny jest zwykle tylko jeden egzem-
'addform', $request, $mv); plarz takiego obiektu. W tym przypadku
} to Pico dba o powołanie do życia instan-
public function add(HttpRequest $request, ModelAndView $mv){
cji obiektów oraz ich połączenie. Aby za-
return $this->executeTargetActionWithSecurityCheck('add', $request, $mv);
} stosować dekorator zliczający czas wy-
} konania poszczególnych metod, musimy
class HomepageActionSecurityDecoratorImpl w jakiś sposób rozerwać ścisłe połącze-
extends AbstractActionSecurityDecoratorImpl { nie pomiędzy obiektem DAO i obiektem
public function show(HttpRequest $request, ModelAndView $mv){
z DAO korzystającym. Przy klasycznym
return $this->executeTargetActionWithSecurityCheck('show', $request, $mv);
} podejściu do budowy programów, gdyby-
} śmy użyli operatora new, metod statycz-
?> nych lub fabryk, mielibyśmy małe szan-
se na wprowadzenie trzeciego obiektu

68 www.phpsolmag.org PHP Solutions Nr 4/2006

 Wzorce projektowe: dekorator Techniki

w łańcuch powiązań. W przypadku kon-

Listing 7. Dekorator (z Listingu 6), zaimplementowany przy użyciu __call oraz tenera IoC sprawa jest o wiele prostsza,
generowanie całego kodu dekoratora w czasie działania skryptu ponieważ w Pico zawarta jest cała konfi-
<?php guracja związana z połączeniami pomię-
// implementacja dekoratora z wykorzystaniem metody __call dzy obiektami. Jedyne, co musimy zrobić,
class UserActionSecurityDecoratorCallImpl to przekonfigurować te połączenia w taki
extends AbstractActionSecurityDecoratorImpl { sposób, by wprowadzić dodatkowy obiekt
public function __call ($methodName, $args ) {
pośredniczący (Rysunek 3). W Pico robi-
$request = $args[0];
$mv = $args[1]; my to przy pomocy parametrów kompo-
return $this->executeTargetActionWithSecurityCheck( nentu, tak jak pokazaliśmy w drugiej części
$methodName, $request, $mv); }} Listingu 10. Oczywiście pokazany sposób
class HomepageActionSecurityDecoratorCallImpl można wykorzystać do użycia więcej niż
extends AbstractActionSecurityDecoratorImpl {
jednego dekoratora (Listing 11).
public function __call ($methodName, $args ) {
$request = $args[0]; Kontenery IoC w znaczący sposób
$mv = $args[1]; ułatwiają stosowanie dekoratorów w zło-
return $this->executeTargetActionWithSecurityCheck( żonych aplikacjach. Dzieki nim możemy
$methodName, $request, $mv); }} w jednym, centralnym miejscu, skonfi-
?>
gurować połączenia między obiektami
Listing 8. Działanie PHPProxy do dynamicznego generowania kodu i tym samym dodać nowy element do ta-
kiego połączenia. Sposób jest dość pro-
<?php sty i nie wymaga zmian w kodzie PHP
// biblioteka do dynamicznego generowania klas
– jedynie w konfiguracji kontenera IoC.
require_once(dirname(__FILE__).'/phpproxy/src/proxygenerator.inc.php');
// wprowadzamy interfejs na fragment kodu sprawdzający uprawnienia, aby mieć
// możliwość stosowania różnych sposobów i bibliotek Listing 9. Korzystając
interface SecurityChecker { z implementacji interfejsu
function hasRightsFor(User $user, $actionToCheckRightsFor); } ProxyInvocationHandler
class SecurityCheckerIsNotNull implements SecurityChecker { z opisywanej biblioteki możemy
function hasRightsFor(User $user, $actionToCheckRightsFor){ łatwo zdecydować, czy chcemy
if ($user != null) { tylko udekorować oryginalną
//tu tylko proste sprawdzanie, ale chcemy pokazać, funkcjonalność, czy też stworzyć
//że kod odpowiedzialny za sprawdzanie uprawnień zupełnie nowy kod
//jest wydzielony i może być użyty w dekoratorach
return true; } else { return false; } } } <?php
// Część wspólna dla wszystkich dekoratorów. Nie ma tu duplikacji kodu jak na interface ProxyInvocationHandler {
// Listingu 7.Cała logika związana ze sprawdzeniem uprawnień i wyowołaniem public function
// (lub nie) dekoratora zamknięta jest w tej jednej klasie invoke($method, $args);
class SecurityCheckerMethodInvImpl extends DelegatingInvocationHandler { }
private $_securityChecker; class DelegatingInvocationHandler
private $_decoratedAction; implements
public function __construct(SecurityChecker $securityChecker) { ProxyInvocationHandler {
$this->_securityChecker = $securityChecker; } private $_delegate = null;
public function invoke($method, $args) { public function __construct(
$request = $args[0]; $delegate){
$mv = $args[1]; $this->_delegate =
$user = getLoggedInUser(); $delegate;
if ($this->_securityChecker($user, $method)){ }
return parent::invoke($method, $args); public function invoke(
} else { $method, $args){
$mv->setView('loginform'); $reflectionClass =
return $mv; } } new ReflectionClass(
public function getLoggedInUser(){ get_class($this->
session_start(); getDelegate()));
return $_SESSION['user']; } } $reflectionMethod =
$proxyGenerator = new ProxyClassGenerator(); $reflectionClass->
$secureMethodInvocation = new SecurityCheckerMethodInvImpl( getMethod($method);
new SecurityCheckerIsNotNull()); return $reflectionMethod->
// dynamiczne wygenerowanie dowolnego dekoratora sprowadza się do jednej linii invokeArgs(
// kodu! $this->getDelegate(),$args);
$useractionDecorated = $proxyGenerator->getProxy( }
'useraction', $secureMethodInvocation); public function getDelegate(){
$homepageDecorated = $proxyGenerator->getProxy( return $this->_delegate;
'homepage', $secureMethodInvocation); }
}
?> ?>

PHP Solutions Nr 4/2006 www.phpsolmag.org 69

Techniki Wzorce projektowe: dekorator

Rozwiązanie jest prawie idealne. Pra- – lewniwego programisty to zdecydowa- nam pewna refleksja. Otóż w opisywa-
wie, bo w dalszym ciągu dla każde- nie zbyt duży wysiłek. nym przypadku stosujemy dekoratory do
go dekoratora trzeba dodać nowy wpis Jeśli pomyślimy całościowo o sty- globalnych zmian w całej aplikacji. Pa-
w konfiguracji i zmodyfikować połą- lu programowania, w którym napisany zo- trzymy na działające skrypty i myślimy:
czenia między obiektami. Dla twórczo stał Listing 10, to powinna nasunąć się teraz chcielibyśmy dodać logowanie do
wszystkich obiektów DAO, żeby zobaczyć,
Listing 10. Przykład wykorzystania Pico dla PHP – lekkiego kontenera IoC – do gdzie jest wąskie gardło wydajnościowe,
dodania dekoratorów do obiektów aplikacji albo: teraz udekorujmy wszystkie kontro-
lery, żeby sprawdzać uprawnienia. Nie-
<?php
stety, wypracowana do tej pory metoda
$parentPico = new DefaultPicoContainer();
skazuje nas na żmudne deklarowanie po-
$parentPico->regComponentImpl('FrontController', 'FrontControllerImpl');
$parentPico->regComponentImpl( jedynczych dekoratorów. Gdyby tylko ist-
'ActionResolvingStrategy', //componentKey niała konstrukcja programistyczna, pozwa-
'PicoActionResolvingStrategy', //componentClass lająca łatwo wyrazić żądania typu: obiekty
array ('paramName' => 'action')
określonego typu udekoruj danym kodem,
);
moglibyśmy dosłownie w kilku linijkach
$parentPico->regComponentImplWithIncFileName(
dirname(__FILE__).'/lib/SmartyViewResolver.php', kodu wprowadzić do aplikacji logowa-
'ViewResolvingStrategy', nie czy sprawdzanie uprawnień. Zupełnie
'SmartyViewResolvingStrategy', niezależnie od ilości obiektów do ude-
array (
korowania. Na pocieszenie chcemy po-
array('compile_dir' => dirname(__FILE__).'/work/templates_c'),
wiedzieć, że takie metody już powstają
'file:'.dirname(__FILE__).'/templates/smarty/',
'.tpl') (przykładowy Listing 11)! Jest to idea bar-
); dzo zbliżona do programowania aspek-
$pico = new DefaultPicoContainer(null, $parentPico); towego (ang. Aspect Oriented Program-
$pico->regComponentInstance($pico, 'PicoContainer');
ming), ale to już temat na zupełnie inny ar-
$pico->regComponentImplWithIncFileName(dirname(__FILE__).
tykuł.
'/../shared/model/model.inc.php','UserService','UserServiceImpl');
$pico->regComponentImplWithIncFileName(dirname(__FILE__).
'/../shared/model/model.inc.php','UserDAO','UserDAOPDOImpl'); Podsumowanie
$pico->regComponentImpl('PDO','PDOPicoAdapter',array W artykule pokazaliśmy, że dekorator jest
( 'pgsql:dbname=ditalkdb;host=localhost', 'postgres', 'postgres'));
prostym i niezwykle pożytecznym wzor-
//actions
cem projektowym. Jest tak użyteczny,
$pico->regComponentImplWithIncFileName(dirname(__FILE__).
'/actions/loginaction_action.php','loginaction','loginaction'); że w pewnym momencie możemy mieć
$pico->regComponentImplWithIncFileName(dirname(__FILE__). ochotę zastosować go na bardzo szero-
'/actions/useraction_action.php','useractionTarget', 'useraction'); ką skalę. Aby jednak zrobić to efektywnie,
$pico->regComponentImpl('useraction', 'UserActionSecurityDecoratorImpl', array
musimy zadbać o rozwiązanie dwóch pro-
('decoratedAction' => new BasicComponentParameter('useractionTarget')));
blemów: automatycznego generowania
$pico->regComponentImplWithIncFileName(dirname(__FILE__).
'/actions/homepage_action.php','homepageTarget','homepage'); dekoratorów oraz ich konfiguracji w całej
$pico->regComponentImpl('homepage', 'HomepageActionSecurityDecoratorImpl', array aplikacji. Z pierwszym problem doskonale
('decoratedAction' => new BasicComponentParameter('homepageTarget'))); poradzimy sobie dynamicznie generując
$fc = $pico->getComponentInstance('FrontController');
powtarzalny kod dekoratora. Zastosowa-
$fc->doService(new HttpRequest());
nie kontenera IoC wpłynie dodatnio na ar-
?> chitekturę naszej aplikacji i umożliwi łatwe
konfigurowanie dekoratorów. Jeśli zrozu-
Listing 11. Przykład rozwiązania, które nie skazuje nas na żmudne deklarowanie miemy i opanujemy przedstawione powy-
pojedynczych dekoratorów żej triki, świat programowania aspektowe-
<?php
go nie będzie miał przed nami tajemnic. n
//rejestracja poprzednich komponentów
//jak na Listingu 10
$pico->regComponentImplWithIncFileName(dirname(__FILE__).
'/actions/useraction_action.php','useraction', 'useraction'); O autorze:
$pico->regComponentImplWithIncFileName(dirname(__FILE__).
'/actions/homepage_action.php','homepage','homepage'); Paweł Kozłowski jest pracownikiem SU-
$pico->regComponentImplWithIncFileName(dirname(__FILE__). PERMEDIA, gdzie od roku 2000 projek-
'/actions/loginaction_action.php','loginaction','loginaction'); tuje i tworzy złożone aplikacje WWW w
//security decorators PHP. Obecnie zajmuje się rozwijaniem
$pico->regComponentImpl('SecurityMethodInterceptor'); frameworków i bibliotek ORM opartych
$pico->registerAspect(new Aspect(new RegExpNameMatchingPointcut( na PHP5. Jest autorem portu PicoCon-
'/^[a-km-z]+action$/'),new MatchingAllPointcut(), tainer dla PHP5 i wielu publikacji poświę-
'SecurityMethodInterceptor')); conych PHP.
?> Kontakt: pkozlowski@phpsolmag.org

70 www.phpsolmag.org PHP Solutions Nr 4/2006

Techniki

Metoda aktywnego
rekordu
Stopień trudności: lll
Jakub Sacha

Tworząc aplikacje internetowe na codzień,

często zdarza się nam operować na listach
danych np. artykułów, autorów, wpisów w
księdze gości czy nowości na stronie. Każda
z list organizowana jest w mniej lub bardziej
złożone tabele w bazie danych. Dużą część
czasu poświęcanego na przygotowanie aplikacji
zajmuje pisanie zapytań wstawiających lub
edytujących rekordy dla różnego rodzaju
danych, różniących się od siebie nazwami oraz
ilością kolumn.

W SIECI
• http://wiki.rubyonrails.com/
rails/pages/ActiveRecord
– Active record – strona do-
mowa projektu
• http://en.wikipedia.org/wiki/
Active_record - Active record
w Wikipedii:
W
przeważającej części jest to
mechaniczna praca, którą po-
staramy się w tym artykule
przenieść na PHP. Stwórzmy sobie listę
artykułów. Po przygotowaniu odpowiedniej
tabeli w bazie (jak na Listingu 1), zajmijmy
się obiektem, który będzie odpowiadał jed-
nemu rekordowi w tabeli (Listing 2).
W naszym przykładzie wykorzysta-
my wzorzec architektoniczny (dla źró-
dła danych) o nazwie Aktywny Rekord
(ang. Active Record). Zakłada on, że
obiekt odpowiada jednemu wierszowi
w bazie.
Do klasy Article przedstawionej na
Listingu 2 dopiszemy teraz metody od-
powiedzialne za jej update w bazie (nie
będziemy używać warstwy pośredniczą-
cej w dostępie do bazy, aby nie kompli-
kować przykładów, pomimo tego w pro-
jektach pisanych na codzień silnie prefe-
ruję użycie np. PDO). Przedstawione na
Listingu 3 funkcje wstawiamy w ciało kla-
sy Article.
Przeanalizujmy te trzy proste funk-
cje. Konstruktor zawiera pętle, przez po-
daną (opcjonalnie) w argumencie tablicę.
Pozwala nam to sprytnie i bezproblemo-
wo wpisać wartości do obiektu używając
new Article($data). Musimy oczywiście
uprzednio uzupełnić $data danymi z ba-
zy lub formularza – w zależności od po-
trzeb. Metoda Update() w zależności od
tego, czy wartość id jest uzupełniona,
przygotowuje i wykonuje zapytanie wsta-
wiające lub modyfikujące dane. Przy-
Co należy wiedzieć...
Powinieneś znać podstawy programo-
wania obiektowego w PHP5. Przydatna
będzie również lektura artykułu wprowa-
dzającego w tematykę wzorców projek-
towych, który ukazał się w PHP Solu-
tions 2/2006.
Co obiecujemy...
Poznasz nowy ważny wzorzec projekto-
wy związany z projektem Ruby On Rails
i jego praktyczne wykorzystanie.

72 www.phpsolmag.org PHP Solutions Nr 4/2006


gotowaliśmy prostą klasę, która będzie
pośredniczyć w naszym kontakcie z ba-
zą danych, pozwoli nam zapomnieć o pi-
saniu zapytań usuwających, dodających
i edytujących dane. Chcemy teraz wyge-
nerować listę rekordów w bazie. Mogli-
byśmy zrobić to standardowo wykonu-
jąc zapytanie, a następnie wpisując do
obiektów wartości używając przygotowa-
nej wcześniej sztuczki i podając kolejne
wiersze pobrane z bazy do konstruktora.
Przykładowy kod zaprezentowany został
na Listingu 4.
Dobrym nawykiem jest oddziele-
nie zapytań w wygodny dla nas spo-
sób. Przygotujmy więc obiekt, nazwijmy
go Finder – albo lepiej – ArticleFinder.
W nim zawrzemy ciało potrzebnych
w aplikacji metod, które będą zgodnie
z nazwą odpowiedzialne za odnajdywa-
nie artykułów lub ich kolekcji. Dla do-
Listing 1. Struktura tabeli artykułów
CREATE TABLE `articles`
(
`id` int(11) NOT NULL default '0',
`title` varchar(255)
NOT NULL default '',
`name` varchar(30)
NOT NULL default '',
`surname` varchar(30)
NOT NULL default '',
`date` datetime
NOT NULL default
'0000-00-00 00:00:00',
`body` text NOT NULL,
PRIMARY KEY (`id`)
) TYPE=MyISAM;
Listing 2. Przykładowy obiekt
odpowiadający rekordom w bazie
<?php
class Article{
public $id;
public $categories;
public $title;
public $name;
public $surname;
public $date;
public $body;
}
?>
PHP Solutions Nr 4/2006
Metoda aktywnego rekordu Techniki
bra i przejrzystości przykładu będziemy dzimy opisywaną metodę oraz dodat-
operować na zwykłych tablicach. W ce- kowo metodę FindById – założyłem, że
lu wygenerowania listy stworzymy funk- metody zaczynające się od Get zwracają
cję GetList i jako parametry podajmy jej tablicę, a Find konkretny obiekt.
limit oraz offset (przesunięcie). Pozwo- Naszemu Finderowi brakuje jesz-
li nam to na łatwe operowanie listą i po- cze wiele do ideału. Nie mamy wpły-
dzielenie jej na porcje. Na Listingu 5 wi- wu na sortowanie wyników, ale nie to
Listing 3. Metody odpowiedzialne za modyfikację bazy danych
function __construct($data = null){
foreach($data as $label=>$val){
$this->$label = $val;
}}
function Update(){
// Jeśli id jest oznaczone, to generujemy update
if(!empty($this->id)){
$SQL = "UPDATE articles SET
categories = '".mysql_escape_string($this->categories)."',
title = '".mysql_escape_string($this->title)."',
name = '".mysql_escape_string($this->name)."',
surname = '".mysql_escape_string($this->surname)."',
date = '".mysql_escape_string($this->date)."',
body = '".mysql_escape_string($this->body)."'
WHERE
id = '".mysql_escape_string($this->id)."'";
}
// W przeciwnym wypadku generujemy
// zapydanie wstawiające nowy wiersz do bazy
else{
$SQL = "INSERT INTO articles
(id, categories, title, name, surname, date, body) VALUES
(default,
'".mysql_escape_string($this->categories)."',
'".mysql_escape_string($this->title)."',
'".mysql_escape_string($this->name)."',
'".mysql_escape_string($this->surname)."',
'".mysql_escape_string($this->date)."',
'".mysql_escape_string($this->body)."')";
}
// Wykonujemy zapytanie
return mysql_query($SQL);
}
/** Funkcja kasuje wpis o obiekcie w bazie
* @return bool
*/
function Delete(){
if(!empty($this->id)){
/**
* zapytanie usuwające
*/
$SQL = "DELETE FROM articles WHERE
id = '".mysql_escape_string($this->id)."' LIMIT 1";
mysql_query($SQL);
return (bool)mysql_affected_rows();
}
return false;
}
www.phpsolmag.org 73
Techniki Active Record

Listing 4. Przykładowe uzupełnienie obiektów danymi z bazy W PHP4

W starszej wersji PHP4 brakuje funk-
$SQL = "SELECT * FROM articles ORDER BY name ASC"; cji magicznych (__set() oraz __get())
$RES = mysql_query($SQL); więc automatyczny lazy init nie
/** jest do wykonania. Cała reszta klasy
* przygotowujemy tablicę, do której będziemy wpisywać ActiveRecord jest podobna. Przy PHP w
* obiekty utworzone z nowo pobranych wierszy wersji do 4.2 funkcja get_class_vars()
*/ i get_object_vars() zachowuje się in-
$aArticles = array(); aczej – nie zwraca niezadeklarowanych
while($AFR = mysql_fetch_assoc($RES)){ zmiennych, dlatego trzeba im nadawać
$aArticles[] = new Article($AFR); wartości przy tworzeniu klasy (np. var
} $id = '';). Oczywiscie z przedrostków
/** private, protected, public, abstract itd.
* Aby sprawdzić, czy wynik naszej pracy musimy zrezygnować. To samo tyczy się
* jest poprawny, proponuję
wyjątków w konstruktorze – możemy je
spokojnie zastąpić funkcją die().
* użyć następującego kodu:
* echo '<pre>'.var_dump($aArticles, 1).'</pre>';
*/ jest naszym największym problemem.
Zauważmy, że w zapytaniu występu-
Listing 5. Implementacja klasy ArticleFinder odpowiedzialnej za pobieranie danych
je ciąg SELECT * – pobieramy wartości
i zwracanie obiektów typu Article
z wszystkich pól w bazie. Załóżmy teraz,
class ArticleFinder{ że nasze artykuły posiadają dużo treści.
// Zwraca tablicę obiektów typu Article, posortowanych wg nazwy Generując zwykłą listę do wyświetle-
// @param integer $iLimit
nia na stronie potrzebujemy co najmniej
// @param integer $iOffset
nazwy oraz id, a ewentualnie dodatko-
// @return array
function GetList($iLimit = false, $iOffset = false){ wo danych na temat autora lub daty do-
$SQL = "SELECT * FROM articles ORDER BY name ASC"; dania artykułu. Treść jest pożądana do-
// Doklejamy do zapytania limit i przesunięcie - jeśli podano piero w momencie, gdy nasz Czytelnik
if($iLimit!=false)
kliknie w link więcej i zdecyduje się na
$SQL .= "LIMIT ";
lekturę naszych wypocin. Nie mamy po-
if($iOffset != false ){
$SQL .= $iOffset.', '; trzeby pobierania zawartości pola body,
} bo nie jest ono używane. Moglibyśmy
$SQL .= $iLimit; zwyczajnie nie uzupełniać go, modyfi-
$RES = mysql_query($SQL);
kując zapytanie w następujący sposób:
// przygotowujemy tablicę, do której będziemy wpisywać
SELECT id, categories, title, name,
// obiekty utworzone z nowo pobranych wierszy
$aArticles = array(); surname ... Zauważmy jednak, co sta-
while($AFR = mysql_fetch_assoc($RES)){ ło by się, gdybyśmy przypadkowo wyko-
$aArticles = new Article($AFR); nali metodę Update() na nie uzupełnio-
}
nym do końca obiekcie. Wszystkie dane,
return $aArticles;
które są w bazie, ale nie zostały wpisa-
}
ne do obiektu zostały by nadpisane pu-
// Zwraca obiekt typu Article wypełniony danymi z bazy, o id podanym stymi wartościami. Na szczeście z po-
// w parametrze lub false w przypadku ,gdy nie znajdzie rekordu. mocą przychodzą funkcje __set() oraz
//
__get(), które otrzymaliśmy razem z 5
// @param integer $iId
odsłoną PHP. Usuńmy więc pole body ze
// @return Article
function FindById($iId){ zmiennych klasy Article (pozostają tyl-
$SQL = "SELECT * FROM articles WHERE id = ".mysql_escape_ ko zdefiniowane wcześniej id, title,
string((int)$iId)." LIMIT 1"; name, surname, date – wszystkie jako
$RES = mysql_query($SQL);
public). Następnie zmodyfikujmy zapy-
$AFR = mysql_fetch_assoc($RES);
tanie w funkcji GetList() wpisując zdefi-
if(!empty($AFR)){
return new Article($AFR); niowane w klasie pola, a pomijając body.
} Wykonajmy teraz kod odpowiedzialny za
return false; pobieranie listy artykułów. Otrzymuje-
}
my tablicę artykułów, w każdym uzupeł-
}
nione wszystkie pola oprócz body. O to
// Aby sprawdzić, czy wynik naszej pracy jest poprawny, proponuję nam chodziło, brakuje jeszcze tylko ob-
// użyć następującego kodu (mozna zastosować opcjonalne argumenty sługi brakującego pola. Do jej wykona-
// funckji GetList czyli limit oraz offset): nia użyjemy wyżej wspomnianych funk-
// $aArticles = ArticleFinder::GetList();
cji magicznych __get() oraz __set(),
// echo '<pre>'.var_dump($aArticles, 1).'</pre>';
sposób implementacji przedstawiono na
Listingu 6.

74 www.phpsolmag.org PHP Solutions Nr 4/2006

zamów prenumeratęPHP Solutions a otrzymasz prezent!
niższa cena: 135zł

w prezencie otrzymasz
Archiwum PHP Solutions 2005 w PDF

dodatkowo do wyboru:
» pakiet Xtreeme SiteXpert firmy Xtreeme
» dwa dowolne numery archiwalne PHP Solutions
» roczny abonament na Usługę Business Starter
» jedna z czterech książek z Wydawnictw Naukowo-Technicznych
» pakiet internetowy nQ.Biznes firmy Netlink o wartości 486,70 zł
» Maguma Workbench Core

* cena prenumeraty rocznej w promocji

oferta ważna do wyczerpania zapasów;

szczegółowe informacje: www.phpsolmag.org/prenumerata lub pren@software.com.pl

Techniki Active Record

Gdybyśmy w momencie, gdy pole zowanym polu body. Wszystko działa jak śmy na celu tego osiągnąć – należy więc
body nie zostało zainicjalizowane, za- powinno, dane są uzupełniane, a rezultat uważać, by nie wpaść w taką pułapkę,
żądali jego wartości, zostanie wykonana znakomity. Przemyślmy teraz następują- bo nasze cele zaoszczędzenia pracy ba-
metoda __get. W niej pobieramy, wpisu- cy przypadek. Pobieramy listę artykułów zy danych w bardzo prosty sposób mogą
jemy do obiektu oraz zwracamy brakują- pomijając pole body, a następnie w liście zadziałać zupełnie odwrotnie. Najłatwiej
cą wartość. Gdybyśmy natomiast spró- wyświetlamy dodatkowo skrót treści w poradzić sobie z tego typu problema-
bowali zmienić wartość pola body kiedy postaci np. echo substr($aArticle[$i]- mi monitorując ilość oraz treść zapytań
nie jest zainicjalizowane, klasa zajmie się >body, 0, 100). Okazuje się, że wyko- w trakcie przygotowywania aplikacji
pobraniem automatycznie starej wartości nujemy zapytanie pobierające listę. Za- (warto używać lub przygotować warstwę
i to na niej wykonywane będą zmiany. łóżmy 20 pozycji, a następnie wyświe- kontaktu z bazą danych, obsługującą
Przetestujmy pobraną uprzednio listę np. tlając je w pętli doczytujemy 20 razy po- monitorowanie zapytań).
używając strtoupper() na niezainicjali- le body – razem 21 zapytań. Nie mieli- Na początku mówiliśmy o mecha-
nicznej pracy, którą wykonujemy pisząc
zapytania, a w poprzednich przykładach
Listing 6. Implementacja metod __set oraz __get klasy Article – odpowiedzialne za
metoda Update() i tak zawierała kod
lazy init.
wpisany przez nas. Zmieńmy lekko przy-
function __get($field){ kład – klasa dalej będzie opisywać te sa-
me dane w bazie, będzie jedynie ina-
/** czej skonstruowana od strony technicz-
* Jeśli żądanie dotyczy pola body pobieramy jego wartość z bazy
nej tak, aby pozwolić programiście za-
*/
if($field=='body'){ pomnieć, jak pisze się zapytania wsta-
$SQL = "SELECT body FROM articles WHERE id = '".mysql_escape_ wiające, edytujące oraz usuwające wier-
string($this->id)."' LIMIT 1"; sze z bazy. Strukturę naszej tabeli mogli-
$RES = mysql_query($SQL); byśmy opisać w następujący sposób. Ta-
$AFR = mysql_fetch_assoc($RES);
bela znazywa się articles, zawiera pola
/**
* wpisujemy wartość do obiektu, aby przy kolejnych żądaniach nie o nazwach id, name, author, date oraz
* wywoływać już zapytań body przy czym pole id jest kluczem
*/ głównym, a pole body – treścią, którą nie
$this->body = $AFR['body']; zawsze chcemy pobierać, ponieważ nie
/**
zawsze jej potrzebujemy. Wpiszmy te da-
* Zwracamy nowo pobraną wartość
*/ ne do przykładowej klasy – Listing 7.
return $this->body; Logicznie rzecz biorąc, mamy
} wszystkie dane potrzebne do wygene-
} rowania zapytań modyfikujących da-
/**
ne w bazie. Przyjmijmy Listing 7 jako
* nadajemy wartość nie zainicjalizowanemu polu
*/ schemat implementacji klas dziedziczą-
function __set($field, $value){ cych z ActiveRecord. Wiemy, gdzie wpi-
$this->$field = $value; sywać, znamy nazwy pól, do których
} mamy wstawiać dane. Do tego wiemy,
jaki jest klucz główny (primary key) – to
Listing 7. Reimplementacja klasy Article
on potrzebny nam będzie, aby usuwać
class Article extends ActiveRecord{ oraz edytować poszczególne rekordy.
/** Zajmiemy się teraz przygotowaniem abs-
* nazwa tabeli, w której przechowywane są dane
trakcyjnej klasy ActiveRecord, która bę-
* @var string
*/
dzie odpowiedzialna za kontakt z bazą
protected $_tableName = 'Articles'; oraz czytanie danych w razie potrzeby,
/** czyli wspomniany wczesniej lazy init.
* klucz podstawowy; w 90% przypadków to pole 'id'. Przedstawia to Listing 8.
* Po wykonaniu zapytania wstawiajacego 'insert' zostanie
Kilka słów komentarza odnośnie tego
* wpisana wartość mysql_insert_id() do pierwszego z podanych poniżej;
* @var array
Listingu. Abstrakcyjna klasa ActiveRecord
*/ przechowuje nazwy zainicjalizowanych
protected $_pk = array('id'); pól @var array. Domyślny typ leniwej
/** inicjalizacji to AR_LAZY_ALL_AT_ONCE. Je-
* nazwy wszystkich pól w bazie danych
śli podamy: AR_ALL_AT_ONCE – po żądaniu
* @var array
*/
pola niezainicjalizowanego, wszystkie po-
protected $_fields = la z tabeli, które nie są zainicjalizowane,
array( 'id', 'title', 'name', 'surname', 'date', 'body' ); zostaną automatycznie pobrane.
} Warto jeszcze zaznaczyć, że może-
my chcieć przy doczytywaniu brakują-

76 www.phpsolmag.org PHP Solutions Nr 4/2006

 Metoda aktywnego rekordu Techniki

cego pola, doczytać od razu wszystkie,

Listing 8a. Klasa abstrakcyjna ActiveRecord które nie są jeszcze zainicjalizowa-
ne – do tego posłuży nam zmien-
<?php
define("AR_LAZY_ALL_AT_ONCE", 1); na _lazyType. Metody Update() oraz
define("AR_LAZY_PER_ONE", 2); Delete() zawarte w ActiveRecord pod-
abstract class ActiveRecord{ czas pobierania i odpowiedniego mani-
// Przechowuje nazwy pol ktore zostaly zainicjalizowane @var array pulowania danymi potrafią wygenerować
private $_initalized = array();
zapytania, których w dalszej części apli-
protected $_lazyType = AR_LAZY_ALL_AT_ONCE;
// w konstruktorze sprawdzamy poprawnosc klasy, kacji używa nasza klasa. Na szczególną
// ktora dziediczy po ActiveRecord. uwagę zasługują funkcje AfterSelect()
function __construct($param = null){ oraz BeforeQuery() – to je nadpisujemy
if(empty($this->_tableName)){ w klasach potomnych w celu poszerze-
throw new Exception('Nie zdefiniowano
nia funkcjonalności.
_tableName w klasie \''.get_class($this).'\'') ; }
if(empty($this->_pk)){ Pierwsza z nich, zgodnie ze swoją na-
throw new Exception('Nie zdefiniowano zwą, wywoływana jest po każdym zapy-
_pk w klasie \''.get_class($this).'\'') ; } taniu pobierającym dane. Co nam to da-
if(empty($this->_fields) or !is_array($this->_fields)){ je? Możemy po każdym pobraniu któ-
throw new Exception('Nie zdefiniowano
regoś z pól np. categories wykonać na
_fields w klasie \''.get_class($this).'\'') ; }
if(count($param)>0){ nim operację, dla przykładu explode()
$this->SetData($param); } } na przecinku, aby otrzymać tablicę
//wykonywana przy nie zainicjalizowanych zmiennych zawierającą kategorie, do których na-
//@param string $variable oraz @param mixed $value leży artykuł. Rozdzieloną według prze-
function __set($variable, $value){
cinka tablicę edytujemy, np. dodając do
if(!in_array($variable, $this->_initalized)
and in_array($variable, $this->_fields)){ niej kolejną kategorię (edytujemy działa-
$this->_initalized[] = $variable; } jąc na tablicach, a nie tak jak dane prze-
$this->$variable = $value; } chowywane są w bazie – czyli ciągu)
function __get($name){ i BeforeQuery() wykonuje implode(),
// jesli ustawiono primary keys, robimy lazy inicjalizację
a do bazy zapisuje się ciąg znaków, roz-
if($this->AllPrimeryKeyIsset() and in
_array($name, $this->_fields)){ dzielony przecinkami. Ułatwia to znacz-
// Pobiera wszystkie niezainicjalizowane, czy jeden nie życie w przypadku gdy mamy potrze-
if($this->_ bę modyfikacji danych podczas kontaktu
lazyType == AR_LAZY_ALL_AT_ONCE){ ze źródłem danych, a chcemy zapomnieć
$sFields = implode
o ograniczeniach, które niesie użycie ba-
(', ', $this->GetUninitalizedVars()); }
else{ $sFields = $name; } zy danych (płaskie przechowywanie).
Podany przykład dość prosto zilustrował
// musimy wiedziec, z ktorego rekordu dane pobrac problem – w bardziej skomplikowanych
foreach($this->GetPrimaryKeys() as $sKey=>$sVal){ przypadkach można użyć serialize – je-
$aKeys[] = $sKey.' = '.$this->BeforeQuery($sKey, $sVal); }
śli nie chcemy wprowadzać dodatkowych
$SQL = 'SELECT '.$sFields.' FROM '.$this->_
tableName.' WHERE '.implode(', ', $aKeys); relacji w bazie. Możemy też pokusić się
$RES = mysql_query($SQL); o nadpisanie w potomku metody
foreach(mysql_fetch_assoc($RES) as $sKey=>$sVal){ Delete(), która miałaby przykładowo kilka
$this->SetData(array($sKey => $sVal)); } zadań; najpierw ustawienie pola deleted
return $this->$name; } else{ return null; }}
w tabeli na status true, a dopiero po po-
// Zwraca tablicę, klucze to nazwy primary keys, wartosci to ich wartosci nownym wykonaniu oraz spełnionym wa-
function GetPrimaryKeys(){ runku if($this->deleted==true) usuwać
$mRet = array(); // przygotowyjemy array do zwrocenia całkowicie rekord z bazy. Bardzo łatwo
foreach ($this->_pk as $sVal){ moglibyśmy wygenerować w ten sposób
$mRet[$sVal] = $this->$sVal; }
znany wszystkim kosz.
return $mRet; }//sprawdza, czy primary klucze są ustawione
// @return bool Dobrym przykładem jest również
function AllPrimaryKeyIsset(){ przechowywanie danych na temat zu-
foreach ($this->_pk as $sVal){ ploadowanych plików w bazie. Przy usu-
if( !isset($this->$sVal) ){ return false; } } waniu rekordu z tabeli, stosujemy me-
return true; }
todę unlink() i zapominamy o ręcznym
// zwraca tablicę, jako klucze nazwy pól inicjalizowanych później, usuwaniu kasowanych plików. Dla
// wartości to przypisane do danych pól wartosci wiersza w bazie szczególnie leniwych, w konstruktorze
// @return string naszej klasy możemy sprawdzać, czy
function GetInitalizedVars(){ podana wartość jest tablicą (wtedy do-
return $this->_initalized; }
konujemy wpisania wartości) czy np.
liczbą i wykonywać finder::findById();

PHP Solutions Nr 4/2006 www.phpsolmag.org 77

Techniki Active Record

Listing 8b. Przykładowa implementacja klasy abstrakcyjnej ActiveRecord Listing 9. Przykładowe

zastosowanie SetData oraz Validate
// Wpisuje wartości tablicy do obiektu.
// @param array $arr oraz @return false null if(isset($_POST)){
function SetData($aArr){
foreach (@(array)$aArr as $sId=>$sVal){ // Tworzymy nowy obiekt
$this->__set($sId, $this->AfterSelect($sId, $sVal)); } } $oArticle = new Article();
// Zwraca wszystkie nie zainicjalizowane pola
// @return array // wpisujemy wartości
function GetUninitalizedVars(){ // z formularza
$aRet = array(); $oArticle->SetData($_POST);
foreach($this->_fields as $val){ // sprawdzamy czy są okey
if(!in_array($val, $this->_initalized)){ if($oArticle->Validate()){
$aRet[] = $val; } } return $aRet; } // jesli tak, wpisujemy
// Kasuje wiersz z bazy @return bool // do bazy
function Delete(){ $oArticle->Update();
/* jesli obiekt ma ustawione klucze glowne, czyli nie jest nowy, to }
* kasujemy go z bazy */ }
if($this->AllPrimeryKeyIsset()){
foreach($this->GetPrimaryKeys() as $sKey=>$sVal){
$aKeys[] = $sKey.' = '.$this->BeforeQuery($sKey, $sVal); }
$SQL = 'DELETE FROM '.$this->_tableName.' a ostatecznie przypisać wartości. Po-
WHERE '.implode(', ', $aKeys); branie wtedy rekordu o id równym 7
mysql_query($SQL); będzie wyglądało następująco: $article
return true; } = new article(7). MySQL 5 niesie ze
return false; }
sobą support przechowywania XML-a
function Update($forceInsert = false){
// jesli obiekt nie ma ustawionych kluczy glownych, nie jest nowy, to wewnątrz pól. Przy pobieraniu moż-
// wykonujemy insert w bazie na przeparsować dane, a przy insercie
if(!$this->AllPrimeryKeyIsset() or $forceInsert){ wstawić XML-a wygenerowanego przez
$aVals = array(); BeforeQuery(). Pomysłów i przykładów
foreach ($this->GetInitalizedVars() as $sID=>$sVal){
przytoczyć możnaby wiele, ogranicza
$aVals[$sVal] = $this->BeforeQuery($sID, $this->$sVal); }
// jesli jest co wstawiac nas jedynie własna pomysłowość.
if(count($aVals)){
$SQL = 'INSERT INTO '.$this->_tableName.' ('. Walidacja
implode(', ', array_keys($aVals)).') VALUES('. Nic nie stoi także na przeszkodzie przed
''.implode(', ', $aVals).')'; }
dodaniem metody – Validate(), która
else{ return false; } }
// jesli obiekt ma ustawione klucze glowne, czyli nie jest nowy to określałaby, czy dane w obiekcie nada-
// wykonujemy update w bazie ją się do wpisania do bazy. W połączeniu
else{ z metodoą SetData() mogą tworzyć na-
// przygotowujemy klucze do zapytania prawdę sprawne narzędzie – Listing 9.
foreach($this->GetPrimaryKeys() as $sKey=>$sVal){
W tym momencie warto zwrócić
$aKeys[] = $sKey.' = '.$this->BeforeQuery($sKey, $sVal); }
// przygotowujemy wartosci do zapytania, uwagę na dość istotną kwestię. Nig-
// update tylko tych zainicjalizowanych dzie w omawianym przykładzie nie uży-
foreach($this->GetInitalizedVars() as $sVal){ to nazw pól w bazie. Oznacza to, że do-
$aVals[] = $sVal.' = '.$this->BeforeQuery($sVal, $this->$sVal); danie w formularzu dodatkowego pola
} // jeśli jest co updatować
oraz uzupełnieniu o nie definicji obiek-
if(count($aVals)>1){
$SQL = 'UPDATE '.$this->_tableName.' SET tu i struktury bazy danych, to wszyst-
'.implode(', ', $aVals).' WHERE '.implode(', ', $aKeys); kie czynności wymagane do poszerze-
} else{ return false; } } nia zakresu działania naszego obiektu
mysql_query($SQL); – a przecież prawdopodobnie każdy
if(!$this->AllPrimeryKeyIsset() or $forceInsert){
z nas zna poszukiwania wszystkich za-
$AI = end(array_reverse($this->_pk));
$this->$AI = mysql_insert_id(); } return true; } pytań, w celu uzupełnienia o brakujące
function GetFields(){ return $this->_fields; } pole – tutaj problem znika.
function BeforeQuery($name, $value = null){ Nic nie stoi również na przeszko-
if(strtoupper($value) == 'NOW()') { dzie, aby po wykonaniu select zamie-
return 'NOW()'; }
niać przykładowe pole autor zawierają-
if(strtoupper($value) == 'DEFAULT') {
return 'default'; } ce id autora na obiekt user zawierający
return '\''.mysql_escape_string($value).'\''; } dane, które zapisane są w innej tabeli.
function AfterSelect($name, $value = null){ W metodzie BeforeQuery natomiast
return $value; }} możemy wykonać update na obiekcie
?>
user i zamienić ten obiekt z powrotem na
id, aby zachować zgodność zawartości.

78 www.phpsolmag.org PHP Solutions Nr 4/2006

 Metoda aktywnego rekordu Techniki

Listing 10. Przykładowe zastosowanie SetData oraz Validate Listing 11. Przykład użycia klasy
articleFinder
<?php
abstract class Finder{ class articleFinder extends Finder {
// pola do pobrania @var array private $tableName = 'articles';
protected $defaultfields = array('*'); }
protected $fields = null; protected $limit = 0; $finder = new articleFinder();
protected $offset = 0; protected $order = 0; $finder->SetWhere('name = '.'Nazwa');
protected $where = null; $finder->SetLimit(1);
public function SetWhere($sWhere){ $finder->Get();// zwróci tablicę
$this->where = $sWhere; } $finder->SetWhere('id = '.'1');
protected function GetWhere(){ $finder->GetOne();// zwróci obiekt
$aRet = $this->where;
$this->where = null;
return $aRet; }
public function SetLimit($iLimit){ Pobieranie danych
$this->limit = $iLimit; } W przypadku pobierania danych oraz
protected function GetLimit(){ uzupełniania obiektów – można iść dwie-
$aRet = $this->limit; ma drogami. Pierwsza z nich to przygo-
$this->limit = 0;
towywanie wszystkich kombinacji funk-
return $aRet; }
public function SetOffset($iOffset){ cji w finderach, czyli GetByCountry(),
$this->limit = $iLimit; } FindById(), FindByName(), FindByName-
protected function GetOffset(){ AndSurname(). Możemy również przygo-
$aRet = $this->offset; tować interfejs, podobny do tego z Listin-
$this->offset = 0;
gu 10.
return $aRet; }
public function SetFields($aFields){ W takiej sytuacji utworzenie nowe-
$this->fields = $aFields; } go findera to zazwyczaj kwestia doda-
protected function GetFields(){ nia extends Finder. Do dyspozycji ma-
if(empty($this->fields)){ my wówczas SetWhere(), SetLimit(),
return $this->defaultfields; }
SetOffset(), a dopisujemy tylko bar-
$aRet = $this->fields;
$this->fields = null; dziej skomplikowane zapytania, któ-
return $aRet; } re nie ograniczają się do użycia WHE-
function __construct(){ RE oraz LIMIT. Nic nie stoi na prze-
if(empty($this->tableName)){ szkodzie, aby rozwinąć funkcje, dodać
throw new Exception
obsługę tablic jako parametrów wej-
('Nie zdefiniowano tableName w klasie \''.get_class($this).'\'') ;
} } ściowych oraz czegokolwiek, co może
// zwraca tablice obiektów @return array ułatwić pracę.
function Get(){
$iLimit = $this->GetLimit(); Na koniec
$iOffset = $this->GetOffset();
Alternatywą dla Active Record jest
$where = $this->GetWhere();
$SQL = pakiet PEAR::DB_DataObject. Wyko-
'SELECT '.implode(', ',$this->GetFields()).' rzystuje on część z opisanych w ar-
FROM '.$this->tableName.' tykule technik i sprawdziłby się jako
'.( !empty($where)?('WHERE '.$where.'') : ('') ).' alternatywa dla naszej implementacji.
'.($iLimit > 0?('LIMIT '.$iLimit.','.$iOffset):'');
Zachęcamy jednak do samodzielnego
$RES = mysql_query($SQL);
$aRet = array(); ekperymentowania, co pozwoli na do-
while($AFR = mysql_fetch_assoc($RES)){ stosowanie narzędzia do naszych po-
$aRet[] = new $this->returnType($AFR); } trzeb, a nie odwrotnie. n
return $aRet; }
// @return object
function GetOne(){
$iLimit = $this->GetLimit();
$iOffset = $this->GetOffset();
$where = $this->GetWhere();
O autorze
$SQL =
'SELECT '.implode(', ',$this->GetFields()).' Jakub Sacha z php ma styczność od
FROM '.$this->tableName.' około 3-4 lat. Początkowo programowa-
'.( !empty($where)?('WHERE '.$where.'') : ('') ).' nie traktował jako pasję, ale aktualnie
LIMIT 1'; pracuje jako programista w bytomskiej
$RES = mysql_query($SQL); firmie NylonCoffee. Przepełnia go chęć
return new $this->returnType(mysql_fetch_assoc($RES));} rozwoju.
?> Kontakt z autorem: jakub@sacha.pl

PHP Solutions Nr 4/2006 www.phpsolmag.org 79

 www.buyitpress.com

Zaprenumeruj swoje ulubione magazyny

i zamów archiwalne numery!

Już teraz w kilka minut możesz zaprenumerować swoje ulubione pismo.

Gwarantujemy:
- preferencyjne ceny
- bezpieczną płatność on-line
- szybką realizację Twojego zamówienia
Bezpieczna prenumerata on-line wszystkich tytułów Wydawnictwa Software!
zamówienie prenumeraty

Prosimy wypełnić czytelnie i przesłać faksem na numer: (22) 887 10 11 lub listownie na adres: Software-Wydawnictwo Sp. z o.o.,
Piaskowa 3, 01-067 Warszawa, e-mail: pren@software.com.pl. Przyjmujemy też zamówienia telefoniczne: (22) 887 14 44

Imię i nazwisko............................................................................................ ID kontrahenta..........................................................................................

Nazwa firmy................................................................................................. Numer NIP firmy.......................................................................................

Dokładny adres....................................................................................................................................................................................................................

Telefon (wraz z numerem kierunkowym)................................................... Faks (wraz z numerem kierunkowym) ....................................................

E-mail (niezbędny do wysłania faktury)............................................................................................................................................................................

automatyczne przedłużenie prenumeraty

Tytuł
Ilość Od numeru Opłata
Ilość
zamawianych pisma lub w zł
numerów
prenumerat miesiąca z VAT
Software Developer’s Journal (1 płyta CD)
– dawniej Software 2.0 12 250/1801
Miesięcznik profesjonalnych programistów
SDJ Extra (od 1 do 4 płyt CD lub DVD)
– dawniej Software 2.0 Extra! 6 150/1352
Numery tematyczne dla programistów

Linux+ (2 płyty CD)

Miesięcznik o systemie Linux
12 199/1791

Linux+DVD (2 płyty DVD)

Miesięcznik o systemie Linux
12 199/1791

Linux+Extra! (od 1 do 7 płyt CD lub DVD)

Numery specjalne z najpopularniejszymi dystrybucjami Linuksa
8 232/1982

PHP Solutions (1 płyta CD)

Dwumiesięcznik o zastosowaniach języka PHP
6 135

Hakin9, jak się obronić (1 płyta CD)

Dwumiesięcznik o bezpieczeństwie i hakingu
6 135

.psd (1 płyta CD + film instruktażowy)

Dwumiesięcznik użytkowników programu Adobe Photoshop
6 140

Aurox Linux (4 płyty CD + 1 płyta DVD)

Magazyn z najpopularniejszym polskim Linuksem
4 1193

Suma

Jeżeli chcesz zapłacić kartą kredytową, wejdź na

stronę naszego sklepu internetowego:
1
Cena prenumeraty rocznej dla osób prywatnych
2
Cena prenumeraty rocznej dla osób prenumerujących już Software Developer’s Journal lub Linux+
3
Cena prenumeraty dwuletniej Aurox Linux
www.buyitpress.com
 W następnym numerze
PHP Solutions 5/2006(16)

TECHNIKI
PHPUnit2 – Testy aplikacji PHP są niezwykle ważne, a możliwo-
ści jakie niesie PHPUnit2 pozwolą zaoszczędzić wiele cennego
czasu, który możemy spożytkować na znacznie przyjemniejsze
rzeczy niż wyszukiwanie kolejnych błędów w naszym kodzie.
PHPUnit2 to kolejna odsłona doskonałego programu to wykony-
wania testów jednostkowych (ang. unit tests) naszych aplikacji.

XML w praktyce – Guillame Ponçon przedstawi nowe możli-

wości współpracy między PHP, a XML. Pokażemy m.in. Opera-
cje na dokumencie OpenOffice z wykorzystaniem SAX, czy od-
czytywaniu diagramu z ganttproject za pomocą SimpleXML.

NARZĘDZIA
TYPO3 – Jean-Gael Rouchon, jeden z deweloperów projektu,
przedstawi nam praktyczne wykorzystanie jednego z najważniej-
szych CMS-ów typu portalowego. Nowa, czwarta już wersja sys-
temu zaskakuje elastycznością, rozszerzalnością oraz ciekawym
frameworkiem, do tworzenia na bazie TYPO3 własnych aplikacji.

Test systemów CMS – Wybranie odpowiedniego systemu

CMS, to nie lada wyzwanie dla każdego dewelopera PHP.
W artykule dokonamy porównania najpopularniejszych syste-
mów i powiemy, których i w jakich zastosowaniach warto uży-
wać, a które należy omijać szerokim łukiem.

PROJEKTY
PHP-Qt – Aplikacje okienkowe w PHP? Pisaliśmy już o PHP-
GTK2, ale nikt nie przypuszczał, że PHP ożeni się z Qt...
Rozwiązanie już działa, a my pokażemy, jak wykorzystać je
w praktyce.

Ponadto planujemy: W sprzed

aży
od 15 sier
■
■
Mojavi
Winbinder
pnia!
■ DB2 i PHP
■ Video Streaming

■ MSSQL i PHP

oraz ciąg dalszy artykułów poświęconych bezpieczeństwu aplikacji oraz wy-

korzystaniu wzorców projektowych