11.18.3 Comment lire la définition d'une fonction (prototype)

Chaque fonction dans le manuel est documentée pour permettre une compréhension rapide. Savoir décoder le texte rendra votre apprentissage plus facile. Plutôt que de dépendre d'exemples prêts en copier/coller, il est plus utile de savoir lire la définition d'une fonction (prototype). Voici comment :

Les définitions de fonctions vous indiquent quel type de données est retourné . Examinons la fonction strlen comme exemple :

strlen

(PHP 3, PHP 4, PHP 5)
strlen -- Retourne la taille de la chaîne

Description
int strlen ( string str )

strlen() retourne la taille de la chaîne str.

Partie	Description
strlen	Le nom de la fonction.
(PHP 3, PHP 4, PHP 5)	strlen() est présente dans toutes les versions de PHP 3, PHP 4 et PHP 5.
int	Type de valeur retourné par cette fonction, qui est en l'occurrence un entier (i.e. la taille d'une chaîne est mesurée par un nombre).
( string str )	Le premier (et ici le seul) paramètre à fournir à cette fonction est le paramètre str , qui doit être du type chaîne de caractères.

Nous pourrions réécrire ce prototype avec une version plus générique :

type_retourné nom_de_la_fonction ( type_du_paramètre nom_du_paramètre )

Plusieurs fonctions ont besoin de plusieurs paramètres, comme in_array . Son prototype est le suivant :

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

Qu'est ce que cela signifie? in_array retourne un booléen TRUE en cas de réussite (le paramètre needle a été trouvé dans le tableau haystack ) ou FALSE en cas d'échec (le paramètre needle n'a pas été trouvé dans le tableau haystack ). Le premier paramètre s'appelle needle et il peut être de différents types : il porte donc la mention mixed . Le paramètre needle (ce que nous recherchons) peut être une valeur scalaire ( chaîne de caractères , entier , ou float ), ou encore un array . haystack (le tableau dans lequel nous recherchons) est le second paramètre. Le troisième paramètre, strict , est optionnel. Tous les paramètres optionnels sont placés entre crochets. La manuel indique que le paramètre strict vaut par défaut FALSE . Reportez-vous au manuel de chaque fonction pour savoir comment elle fonctionne.

Il y'a aussi des fonctions avec des informations plus complexes concernant les versions de PHP. Prenons html_entity_decode comme exemple :

(PHP 4 >= 4.3.0, PHP 5)

Cela signifie que cette fonction n'est pas disponible en PHP 3 et qu'elle n'est disponible que depuis PHP 4.3.0.