PHP kézikönyv
Előző | R. Függelék. A kézikönyvről | Következő

# Hogyan értelmezzünk egy függvénydefiníciót (prototípust)

A kézikönyvben szereplő függvények gyors referencia céljából vannak dokumentálva. Ha tudod, hogyan kell olvasni és értelmezni a szöveget, sokkal könnyebben tudod majd tanulni a PHP-t. Ahelyett, hogy megbíznál a példákban és a kivág/beszúr technikában, valószínűleg inkább azt szeretnéd tudni, hogyan olvasd függvénydefiníciókat (prototípusokat). Kezdjük is el:

> Előfeltétel: Típusok alapvető megértése: Ámbár a PHP gyengén típusos nyelv, fontos a típusok alapvető megértése, mivel nagy jelentőségük van.

A függvénydefiníció megadja milyen típusú a visszatérési érték. Első példánkban nézzük meg a strlen() függvény definícióját:

    strlen

    (PHP 3, PHP 4, PHP 5)
    strlen -- A string hosszának lekérdezése

    Leírás
    int strlen ( string str )

    Visszaadja a string hosszát.

Táblázat R-1. Egy függvénydefiníció értelmezése

Rész | Leírás
--- | ---
strlen | A függvény neve.
(PHP 3, PHP 4, PHP 5) | A strlen() létezik PHP 3-ban, a PHP 4-ben és a PHP 5-ben is.
int | A függvény által visszatérített érték típusa, amely integer (azaz a string hossza számértékként van reprezentálva).
( string str ) | A strlen() függvény első (és ezesetben az egyetlen) paraméterének/argumentumának a neve str, a típusa pedig string.

A fenti függvénydefiníciót átírhatjuk egy általános formába:

    visszatérítési típus    függvény neve    ( paraméter típusa   paraméter neve )

Sok függvény elfogad összetett paramétereket, mint például az in_array(). A prototípusa a következőképpen néz ki:

    bool in_array ( mixed needle, array haystack [, bool strict])

Mit is jelent ez? in_array() visszaad egy boolean típusú értéket, amely `TRUE` siker esetén (ha a needle-t (a tűt) megtalálta a haystack-ben (szénakazalban)) vagy `FALSE` az ellenkező esetben (ha a needle nem szerepel a haystack-ben). Az első paraméter neve needle és sok különböző típusú lehet, ezért "mixed"-nek nevezzük. Ez a mixed needle (amit éppen keresünk) lehet egy skaláris érték (string, integer, vagy float), vagy egy tömb. haystack (a tömb, amiben keresünk) a második paraméter. A harmadik opcionális paraméter neve strict. Minden opcionális paraméter [ szögletes zárójelben ] látható. A kézikönyv kijelenti, hogy a strict paraméter alapértelmezett értéke `FALSE`. Nézd meg minden függvény oldalát, hogy lásd, hogy működik.

Vannak függvények, amelyeknek összetetteb PHP verzióinformációval vannak ellátva. Vegyük példának a html_entity_decode() fügvényt:

    (PHP 4 >= 4.3.0, PHP 5)

Ez azt jelenti, hogy ez a függvény nem volt jelen a PHP 3-ban, és csak a PHP 4.3.0 kiadás óta létezik.

Előző | Tartalom | Következő
Felhasználói megjegyzések | Fel | Ebben a kézikönyvben dokumentált PHP verziók