Ako čítať definíciu funkcie (prototyp)

Každá funkcia je zdokumentovaná v informačnej príručke; znalosť, ako sa má manuál čítať a rozumieť, používanie PHP značne ulahší. Namiesto odvolávania sa na príklady alebo vystrihnúť/vložiť, chcete radšej vedieť ako čítať definície funkcií (prototypy). Začnime:

Nevyhnutná podmienka: Základná interpretácia typov: I keď PHP je len poľahky typovým jazykom, je dôležité mať základné vedomosti o typoch, pretože majú dôležitý význam.

Definície funkcií nám hovoria aký typ hodnoty je navrátený, použijeme definíciu pre strlen(), ako náš prvý príklad:

strlen

(PHP 3, PHP 4 >= 4.0.0)
strlen -- Určí dĺžku retažca

Popis
int strlen ( string str )

Vráti dĺžku reťazca.

Tabuľka K-1. Vysvetlenie funkčnej definície

ČasťPopis
strlen Názov funkcie.
(PHP 3, PHP 4 >= 4.0.0) strlen() bol k dispozícii v ochoch PHP 3 a PHP 4
int Typ hodnoty, ktorú táto funkcia vracia, čo je integer (t.j. Dĺžka reťazca sa udáva v číslach).
( string str ) Prvý (a v tomto prípade jediný) parameter/argument pre funkciu strlen() sa nazýva str a je to reťazec.

Definíciu horeuvedenej funkcie by sme mohli prepísať do všeobecného tvaru:

vrátený typ    názov funkcie    ( typ parametra   názov parametra )

Mnoho funkcií má viacero parametrov, ako má napr. in_array(). Jeho prototyp vyzerá následovne:

bool in_array ( zmiešaná ihla, array stoh_sena [, bool striktne])

Čo to vlastne znamená? in_array() vracia hodnotu boolean, TRUE ak je prevdivý (ihla bola nájdená v stoh_sena) alebo FALSE pri chybe ( ihla sa nenašla v stoh_sena). Prvý parameter je pomenovaný ihla a môže byť viacerých typov, takže sme ho nazvali "zmiešaná". Táto zmiešaná ihla (ktorú hľadáme) može byť buď skalárna hodnota (string, integer, alebo float) alebo pole. stoh_sena (pole, v ktorom hľadáme) je druhý parameter. Tretí voliteľný parameter je pomenovaný striktne. Všetky voliteľné parametre sú uzavreté do [ zátvoriek ]. Manuál ukladá, že parameter striktne je štandardne nastevený na boolean FALSE. Pozri manuálovú stránku pre každú funkciu a ako fungujú.