PHP

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

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.

Certains thèmes de fonctions ne sont pas activés avec PHP. C'est le cas par exemple de la bibliothèque GD pour créer des images.
Si c'est le cas, on vous indique qu'il faut « activer » la bibliothèque, comme je vous ai appris à le faire dans le chapitre sur GD.

D'autres fonctions appartiennent à des extensions qu'il faut installer manuellement.

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

À 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

Il est inutile d'écrire « http://www. » devant, il sera rajouté tout seul. C'est plus rapide de s'en passer.

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

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

Créé avec HelpNDoc Personal Edition: Nouvelles et informations sur les outils de logiciels de création d'aide