Ce cours est visible gratuitement en ligne.

Ce cours est en vidéo.

Ce cours existe en livre papier.

Ce cours existe en eBook.

Vous pouvez obtenir un certificat de réussite à l'issue de ce cours.

J'ai tout compris !
Concevez votre site web avec PHP et MySQL

Concevez votre site web avec PHP et MySQL

Mis à jour le lundi 16 juin 2014
  • 8 semaines
  • Facile

Un des gros avantages en PHP, c'est sa documentation très complète, gratuite, disponible sur Internet, et traduite dans de très nombreuses langues (dont le français).

Pourtant, quand quelqu'un nous dit « La solution à ton problème se trouve dans la doc' », on a tendance à trembloter un peu. On pense que la doc' est une sorte de pavé mal construit, illisible, dans lequel on a toutes les chances de se perdre.
C'est un tort. Comme je vous l'ai dit, la documentation PHP est particulièrement complète et bien organisée, qui plus est traduite en français. Tout y est.

Le but de cette annexe est de vous montrer comment la doc' fonctionne, pour que vous soyez ensuite capables de trouver l'information que vous cherchez tout seuls, sans mon aide. ;-)

Accéder à la doc'

La documentation, c'est bien beau, mais c'est où ? Comment y accéder ?

Pour cela, on a deux possibilités, tout dépend de ce que vous voulez faire.

  • Voir la liste des fonctions classées par thèmes : si vous ne savez pas exactement quelle fonction vous cherchez, si vous voulez flâner un peu et avoir la liste des fonctions classées par catégories… c'est la première méthode que vous utiliserez.

  • Accéder à la présentation d'une fonction dont on connaît le nom : si vous connaissez le nom d'une fonction, mais que vous ne savez pas vous 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.

Je vais maintenant vous détailler chacune des deux méthodes permettant d'accéder à la doc'. Vous utiliserez l'une ou l'autre en fonction de vos besoins.

Liste des fonctions classées par thèmes

Vous devriez mettre cette adresse dans les favoris pour ne jamais l'oublier :

Documentation PHP

C'est le sommaire des fonctions PHP, en français.
Si vous vous rendez sur la page, vous devriez voir quelque chose qui ressemble à la figure suivante.

Liste des fonctions classées par thèmes
Liste des fonctions classées par thèmes

Ce que vous voyez là, c'est la liste des « thèmes » de fonctions. Comme vous pouvez le voir, il y en a un sacré paquet !
Ne prenez pas peur si vous ne comprenez même pas un thème sur dix, mais faites l'effort de lire un peu tout ce qu'il y a, et repérez s'il y a un thème qui vous intéresse plus particulièrement qu'un autre.

Par exemple, vous pouvez y voir les thèmes « Mail » et « Mathématiques ». Supposons que je sois intéressé par les fonctions mathématiques de PHP. Je clique sur « Mathématiques ».

Là, une nouvelle page s'ouvre. On vous propose une petite introduction que je vous recommande de lire à chaque fois, ainsi que la liste des fonctions.

En ce qui concerne les fonctions mathématiques, elles sont toujours activées par défaut, donc pas de problème de ce côté-là.
Descendez plus bas dans la page (parfois vous devez descendre très très bas), jusqu'à l'endroit où est écrit « Table des matières ». C'est là que ça nous intéresse : il y a la liste des fonctions du thème « Mathématiques », comme le montre la figure suivante.

Quelques fonctions mathématiques
Quelques fonctions mathématiques

À gauche, vous avez le nom de la fonction, et à droite un très bref descriptif de ce qu'elle fait.

Si vous cliquez sur un nom de fonction, vous accédez à la présentation de la fonction. Nous verrons comment fonctionne cette page dans la seconde partie de cette annexe.

Ici par exemple, je peux être intéressé par le calcul d'un logarithme népérien (fonction log). Même si les maths et vous ça fait deux, il y a quand même quelques fonctions qui devraient vous intéresser : max qui retourne le nombre le plus grand, ou mt_rand qui génère un nombre aléatoire.

Accès direct à une fonction

Il est fréquent que vous connaissiez le nom d'une fonction, mais que vous ne sachiez pas vous en servir.
Là, il n'est plus question de « flâner » parmi les thèmes de fonctions pour en repérer une intéressante : on souhaite obtenir directement la description d'une fonction.

Par exemple, supposons que vous souhaitiez générer un nombre aléatoire entre 0 et 100. Vous savez que la fonction s'appelle mt_rand parce que quelqu'un en a parlé sur un forum.

Cette information est normalement suffisante : vous avez le nom de la fonction et n'avez plus qu'à vous documenter.

Pour accéder directement à la présentation d'une fonction, tapez l'adresse suivante dans votre navigateur :

php.net/nom_de_la_fonction

Si la fonction existe, vous tombez directement sur sa présentation. Sinon, on vous dit que la fonction n'existe pas et on vous propose d'autres fonctions qui ont à peu près le même nom.

Si je veux donc tout savoir sur mt_rand, je tape ce qui se trouve sur la figure suivante dans la barre d'adresse de mon navigateur.

Accès direct à la documentation depuis la barre d'adresse du navigateur
Accès direct à la documentation depuis la barre d'adresse du navigateur

Lorsque vous validez cette adresse, vous arrivez directement sur la page qui présente la fonction mt_rand !
Plutôt rapide et pratique, non ?

Présentation d'une fonction

Je suppose maintenant que vous avez repéré la fonction qui vous intéresse. Vous tombez alors sur la page de présentation de la fonction.
On va prendre le cas de la fonction mt_rand : faites comme je vous ai dit plus haut pour accéder directement à la page concernant cette fonction.

La page de présentation d'une fonction a toujours la même forme, celle de la figure suivante.

Présentation de la fonction mt_rand
Présentation de la fonction mt_rand

Ce qui nous intéresse le plus là-dedans, c'est le « mode d'emploi de la fonction ». Il correspond à ces lignes :

int mt_rand ( void )
int mt_rand ( int $min, int $max )

Ces lignes décrivent le mode d'emploi de mt_rand. Je vais vous apprendre à le déchiffrer, car lorsque vous saurez le lire, vous saurez utiliser n'importe quelle fonction PHP à l'aide de la doc' !

Apprendre à lire un mode d'emploi

Ici, le mode d'emploi indique qu'il y a deux façons d'utiliser la fonction : avec ou sans paramètres. Prenons le cas avec paramètres, plus complexe :

int mt_rand ( int $min, int $max )

Examinons toutes les infos que cet extrait de code renferme.

  • 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és 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 je vous l'ai appris, pour voir tout ce que contient cet array ;

    • resource : la fonction renvoie une « ressource ». Une ressource est un type de données particulier, une sorte de super-variable. Il peut s'agir d'une image, d'un fichier, etc. Dans le chapitre sur la bibliothèque 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 : là c'est tout simple, 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 que vous voulez un nombre aléatoire compris entre 5 et 15 par exemple. La signification des paramètres est expliquée dans la section « Liste des paramètres » de la page.

Il est aussi possible d'appeler la fonction sans aucun paramètre, c'est ce que signifie la ligne suivante :

int mt_rand ( void )

Mais alors… Qu'est-ce que ça signifie si on n'envoie aucun paramètre ? Que va faire la fonction ?

C'est écrit sur la page :

Citation

Appelée sans les arguments optionnels min et max, mt_rand() retourne un nombre pseudo-aléatoire, entre 0 et RAND_MAX (un nombre maximum fixé par PHP). Pour obtenir un nombre entre 5 et 15 inclus, il faut utiliser mt_rand(5,15).

Comme quoi, il suffit de lire. ;-)

Un autre exemple : date

Comme vous devez maintenant savoir le faire, rendez-vous sur date pour avoir la description de la fonction.

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ères appelée format (pour demander le mois, l'année, etc. vous vous souvenez ?).

On notera qu'il y a un second paramètre entre crochets, ce qui signifie qu'il est facultatif. Il s'agit d'un int dénommé timestamp. Pour savoir ce qu'il signifie, lisez la description des paramètres.

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

Lisez les exemples !

Il y a toujours des exemples pour illustrer l'utilisation de la fonction. C'est très pratique car on vous montre de quelle manière utiliser la fonction, et on n'hésite pas à vous faire découvrir les cas particuliers où la fonction réagit un peu différemment.

Par exemple, pour mt_rand on a ce qui se trouve sur la figure suivante.

Exemples d'utilisation de mt_rand
Exemples d'utilisation de mt_rand

Dans la mesure du possible, essayez de tester les exemples proposés. Il arrive souvent qu'on comprenne mieux avec des exemples que l'on essaie soi-même.

Exemple de certificat de réussite
Exemple de certificat de réussite