PHP include od strony praktycznej

Autor: JANUZI

W wielu skryptach można spotkać podział na kilka różnych skryptów, które razem tworzą całość. Autor mógł zapisać je w jednym pliku, ale z jakiegoś powodu tego nie zrobił. Dlaczego ?

Utrzymanie kodu

Jednym z powodów jest łatwość utrzymania porządku w kodzie. Zamiast przeglądania kilkudziesięciu (lub nawet kilkuset) kilobajtów kodu wystarczy przypomnieć sobie nazwę pliku, w którym umieszczony został podany kawałek kodu. Co więcej, wgranie poprawionego kodu na serwer zajmie zdecydowanie mniej czasu.

Pamięć

Bardzo łatwo sprawdzić ile pamięci zabierze skrypt php (potrzebny do tego będzie na przykład xdebug). Im mniej pamięci, tym mniejsze prawdopodobieństo ujrzenia przez odwiedzających komunikatu o przekroczeniu limitu. Php podczas pracy analizuje kod (i umieszcza w pamięci tablicę ze zmiennymi). Robi to nawet gdy warunek logiczny nie jest spełniony. Jednak, gdy użyje się include i przeniesie kod do osobnego pliku, to php pominie ten fragment. Dzięki temu zmienne występujące w tym kodzie nie obciążą pamięci.

Szybkość oraz „dziel i rządź”

Za każdym razem cały kod jest przeglądany i analizowany pod kątem zgodności z „gramatyką” oraz „ortografią” języka php. Kod umieszczony w plikach dołączanych jest analizowany dopiero, gdy spełniony jest warunek jego dołączenia. Dzięki temu można pominąć sporo rzeczy nie używanych w danym momencie.

Dodatkowo pozwala to w łatwy sposób określić miejsce występowania błędu. Php jest wrażliwe na brak nawiasów czy średników. Czasami nie informuje o tych błędach pozostawiając pustą stronę. Jeżeli zmiany kodu dotyczyły tylko małego fragmentu, to znalezienie błędu zajmie krótką chwilę. Dla zmian dotyczących kilkuset miejsc w kodzie może to być dość trudne wyzwanie. Podzielenie kodu na części pozwoli określić, który z fragmentów wymaga analizy i poprawienia.

Uwagi

Jak zwykle należy działać z umiarem. Podzielenie kodu na kawałki, gdy ma on 50 linii i jeden warunek, będzie mijało się z celem. Dopiero przy większych skryptach warto zastanowić się, czy podzielić kod.

Należy także pamiętać o tym, że kod dołączony zachowuje się tak, jakby był w katalogu „rodzica”. Dlatego też przy podawaniu adresu względnego do kolejnych dołączeń należy podawać adres względem „rodzica”. Przykładowo:
index.php dołącza kod include/test.php. W test.php jest linia include( 'test2.php’ ) ; Będzie to poprawne jedynie wtedy, gdy test2.php znajdzie się w tym samym katalogu co index.php.

Warto także rozpatrzyć odpowiednie komentowanie kodu. Każda z części po opisaniu może zostać podana do narzędzi takich jak doxygen. Dzięki temu uzyskamy dokumentację przydatną przy dalszych pracach.