VYSOKÉ UČENÍ TECHNICKÉ V BRNĚ BRNO UNIVERSITY OF TECHNOLOGY

VYSOKÉ UČENÍ TECHNICKÉ V BRNĚ BRNO UNIVERSITY OF TECHNOLOGY

FAKULTA STROJNÍHO INŽENÝRSTVÍ ÚSTAV AUTOMATIZACE A INFORMATIKY FACULTY OF MECHANICAL ENGINEERING INSTITUTE OF AUTOMATION AND COMPUTER SCIENCE

LADÍCÍ TŘÍDA PRO PHP DEBUGGING CLASS FOR PHP

BAKALÁŘSKÁ PRÁCE BACHELOR THESIS

AUTOR PRÁCE

JAKUB KLUVÁNEK

AUTHOR

VEDOUCÍ PRÁCE SUPERVISOR

BRNO 2011

ING. JAN ROUPEC, PH.D.

Vysoké učení technické v Brně, Fakulta strojního inženýrství Ústav automatizace a informatiky Akademický rok: 2010/2011

ZADÁNÍ BAKALÁŘSKÉ PRÁCE student(ka): Jakub Kluvánek který/která studuje v bakalářském studijním programu obor: Aplikovaná informatika a řízení (3902R001) Ředitel ústavu Vám v souladu se zákonem č.111/1998 o vysokých školách a se Studijním a zkušebním řádem VUT v Brně určuje následující téma bakalářské práce: Ladící třída pro PHP v anglickém jazyce: Debugging Class for php Stručná charakteristika problematiky úkolu: Třída by měla umožňovat přehledný výpis hodnot proměnných, zachytávat chyby a vyjímky a zobrazovat podrobné informace o tom kde k chybě došlo, tyto chyby logovat a zasílat upozornění emailem. Dále by třída měla umožňovat odhalit pomalá místa v aplikaci. Cíle bakalářské práce: Vytvořit snadno použitelnou univerzální třídu, která bude usnadňovat vývoj a ladění aplikací psaných v PHP a umožňovat odhalit pomalá místa v těchto aplikacích.

Seznam odborné literatury: Andi Gutmans, Stig Saether Bakken, Derick Rethans - Mistrovství v PHP 5 1. vyd. Brno: CP Books, 2005. 655 s. ISBN 80-251-0799-X. George Schlossnagle - Pokročilé programování v PHP 5 1. vyd. Brno: Zoner Press, 2004. 640 s. ISBN 80-86815-14-5 David Sklar - PHP 5 - moduly, rozšíření a akcelerátory 1. vyd. Brno: Zoner Press, 2005. 341 s. ISBN 80-86815-19-6 Peter Lavin - PHP - Objektově orientované 1.vyd. Praha: Grada Publishing, 2009 224 s. ISBN 978-80-247-2137-8

Vedoucí bakalářské práce: Ing. Jan Roupec, Ph.D. Termín odevzdání bakalářské práce je stanoven časovým plánem akademického roku 2010/2011. V Brně, dne 18.10.2010 L.S.

_______________________________ Ing. Jan Roupec, Ph.D. Ředitel ústavu

_______________________________ prof. RNDr. Miroslav Doupovec, CSc. Děkan fakulty

Strana 5

ABSTRAKT Cílem této práce je vytvořit pomůcku, která bude pomáhat při vytváření a ladění PHP aplikací. Práce rovněž obsahuje přehled toho, jak se v PHP zachází s chybami a výjimkami standardním způsobem. Výsledkem je snadno použitelná třída, která je snadno rozšiřitelná o další funkčnost a obsahuje všechny základní nástroje užitečné při vývoji. Další, neméně důležitou funkcí, této ladící třídy je část, která zpracovává chyby na produkčním serveru. Tato část je nezbytná, protože uživateli by se neměly zobrazovat detailní informace o chybě. Chyby totiž můžou obsahovat citlivé informace (především hesla do databáze, strukturu tabulek,...). Třídu již sám v praxi používám na několika projektech a ukázala se velmi přínosnou.

ABSTRACT The aim of this work is to create a tool that assists in developing and debugging PHP applications. It also provides an overview of how PHP handles errors and exceptions in a standard way. The result of this bachelor thesis is easy to use class that is easily extendable for additional functionality and contains all basic tools useful in development. This functions is necessary because users should not view some detailed information about the error. Errors may contain sensitive information (especially passwords for the database, table structure,...). I am using this class in several projects and it seems to be very useful.

KLÍČOVÁ SLOVA PHP, ladění, chyby, výjimky, zachytávání chyb, zachytávání výjimek

KEYWORDS PHP, debugging, errors, exceptions, errors handling, exceptions handling

Strana 7

Obsah: Zadání závěrečné práce...................................................................................................3 Abstrakt............................................................................................................................5 1 Úvod..................................................................................................................................9 1.1 Co to je ladící třída..........................................................................................................9 1.2 Proč jsem naprogramoval vlastní ladící třídu..................................................................9 2 Chyby a výjimky v PHP................................................................................................11 2.1 Chyby............................................................................................................................11 2.1.1 Zachytávání chyb....................................................................................................................12

2.2 Výjimky.........................................................................................................................12 2.2.1 Probublávání výjimek..............................................................................................................13 2.2.2 Zachycení nezachycených výjimek.........................................................................................14

2.3 Alternativní způsoby práce s chybami..........................................................................14 2.4 Konstrukce or xxx.........................................................................................................15 2.5 Ignorování chyb (scream operátor)...............................................................................15 3 Stávající řešení...............................................................................................................17 3.1 Xdebug..........................................................................................................................17 3.2 Nette\Diagnostics\Debugger (Laděnka)........................................................................19 3.3 PHPDebug.....................................................................................................................20 4 Jádro ladící třídy...........................................................................................................21 4.1 Šablonový systém..........................................................................................................21 4.2 Sloučení do jednoho souboru........................................................................................22 4.3 Produkční a vývojové prostředí.....................................................................................22 4.4 Javascript.......................................................................................................................22 5 Bug buster......................................................................................................................23 5.1 Výpis proměnných........................................................................................................23 5.1.1 Firebug.....................................................................................................................................24

5.2 Zpracování chyb a výjimek...........................................................................................25 5.2.1 5.2.2 5.2.3 5.2.4 5.2.5 5.2.6 5.2.7

5.3 5.4 5.5 5.6 5.7 5.8 5.9 6

Chyby......................................................................................................................................25 Akce při chybě.........................................................................................................................26 Přeložení chyby na výjimku....................................................................................................26 Výjimky...................................................................................................................................26 Akce při výjimce.....................................................................................................................27 Ignorování chyb.......................................................................................................................27 Zobrazení zdrojového kódu.....................................................................................................27

Provoz na produkčním serveru......................................................................................28 Značkování v kódu (flags).............................................................................................28 Sledování proměnných..................................................................................................29 Logování........................................................................................................................30 Stopky............................................................................................................................30 Počítadlo........................................................................................................................30 Plovoucí informační panel............................................................................................31 Závěr...............................................................................................................................33 Seznam použité literatury.............................................................................................35

Strana 9

1 1.1

ÚVOD Co to je ladící třída

Ladící třída by měla především usnadňovat vývoj aplikací. Měla by umět přehledně zobrazovat různé proměnné, zachytávat chyby a výjimky, zobrazovat k nim další informace (aktuální kontext aplikace), případně na ně upozornit emailem. Každý vývojář má své specifické požadavky. Ne všechny lze jednoduše splnit. Chyby v aplikacích se budou vyskytovat vždy. I kdyby byl kód naprosto dokonalý, vždy může selhat nějaká externí aplikace, nepůjde se připojit do databáze, dojde místo na disku atd. Se všemi těmito chybami musí vývojář počítat. Pokud ošetření některého případu přesto opomene, je žádoucí, aby se o chybě co nejrychleji dozvěděl. Na druhé straně problému je bezpečnost aplikace. Rozhodně není žádoucí, aby se návštěvníkovi stránky zobrazovala jakákoliv detailní chybová zpráva. Chybové zprávy mohou obsahovat informace o struktuře aplikace, případně i přihlašovací údaje k databázi. Vývojáře aplikace ale takové informace přesto zajímají. Ladící třídy je obvykle řeší tak, že uživateli zobrazí pouhou chybovou zprávu, že došlo k nějaké chybě, a detailní informace o ní někam zapíší. V ideálním případě odešlou vývojáři informativní zprávu například emailem. Součástí většiny frameworků je nějaká forma ladící třídy. Usnadňuje práci s frameworkem a většinou obsahuje nějakou formu logovací konzole. Většina těchto ladících tříd je však s frameworkem úzce spjata a nelze je použít mimo něj.

1.2

Proč jsem naprogramoval vlastní ladící třídu

Žádná ze současných ladících tříd mi plně nevyhovovala. Především v nich chyběla podpora modifikátorů a možnost zavolat si nějakou funkci při zachycení chyby určitého typu. Proto jsem se rozhodl napsat si ladící třídu sám. V některých jsem se inspiroval a svou ladící třídu naprogramoval tak, aby fungovala podobně. K tomu jsem přidal několik svých vylepšení a celé to zabalil do jedné snadno použitelné třídy. Upravovat kteroukoliv z nich by bylo příliš pracné (snažit se porozumět cizímu kódu,...), ale hlavním mým osobním cílem bylo porozumět lépe chování chyb a výjimek v PHP aplikacích. Pracovně jsem tuto ladící třídu nazval Bug Buster.

Strana 11

2

CHYBY A VÝJIMKY V PHP

V následující části se zmíním o chování chyb a výjimek v PHP. Všechny informace jsou platné pro PHP ve verzi 5. Se staršími verzemi se prakticky už nelze setkat.

2.1

Chyby

Chyby v PHP jsou ve většině případů vyvolány vnitřními funkcemi PHP. Jejich chování ale není příliš sjednocené v rámci všech funkcí. Chyby se v PHP děli na několik úrovní. Každá úroveň má definovanou svou konstantu, která se dá použít při nastavení zobrazování chyb [1],[3]:  E_ERROR - kritická chyba (nedostatek paměti, nezachycené výjimky,...)  E_WARNING - varování (chybějící argumenty funkce, absence databáze, dělení nulou,...)  E_PARSE - chyba během kompilace (chyba v syntaxi)  E_STRICT - upozornění na možnou dopřednou nekompatibilitu kódu  E_NOTICE - upozornění na možnou chybu (použití nedefinované proměnné,...)  E_DEPRECATED - upozornění na zavrhnuté funkce (většinou z bezpečnostních důvodů)  E_CORE_ERROR - chyba generovaná jádrem PHP  E_CORE_WARNING - varování generované jádrem PHP  E_COMPILE_ERROR - chyba vzniklá během kompilace (podobná E_PARSE)  E_COMPILE_WARNING - varování vzniklé během kompilace  E_RECOVERABLE_ERROR - speciální chyba, ze které se dá zotavit (pokud není zachycena error handlerem, je převedena na chybu E_ERROR)  E_USER_ERROR - uživatelsky definovaná chyba (způsobí také zastavení běhu skriptu)  E_USER_WARNING - uživatelsky definované varování  E_USER_NOTICE - uživatelsky definované upozornění  E_USER_DEPRECATED - uživatelsky definovaná upozornění na zavrženou funkci  E_ALL - zahrnuje všechny tyto konstanty dohromady s výjimkou E_STRICT Každá z těchto úrovní se chová odlišně. Například chyba při kompilaci způsobí okamžité ukončení skriptu. Takové chyby nelze zachytávat. Rovněž některé chyby (E_ERROR) způsobí ukončení skriptu. Některé se dají ale přesto zachytit (použití nedefinované funkce). Chyby typu E_WARNING vznikají za běhu skriptu (například otevření neexistujícího souboru) a nezpůsobí ukončení skriptu. Ukončení nezpůsobí ani chyby typu E_NOTICE (například použití nedefinované konstanty) nebo použití zavrhnuté funkce - E_DEPRECATED (např. funkce pro práci s POSIXovými regulárními výrazy - ereg*()).

Obr. 1 Chyby úrovně E_NOTICE, E_WARNING, E_ERROR, E_PARSE a E_DEPRECATED v PHP (bez rozšíření) Hlavní nevýhodou chyb oproti výjimkám je to, že se dají snadno ignorovat. Stačí k tomu pouhé nastavení konfigurační direktivy display_errors na off. Poté se nebudou zobrazovat žádná chybová hlášení. Pokud však dojde k chybě, která ukončí běh skriptu, nezobrazí se pravděpodobně

Strana 12

2 Chyby a výjimky v PHP

vůbec nic (záleží na tom, zda webový server již zaslal prohlížeči nějaká data). Další možností filtrování chyb je použití funkce error_reporting() (je to alternativa ke konfigurační direktivě error_reporting), pomocí které lze nastavit, které úrovně chyb se budou zobrazovat. Jako hodnotu lze předat i E_ALL, což znamená všechny úrovně chyb. Chyby můžeme vytvářet také ručně. Pro tyto účely jsou zavedeny další úrovně E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE, E_USER_DEPRECATED. K tomu slouží funkce trigger_error(), kterou když zavoláme, tak je vyvolána chyba zvolené úrovně se zadanou chybovou zprávou. 2.1.1

Zachytávání chyb

Chyby lze v PHP zachytávat v zásadě dvěma způsoby. Buď přímo funkcí na zachytávání chyb (error handlerem), nebo pomocí funkce, která se volá při ukončení skriptu (shutdown handlerem). Error handler se nastavuje zavoláním funkce set_error_handler(). Jako parametr slouží název funkce, která se zavolá při vyvolání chyby. Této volané funkci se jako parametry předává kód chyby, její popis a název souboru s řádkem, na kterém došlo k chybě. Tímto způsobem však nelze zachytávat chyby úrovně E_ERROR a všech dalších, které způsobí ukončení skriptu. Pomocí druhé možnosti (shutdown handleru) lze zachytit i některé chyby úrovně E_ERROR. Jako příklad lze použít volání nedefinované funkce. V shutdown handleru si pomocí funkce error_get_last() zjistíme, zda na stránce došlo k chybě. Poté detaily o této chybě můžeme opět zpracovat pomocí stejné funkce jako v předchozím případě.

2.2

Výjimky

Výjimky tvoří nedílnou část moderního programování v PHP. Již málokdo tvoří v PHP bez použití objektů. A právě zde přichází na řadu výjimky. Výjimka samotná je objekt, který má svůj název a několik metod na získání chybové zprávy atd. Pro správné chování musí mít výjimky společného předka - výjimku Exception. Proto pokud chceme definovat výjimku vlastní, tak ji musíme od této třídy také odvodit. Výjimky lze vyvolat (vyhodit) tak, že v kódu uvedeme: throw new Exception('Exception message');

Př 1. Vyvolání výjimky Pokud tak učiníme, objeví se nám zpráva podobná chybě (Obr. 2 ). Chybová zpráva je navíc obohacena o tzv. backtrace. Backtrace je seznam aktuálních aktivních volání funkcí v daném skriptu. Například když funkce a() zavolá funkci b(), tak v backtrace najdeme obě tyto funkce. Backtrace většinou obsahuje i informace o předaných parametrech té dané funkci.

Obr. 2 Nezachycená výjimka v PHP (bez rozšíření) Výjimky mají oproti chybám tu výhodu, že je nelze nijak jednoduše ignorovat pouhým nastavením nějaké konfigurační direktivy. Vždy je třeba se s nimi vypořádat přímo v kódu. Nejsprávnější postup je použití dvojice try-catch, která je obdobná jako například v jazycích C. $array = array(NULL, 0, 3, 4, 5); $a = $array[rand(0, 4)]; try { if($a === NULL) throw new InvalidArgumentException('Parametr nesmí být NULL'); if($a == 0)

2 Chyby a výjimky v PHP

Strana 13

throw new Exception('Dělení nulou!'); $b = 300 / $a; echo 'Konec bloku try.
'; } catch(InvalidArgumentException $e) { echo 'Výjimka: '.$e->getMessage(); die; } catch(Exception $e) { echo 'Zachycená výjimka: '.$e->getMessage().'
'; $b = 6; } echo '$b = '.$b;

Př 2. Zachycení různých výjimek Tento kód bude náhodně generovat různé výjimky nebo jeho vykonání projde v pořádku. V kódu jsou vidět dvě hlavní části. První je část try, druhá část catch. V části try se provádí kód, který může vyvolat výjimku (i volání nějaké funkce, která výjimku vyvolává). V příkladu jsou použity dvě různé výjimky pro demonstraci možností zachytávání výjimek. To se děje v sekcích catch. Každá z nich je určena jednomu typu výjimek. Při zachytávání výjimek se používá principu dědičnosti tříd. Pokud bychom tedy vynechali v příkladu část, kde se zachycuje výjimka InvalidArgumentException, byla by zachycena v druhém bloku catch, protože výjimka InvalidArgumentException dědí z výjimky Exception. Po zpracování kódu a případném zachycení výjimky skript pokračuje dále v činnosti (pokud v části catch neukončíme skript například příkazem die). Výhodou je, že nemusíme ošetřovat každou chybu zvlášť, ale můžeme to udělat až pohromadě. Skript navíc může při výskytu nějaké nefatální chyby (např. nenačtení počítadla) pokračovat dál v činnosti. Pokud nezachytíme výjimky v bloku catch, dochází k chybě, kdy je nezachycená výjimka zobrazena (Obr. 2 ). To je způsobeno buď chybnou logikou aplikace, nebo leností programátora, který nepochopil výjimky a používá je stejně jako chyby. Velkou nevýhodou PHP je to, že ho nelze nijak přepnout tak, aby vestavěné funkce vyvolávaly výjimky místo chyb (alespoň v současné verzi PHP 5 toto nelze provést). O to se musíme postarat sami. 2.2.1

Probublávání výjimek K probublávání výjimky dochází v případě, kdy ji ve funkci nezachytíme.

function funkce1() { throw new InvalidArgumentException('Text chyby'); } function funkce2() { try { funkce1(); } catch(IOException $e) { die('IO Exception'); } } try { funkce2(); } catch(Exception $e)

Strana 14

2 Chyby a výjimky v PHP

{ die($e->getMessage()); }

Př 3. Probublávání výjimky V ukázce je vidět, že funkce1() zachytávání neřeší vůbec. Výjimka tedy postoupí do volající funkce2(). V ní se sice zachycení výjimky řeší, ale nezachytí se výjimka InvalidArgumentException. Proto se postoupí ještě do vyšší úrovně (samotného skriptu), kde se již výjimka zachytí. Pokud by ani na této úrovni nedošlo k zachycení výjimky, vznikne nezachycená výjimka, což způsobí chybu úrovně E_ERROR a následné ukončení běhu skriptu. 2.2.2

Zachycení nezachycených výjimek

U výjimek je jejich zachytávání podstatně snažší, než je tomu u chyb. Podobně jako u chyb máme k dispozici exception handler. Nastavíme ho zavoláním funkce set_exception_handler(). Poté jsou všechny nezachycené výjimky předány naší funkci a je jen na ní, jak s nimi bude zacházet. Při detekci první nezachycené výjimky (i když je zachycena exception handlerem) dochází k ukončení běhu skriptu podobně jako je tomu u chyby úrovně E_ERROR.

2.3

Alternativní způsoby práce s chybami

V dřívějších dobách (u verzí 4 a starší) se pracovalo s chybami tak, že se vytvořil cyklus dowhile, který proběhl pouze jednou. V případě výskytu chyby se z cyklu poté dá přejít do bezpečné části (za cyklus) pomocí příkazu break. Řešení je to podobné dvojici try-catch. Alternativou k Př 2. může tedy být následující řešení: $array = array(NULL, 0, 3, 4, 5); $a = $array[rand(0, 4)]; $error = NULL; $errorText = ''; do { if($a === NULL) { $error = 'invalid_argument'; $errorText = 'Parametr nesmí být NULL'; break; } if($a == 0) { $error = 'division_zero'; $errorText = 'Dělení nulou!'; break; } $b = 300 / $a; echo 'Konec bloku do..while.
'; } while(false); if($error == 'invalid_argument') { echo 'Chyba: '.$errorText; die; } elseif($error == 'division_zero') { echo 'Dělení: '.$errorText; die;

2 Chyby a výjimky v PHP

Strana 15

} echo '$b = '.$b;

Př 4. Práce s chybami v cyklu do-while

2.4

Konstrukce or xxx Velice zajímavou a netradiční konstrukcí pro ošetřování chyb je konstrukce or xxx [2].

$a = mysql_query('SELECT * FROM tabulka') or die('Chyba v SQL.');

Př 5. Použití konstrukce or die(); Pokud je výraz před klíčovým slovem or vyhodnocen jako false, je zavolán výraz následující. Nejčastěji klíčové slov or následuje funkce die(). Ale lze ji nahradit za jakoukoliv jinou. $a = mysql_query('SELECT * FROM tabulka') or print('Chyba v SQL');

Př 6. Použití konstrukce or print();

2.5

Ignorování chyb (scream operátor)

Chyby je v PHP možné i ignorovat. Slouží k tomu operátor @ (scream). Pokud ho uvedeme před voláním funkce, tak je chyba generovaná tou funkcí ignorována. Ignorovány jsou jak vestavěné chyby, tak ty uživatelsky generované. Lze jej však použít pouze pro potlačení zobrazení chyby. Pokud dojde k chybě, která ukončí běh skriptu, tak dojde k jeho ukončení i při použití tohoto operátoru. Error handler bude zavolán i když je použit scream operátor. Odhalit použití scream operátoru v error handleru je možné díky tomu, že při jeho použití je dočasně snížena úroveň oznamování chyb na nulu (error_reporting() == 0) $a = @file_get_contents('unknownfile.txt');

Př 7. Použití scream operátoru

Strana 17

3 3.1

STÁVAJÍCÍ ŘEŠENÍ Xdebug

Xdebug je rozšíření PHP, které slouží pro ladění PHP aplikací. Ne vždy je však k dispozici a jeho instalace je někdy složitá. Po jeho instalaci začne sám obsluhovat všechny chybové hlášky. Velkou výhodou Xdebugu je jeho vysoká konfigurovatelnost [6]. Téměř vše se dá nastavit v souboru php.ini (což může být nevýhoda, pokud k němu nemáme přístup a funkce ini_set() je zakázaná).

Obr. 3 Chyby úrovně E_NOTICE, E_WARNING, E_ERROR, E_PARSE a E_DEPRECATED v PHP s použitím rozšíření Xdebug Na Obr. 3 je vidět, že většina chybových hlášek obsahuje i backtrace. V závislosti na konfiguraci Xdebugu si zde můžeme nechat vypsat i vybrané superglobální proměnné, případně proměnné v aktuálním kontextu chyby.

3 Stávající řešení

Strana 18

Obr. 4 Nezachycená výjimka v PHP s rozšířením Xdebug Xdebug obsahuje také profiler, který zapisuje data do souboru. Tento soubor poté můžeme analyzovat pomocí nějakého nástroje (například WinCacheGrind) a odhalit tak nejpomalejší místa v aplikaci.

Obr. 5 WinCacheGrind s načteným výpisem z Xdebugu Xdebug lze rovněž připojit na některá vývojová prostředí, která mají jeho podporu implementovánu (Netbeans, Eclipse,...). Poté lze v těchto prostředích nastavit breakpointy (místa, na kterých se vykonávání kódu zastaví, dokud není vývojářem povoleno pokračování) a kód krokovat stejně jako programy např. v jazycích C.

3 Stávající řešení

Strana 19

Obr. 6 Ladění aplikací v Netbeans s pomocí Xdebugu

3.2

Nette\Diagnostics\Debugger (Laděnka)

Nette framework je známý PHP framework od českého programátora Davida Grudla [5]. Součástí tohoto frameworku je také ladící třída - Laděnka. Laděnka byla tím základním impulsem a největší inspirací pro tvoru vlastní ladící třídy. Obsahuje spoustu zajímavých a užitečných funkcí. Od zachytávání chyb a výjimek (a upozorňování na ně emailem) až po jednoduché stopky, výpis proměnných,... Součástí Laděnky je rovněž profiler, který je použitelný s Nette frameworkem. Tento framework nepoužívám, proto jsem neměl možnost tento profiler vyzkoušet.

Obr. 7 Výjimka v Laděnce

3 Stávající řešení

Strana 20

Na Obr. 7 je vidět ukázka zachycené výjimky právě pomocí Laděnky. Obsahuje jak základní informace o chybě/výjimce (název + popisek) tak detailnější informace o místu vzniku chyby (backtrace, hlavičky dotazu a odpovědi, superglobální proměnné,...).

3.3

PHPDebug

PHPDebug funguje na odlišném principu než Laděnka. Na každé stránce vypíše malý panel v pravém horním rohu. Po kliknutí na některou z jeho záložek se zobrazí více informací o dané sekci. Vypsat lze rovněž superglobální proměnné, dokáže odeslat html kód k validaci a obsahuje log konzoli. Do ní lze zapisovat z PHP jakékoliv zprávy. Ke zprávě je připojen název souboru a řádek, ze kterého se logování provedlo.

Obr. 8 Log konzole v PHPDebugu

Strana 21

4

JÁDRO LADÍCÍ TŘÍDY

Mým původním cílem bylo vytvořit ladící třídu tak, aby byla v jednom souboru. Postupem času se ale třída zvětšovala a bylo třeba ji rozdělit na několik podtříd. Přesto se ale povedlo zachovat stejný přístup k jednomu statickému objektu s názvem Debug. Objekt je statický, proto mu poté není třeba vytvářet instanci (ve skutečnosti se objektu vytvoří instance při spuštění PHP skriptu, která je platná až do jeho ukončení). Navíc je potom dostupný i v shutdown handleru, kde bychom museli jinak jeho instanci při výskytu chyby znovu vytvářet. Rozhodl jsem se pro řešení, které by zachovalo stávající API třídy a přitom umožňovalo neomezené rozšiřování do budoucnosti pouze s jednoduchou úpravou. Základem je třída Debug, která má metodu __callStatic(), ta teprve volá patřičné podtřídy. To, která metoda je v které podtřídě zařazena určuje pole, které má následující strukturu: $subClasses = array('SubClassName' => array('method1', 'met2'));

Př 8. Struktura podtříd Tento způsob má několik velkých výhod. Největší výhodou je to, že i když je třída rozdělená do několika podtříd, které spolu zdánlivě nijak nesouvisí, tak se všechny chovají jako metody objektu Debug. Některé podobjekty lze tedy použít i samostatně bez ostatních podtříd. Další výhodou je ta vlastnost, že celou třídu lze snadno vypnout. Proto jsem zavedl proměnnou $isOn, která má výchozí hodnotu true. Pokud se nastaví na false, metoda __callStatic(), která se stará o volání metod v podtřídách, bude vracet pouze hodnotu NULL a nebude je tedy volat. Zajímavou výhodou je možnost třídu rozšiřovat o další metody pouhým vytvořením funkce se správným názvem. Pokud totiž zavoláme na objektu Debug metodu nedefinovanaMetoda(), zjistí se, jestli existuje funkce s názvem kdebug_prototype_nedefinovanaMetoda() a pokud ano, tak se zavolá. Z tohoto důvodu jsou také téměř všechny metody i proměnné v podobjektech veřejné (aby se mohly volat z těchto rozšiřujících funkcí).

4.1

Šablonový systém

Postupem času vznikla potřeba oddělit HTML kód od PHP kódu. K tomu je obvykle v praxi nejsnazší použít nějaký hotový šablonovací systém (například Smarty nebo Dwoo). Ladící třídu jsem však nechtěl stavět na něčem, co je tak komplexní jako například Smarty. Většinu funkcí bych v celém projektu nevyužil. Vytvořil jsem proto velice jednoduchý šablonovací systém. Celý je obsažený v podtřídě Debug_Tpl a vejde se do pouhých 99 řádků kódu. Jeho jádrem jsou 2 hlavní metody. První s názvem assign() přiřadí do šablony proměnnou. Druhá s názvem fetch() vrátí zpracovaný obsah šablony. Metoda fetch() nejdříve projde všechny přiřazené proměnné a přichystá je do nacachované verze šablony. Poté v šabloně nahradí složené závorky za otevírací resp. uzavírací tagy PHP () a dvojici {$ za {foreach($test as $test):} {if($test != 3)} {$test}
{endif;} {endforeach;}