Premiers pas en PHP Web

Les programmes PHP que vous allez écrire vont être exécutés par le module PHP d'un serveur Web. Pour l'instant, vous utiliserez le serveur Web interne du moteur PHP. Ce serveur interne à PHP est classiquement utilisé par les développeurs. Son objectif n'est PAS d'être utilisé comme serveur de production.

Le serveur interne à PHP est classiquement lancé par la commande suivante :

php -S localhost:8000

Le serveur écoute alors sur le port 8000 de « localhost » (la boucle locale de l'ordinateur) et accède au répertoire courant de la commande comme racine pour servir les ressources demandées par les clients. Une variante possible, utilisant l'option « -t » permet de désigner le répertoire, relatif ou absolu, utilisé comme racine des ressources, « public » dans l'exemple ci-après :

php -S localhost:8000 -t public

Pour finir, afin de vous apporter un retour rapide sur les erreurs que vous commettrez en écrivant votre code PHP, vous modifierez la directive de configuration « display_errors » grâce à l'option « -d » de la ligne de commande :

php -d display_errors -S localhost:8000

En mode Web, la directive « display_errors » insère les messages d'erreur dans la charge utile de la réponse HTTP, permettant ainsi au développeur de constater les problèmes lorsqu'il explore le site qu'il développe. Notez que toutes les erreurs s'affichent aussi dans le terminal qui a lancé la commande « php -S… »

Le client et le serveur fonctionnent sur le même ordinateur, mais cela n'affecte en rien les principes des échanges HTTP vus précédemment.

Lorsque la ressource demandée par le client possède l'extension « .php », le serveur Web passe la main au module PHP qui va déclencher le programme PHP. Un programme écrit en PHP va donc être exécuté sur le serveur pour construire une réponse HTTP suite à la requête HTTP du client Web. N'oubliez jamais ce mode de fonctionnement et pensez donc bien à utiliser votre serveur Web !

Le diagramme suivant résume les mécanismes et échanges mis en œuvre lors de l'édition puis de l'accès local à un programme PHP par le serveur Web local lors de ces TP :

Vous allez réaliser vos premiers programmes PHP en mode Web. Avant de débuter, quelques remarques importantes s'imposent. En effet, ces activités entrent dans le cadre de la ressource « Qualité de développement », dont l'aspect « style de codage » demande de suivre des règles précises et communes à tous les développeurs :

• Style de codage
  • la version de PHP utilisée est 8.1
  • votre code devrait suivre les règles de style de codage PSR-12 (qui prolonge, étend et remplace PSR-2)
  • des outils de contrôle automatisé de qualité de code seront mis en place dans les TP futurs
• Principe du « tout PHP »
  • le fichier PHP ne comporte que du code PHP, c'est un programme ou une classe à part entière
  • le bloc PHP est déclaré par « <?php » uniquement (exclure « <? » qui n'est pas portable)
  • la balise de fermeture « ?> » ne doit jamais être utilisée
• echo / return
  • le résultat de vos programmes est construit à l'aide de concaténations
  • utilisez la syntaxe Heredoc (voire Nowdoc) pour les chaînes de caractères multi-lignes (et nommez le marqueur de fin « HTML » ou « SQL » pour indiquer à votre éditeur de texte la colorisation à adopter)
  • un seul « echo » remplit la charge utile de la réponse HTTP transmise au navigateur en fin de programme PHP
  • les fonctions et méthodes qui produisent des résultats (chaînes de caractères par exemple) retournent ces résultats et ne comportent donc jamais de « echo ».
• Typage
  • Le typage strict sera systématiquement utilisé et précisé dès les premières lignes du fichier :

    <?php
    
    declare(strict_types=1);

  • le type de retour des fonctions et méthodes doit systématiquement être précisé
  • le type des paramètres des fonctions et méthodes doit systématiquement être précisé
  • le type des propriétés des objets doit systématiquement être précisé

La grande majorité des programmes que vous allez écrire en PHP en mode serveur ont pour but de produire une sortie texte au format HTML qui sera transmise au navigateur Web du client qui a demandé la ressource PHP. Vos programmes PHP vont donc souvent « construire dynamiquement des pages HTML ».

Le code d'exemple qui suit vous donne les grandes lignes de ce que seront vos premières réalisations :

Vous utiliserez PhpStorm. Dans la cadre universitaire, vous pouvez disposer d'une licence gratuite pour les étudiants. Ceci vous permet d'utiliser les outils sur votre ordinateur personnel, tant que vous êtes étudiant. L'utilisation de PhpStorm au sein du département ne nécessite pas de démarche particulière puisque nous avons un serveur de licences JetBrains. Je vous invite néanmoins à demander une licence et à travailler sur votre ordinateur personnel en dehors des séances de TP. Un tutoriel de configuration est à vote disposition. Inutile pour l'instant d'installer Composer, PHP CS Fixer ou autre, ceci viendra plus tard. Une configuration simple de PhpStorm suffira pour ce TP.

• Ouvrez un terminal puis utilisez la commande mkdir un_nom_de_répertoire pour créer un nouveau répertoire « php-web-premiers-pas » à l'endroit de votre choix suivie de la commande cd un_chemin_relatif_ou_absolu pour vous placer dans le répertoire
• Initialisez le dépôt Git du projet

  git init

• Effectuez une première validation

  git commit --allow-empty -m "Initial commit"

• Éditez le fichier « .gitignore » pour exclure les fichiers binaires inutiles à votre projet (fichiers pptx du cours, …), les fichiers qui contiennent des mots de passe ou, dans le cas des projets collaboratifs, les fichiers créés par votre éditeur de texte (répertoire « .idea » pour PhpStorm)
• Éditez un fichier « README.md » dans lequel doivent figurer :
  • un titre de niveau 1 contenant le titre explicite du projet
  • un titre de niveau 2 « Auteur(s) » vous permettant de préciser votre nom et votre prénom (ainsi que ceux de votre binôme, le cas échéant)
  • un titre de niveau 2 « Installation / Configuration » précisant les points essentiels permettant d'installer, de configurer et de lancer le projet
• Ajoutez les fichiers au dépôt

  git add .

• Effectuez une nouvelle validation

  git commit -m "Repository setup"

• Si nécessaire, renommez la branche principale en « main » (une branche vide ne peut pas être renommée, c'est pourquoi ceci est fait après le premier commit)

  git branch -m main

  Notez que vous pouvez le faire de façon définitive avec la commande suivante, à condition d'utiliser git dans une version supérieure à 2.28

  git config --global init.defaultbranch main

• Connectez-vous à l'application GitLab et créez un dépôt portant le même nom que votre nouveau répertoire en pensant à décocher la case « Initialize repository with a README »
• Accordez la permission « Reporter » à votre enseignant de TP/TD
• Associez le dépôt local et le dépôt distant

  git remote add origin https://iut-info.univ-reims.fr/gitlab/votre_login/php-web-premiers-pas.git

• Poussez le dépôt local vers le dépôt distant

  git push -u origin main

• Vous effectuerez une validation après chaque question.
• À la fin de chaque séance, vous effectuerez une validation. Si cette validation contient du code incomplet ou ne fonctionnant pas, mentionnez-le dans le message de validation. Vous pousserez ensuite votre travail vers le dépôt distant.
• Ce dépôt sera utilisé par votre enseignant(e) de TP pour évaluer votre travail, que cela conduise à un note ou pas. Assurez-vous donc régulièrement que tous les fichiers que vous souhaitez lui rendre sont bien présents dans le dépôt. Respectez les noms des fichiers qui vous sont demandés si des consignes particulières vous sont données.
• Le dépôt lui-même sera évalué, soignez l'écriture de vos messages : clarté, pertinence, orthographe.

L'aide-mémoire Git et l'aide-mémoire GitLab de Monsieur Nourrit pourront vous être utiles.