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 :
Note: Pr�-requis : Connaissances de base des types.
Bien que PHP soit un langage sans typage fort, une connaissance de base des types est essentielle, car ils ont quand m�me des sens importants.
Les d�finitions de fonctions vous indiquent quel type de donn�es est retourn�. Examinons la fonction strlen() comme exemple :
strlen (PHP 4, PHP 5) strlen -- Retourne la taille de la cha�ne Description int strlen ( string $string ) Retourne la taille de la cha�ne $string.
| Partie | Description |
|---|---|
| strlen | Le nom de la fonction. |
| (PHP 4, PHP 5) | strlen() est pr�sente dans toutes les versions de PHP 4, PHP 5 et PHP 6. |
| int | Type de valeur retourn�e 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 $string ) | Le premier (et ici le seul) param�tre � fournir � cette fonction est le param�tre string , 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 array, dans lequel nous recherchons) est le second param�tre. Le troisi�me param�tre, optionnel, 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 disponible que depuis PHP 4.3.0.
Suivez l'auteur
