Sommaire

Suivant ce que l'on veut faire, il y a 2 possibilités d'accéder à la doc :

• Voir la liste des fonctions classées par thème : si on ne sait pas exactement quelle fonction on cherche, si on veut flâner un peu et qu'on veuille avoir la liste des fonctions classées par catégories… C'est la première méthode qu'on utilisera.
• Accéder à la présentation d'une fonction dont on connaît le nom : si on connaît le nom d'une fonction, mais qu'on ne sait pas s'en servir, c'est cette seconde méthode que l'on utilisera. C'est la méthode la plus simple, la plus rapide, et la plus fréquemment utilisée.

Liste des fonctions classées par thème

D'abord le lien indispensable : http://www.php.net/manual/fr/funcref.php
Ce lien conduit au sommaire des fonctions PHP, en français. Il y en a un paquet et dont peu le nom est parlant.

Certains thèmes de fonctions ne sont pas activés avec PHP. C'est le cas par exemple de la librairie GD pour créer des images. Si c'est le cas, on nous indique qu'il faut "activer" la librairie, comme on l'a vu dans le chapitre sur la librairie GD.

Accès direct à une fonction

Il est fréquent qu'on connaisse le nom d'une fonction, mais qu'on ne sache pas vous en servir.
Pour accéder directement à la présentation d'une fonction, taper l'adresse suivante dans votre navigateur :
php.net/nom_de_la_fonction (inutile de mettre "http://www." devant, il sera rajouté tout seul, ainsi c'est plus rapide).

Si une fonction nous intéresse, on tombe sur la page Présentation de la fonction
Cette page a toujours la même forme. On trouvera dans l'ordre, du haut vers le bas :

Apprendre à lire un mode d'emploi

Pour mieux comprendre, on va prendre un exemple, la fonction mt_rand.
Le mode d'emploi indique : int mt_rand ([ int min, int max])

Examinons toutes les infos qu'il y a là-dedans :

• int : la fonction commence par le mot-clé "int". Ce premier mot-clé indique ce que renvoie la fonction. On peut avoir entre autres les mots-clé suivants :
  • int : cela signifie que la fonction renvoie un nombre entier. mt_rand renvoie donc un nombre entier (-8, 0, 3, 12 etc…)
  • float : la fonction renvoie un nombre décimal (comme 15.2457).
  • number : la fonction renvoie un nombre, qui peut être soit un entier (int) soit un décimal (float).
  • string : la fonction renvoie une chaîne de caractères, c'est-à-dire du texte. Par exemple "Bonjour".
  • bool : la fonction renvoie un booléen, c'est-à-dire "VRAI" ou "FAUX" (true ou false).
  • array : la fonction renvoie un array (tableau de variables). Le plus simple en général, c'est de faire un print_r comme on l'a vu dans le chapitre "Les Array II : le Retour", pour voir tout ce que contient cet array.
  • resource : la fonction renvoie une "ressource". Une ressource est un type particulier de données, une sorte de super-variable. Il peut s'agir d'une image, d'un fichier etc… Dans le chapitre sur la librairie GD par exemple, on manipule une variable $image.
  • void : la fonction ne renvoie rien du tout. C'est le cas des fonctions qui ne servent qu'à faire une action et qui n'ont pas besoin de renvoyer d'information.
  • mixed : la fonction peut renvoyer n'importe quel type de données (un int, un string, ça dépend…)
• mt_rand : c'est le nom de la fonction.
• ([ int min, int max]) : entre parenthèses, il y a la liste des paramètres que l'on peut donner à la fonction. Ici, on peut donner deux entiers (int) : min et max. Ils servent à indiquer qu'on veut un nombre aléatoire entre 5 et 15 par exemple.

Cependant, il faut savoir que certains paramètres ne sont pas toujours obligatoires. Ces paramètres "facultatifs" sont mis entre crochets.

Puisque "int min, int max" sont entre crochets, ça veut dire qu'on peut ne donner aucun paramètre à la fonction ?

Tout à fait, d'ailleurs c'est écrit dans la doc :

Si la fonction ne prend pas du tout de paramètre, le mot-clé "void" est indiqué entre parenthèses. C'est le cas par exemple de la fonction time().

Un autre exemple : date

time est un cas simple. Voyons un cas un peu plus compliqué, la fonction date.
On la retrouve donc sur php.net/date

Le mode d'emploi indique ceci : string date ( string format [, int timestamp])
La fonction renvoie une chaîne de caractères (string) : c'est la date.
On doit lui donner obligatoirement une chaîne de caractère appelée "format" (pour demander le mois, l'année etc…)
Et il y a un int qui est facultatif : c'est le timestamp.
On se souvient que date("Y"); renvoie l'année actuelle. Mais si on rajoute un timestamp (ce qui n'est pas obligatoire), alors c'est l'année correspondant au timestamp qui sera renvoyée.

Donc toujours bien faire attention : certains paramètres sont obligatoires, d'autres pas (ils sont entre crochets) et la fonction réagit différemment selon les cas. En général, le texte descriptif de la fonction explique ce qui se passe si on ne met pas les paramètres facultatifs.

Lire les exemples !

Il y a toujours des exemples pour illustrer l'utilisation de la fonction. C'est très pratique car on nous montre de quelle manière utiliser la fonction, et on n'hésite pas à nous montrer les cas particuliers (où la fonction réagit un peu différemment).
Tester également les exemples proposés pour mieux comprendre.