Wersja minimum

Niezbędne minimum, które należy umieścić na początku pliku index.php to trzy następujące linie:

<?php defined( '_VALID_MOS' ) or die( 'Zasób zastrzeżony' );
?>

Pierwsza linia wskazuje serwerowi, że ma do czynienia ze skryptem PHP. Skrypt ten uruchamiany jest przez inny - umieszczony w głównym katalogu Joomla, noszący taką samą nazwę - index.php.

Druga linia uniemożliwia bezpośrednie uruchomienie skryptu. Zawarta tu instrukcja powoduje, że serwer sprawdza, czy została zdefiniowana stała _VALID_MOS. Jej definicję zawiera właśnie plik index.php umieszczony w głównym katalogu serwisu. Jeśli wynik sprawdzianu będzie negatywny, a więc gdyby się zdarzyło, że ktoś zechce uruchomić ten plik bezpośrednio, to otrzyma komunikat, że nie ma prawa przeglądać zasobu, który usiłuje otworzyć. Ze względów bezpieczeństwa ważne jest, aby tej linii nie pominąć.

Wersja rozszerzona

Kod nagłówka pliku index.php może zawierać także komentarz z informacjami o skrypcie, jak poniżej:

<?php /* TwojaNazwaSzablonu - szablon dla Joomla 1.0.x 
   @version 1.0
   @package TwojaNazwaSzablonu
   @copyright (C) 2005 by Twoja Nazwa
   @license Nazwa licencji, jeśli publikujesz szablon 
*/
 
/* zapewnia, że ten plik zostanie odczytany tylko wówczas
   gdy zostanie wywołany przez nadrzędny plik,
   w którym zdefiniowana jest stała _VALID_MOS,
   chroni przed nieuprawnionym dostępem do pliku
*/  
defined( '_VALID_MOS' ) or die( 'Nie masz uprawnień, by przeglądać ten zasób.' );
?>

Komentarze są przeznaczone tylko dla programistów. Analizator języka usuwa je, a więc nie mają one żadnego wpływu na działanie programu. Tutaj zastosowane zostały komentarze wielowierszowe w stylu języka C. Komentarz taki rozpoczyna się parą znaków /* i kończy tymi samymi znakami, ale w odwrotnej kolejności: */. Między znakami nie może być żadnych odstępów. Takich komentarzy nie można również zagnieżdżać.

Jeśli chcesz umieścić komentarz zawarty tylko w jednej linii, możesz skorzystać z dwóch sposobów:

 #  to jest komentarz jednowierszowy
// to również jest komentarz jenowierszowy 

W obu przypadkach trzeba uważać, aby nie umieścić jakiegoś fragmentu komentarza w nowym wierszu (akapicie, po naciśnięciu klawisza ENTER). Efektem byłby najprawdopodobniej błąd w wykonaniu skryptu.

Uwagi, źródła

Jeżeli masz sugestie odnośnie treści lub chcesz zgłosić poprawki do tego rozdziału, skomentuj go albo umieść wiadomość na forum: Dokumentacja - Propozycje, zmiany, poprawki

Dziękujemy!

Stefan Wajda, Zespół Dokumentacji PCJ