Jak odczytywać definicję (prototyp) funkcji

Każda funkcja w podręczniku jest udokumentowana w formie skrótowej. Umiejętność jej odczytywania i rozumienia sprawi, że nauka PHP będzie znacznie prostsza. Zamiast kopiowaia gotowych przykładów, każdy powinien wiedzieć jak czytać definicje (prototypy) funkcji. Zaczynamy:

Informacja: Założenie: Podstawowe rozumienie typów

Pomimo iż PHP jest luźnie typowanem językiem, ważne jest podstawowe zrozumienie typów, bo mają one istotne znaczenie.

Definicja funkcji mówi nam jaki typ wartości jest zwracany. Użyjmy funkcji strlen(), jako naszego pierwszego przykładu:

strlen

(PHP 4, PHP 5)
strlen -- Określ długość ciągu tekstowego

Opis
int strlen ( string $string )

Zwraca długość podanego parametru ciąg.

Możemy przepisać definicję powyższej funkcji w sposób ogólny:

      zwracany typ    nazwa funkcji    ( typ argumentu   nazwa argumentu )

Wiele funkcji przyjmuje wiele parametrów, tak jak in_array(). Jej prototyp wygląda następująco:

      bool in_array ( mixed $igła, array $stóg_siana [, bool $ścisłe])

Co to oznaca? in_array() zwraca wartość boolean, TRUE przy powodzeniu (jeśli igła została znaleziona w parametrze stóg_siana lub FALSE w przypadku niepowodzenia (jeśli igła nie została znaleziona w parametrze stóg_siana). Pierwszy argument jest nazwany igła i może być różnych typów, więc nazywamy go "mixed". Parametr igła typu mixed (to, czego szukamy) może być typem skalarnym (string, integr lub float) lub tablicą. stóg_siana (tablica, którą przeszukujemy) jest drugim parametrem. Trzeci, opcjonalny parametr jest nazwany ścisłe. Wszystkie argumenty opcjonalne umieszczono w [ nawiasach klamrowych ]. Podręcznik podaje, że parametr ścisłe domyślnie ustawiony jest na wartość logiczną FALSE. Zapoznaj się ze stroną podręcznika dla odpowiedniej funkcji, aby dowiedzieć się jak działa.

Ponadto, znak & (ampersand) poprzedzający argument funkcji pozwala na podanie parametru przez referencję, jak pokazano poniżej:

       int preg_match ( string $pattern , string $subject [, array &$matches 
      [, int $flags = 0 [, int $offset = 0 ]]] )

W tym wypadku widzimy, że trzeci, opcjonalny parametr &$matches będzie przekazany przez referencję.

Istnieją także funkcje z bardziej złożoną informacją o wersji PHP. Weźmy html_entity_decode() jako przykład:

(PHP 4 >= 4.3.0, PHP 5)

Oznacza to, że ta funkcja jest dostępna od wydania PHP 4.3.0.