Commentaires PHP, Include/Include_once, Require/Require_once

Par : Fiona Brun Fiona Brun
Hours Le kit de préparation mis à jour

Pourquoi utiliser les commentaires ?

  • Si vous ne travaillez pas sur le code source pendant un certain temps, il est facile d'oublier ce que fait le code. Commenter le code source permet de se rappeler ce que fait le code.
  • Commenter le code source est également très important lorsque plusieurs développeurs doivent travailler sur le même projet. Les modifications apportées par un développeur peuvent être facilement comprises par d'autres développeurs en lisant simplement les commentaires.
  • Il est recommandé d'avoir 3 lignes de commentaires pour 10 lignes de code.

Commentaires PHP

  • Les commentaires nous aident à comprendre le code
  • Les commentaires sont des explications que nous incluons dans notre code source. Ces commentaires sont destinés à la compréhension humaine.
  • Les commentaires sur une seule ligne commencent par des barres obliques doubles // et se terminent sur la même ligne.
  • Commentaires PHP
  • Les commentaires sur plusieurs lignes commencent par une barre oblique suivie de l'astérisque /* et se terminent par l'astérisque suivi de la barre oblique */.
  • Commentaires PHP

Le diagramme ci-dessous montre un fichier PHP avec des commentaires sur plusieurs lignes et sur une seule ligne.

Exemple PHP

Exemple de commentaires PHP

PHP Inclure et PHP Include_once

L'instruction php « include » est utilisée pour inclure d'autres fichiers dans un fichier PHP.

Il existe deux variantes, include et include_once. Include_once est ignoré par l'interpréteur PHP si le fichier doit être inclus.

L'instruction include a la syntaxe suivante

<?php
include 'file_name';
?>

L'instruction include_once a la syntaxe suivante

<?php
include_once 'file_name';
?>

ICI,

  • « Include/include_once » est l'instruction qui inclut le fichier
  • « 'file_name' » est le nom du fichier à inclure.

Exemple : Inclure / Include_once

Supposons que vous développez un site Web contenant le même menu de navigation sur toutes les pages.

Vous pouvez créer un en-tête commun, puis l'inclure dans chaque page à l'aide de l'instruction include. Voyons comment cela peut être réalisé.

  • Nous allons créer 2 noms de fichiers
  • en-tête.php, index.php

Vous trouverez ci-dessous les codes pour : header.php

<a href="index.php">Home</a>

<a href="aboutus.php">About us</a>

<a href="services.php">Services</a>

<a href="contactus.php">Contact Us</a>

index.php

<?php

include 'header.php';

?>

La page d'en-tête ci-dessus affichera

PHP requiert et PHP require_once

L'instruction require a deux variantes, require et require_once.

L'instruction require/require_once est utilisée pour inclure le fichier.

Require_once est ignoré si le fichier requis a déjà été ajouté par l'une des quatre instructions d'inclusion.

Il a la syntaxe suivante

<?php
require 'file_name';
?>
<?php
require_once 'file_name';
?>

ICI,

  • « require/require_once » est l'instruction qui inclut le fichier
  • « 'file_name' » est le nom du fichier à inclure.

Exemple : Exiger

Supposons que nous développions une application basée sur une base de données.

Nous pouvons créer un fichier de configuration que nous pouvons inclure dans toutes les pages qui se connectent à la base de données à l'aide de l'instruction require. config.php

<?php

$config['host'] = 'localhost';

$config['db'] = 'my_database';

$config['uid'] = 'root';

$config['password'] = '';

?>

Examinons maintenant l'exemple de code qui nécessite le fichier de configuration. Pages_model.php

<?php

require 'config.php'; //require the config file

//other code for connecting to the database

?>

PHP inclure vs exiger

La différence entre inclure / exiger

Inclure Exiger
Émet un avertissement lorsqu'une erreur se produit N'émet pas d'avertissement
L'exécution du script continue lorsqu'une erreur se produit L'exécution du script s'arrête lorsqu'une erreur se produit.

Généralement, il est recommandé d'utiliser l'instruction include afin que lorsqu'une erreur se produit, l'exécution du script continue d'afficher l'adresse e-mail du webmaster ou la page contactez-nous.

L'instruction require doit être utilisée si l'intégralité du script ne peut pas s'exécuter sans le fichier demandé.

Les instructions « inclure » ​​et « exiger » peuvent être utilisées à n'importe quelle ligne des codes sources où vous souhaitez que le code apparaisse.

Résumé

  • Un code HTML unique tel que les en-têtes, les pieds de page, les barres latérales, etc. peut être partagé sur plusieurs pages. Cela facilite la mise à jour du site Web en mettant simplement à jour un seul fichier.
  • code PHP tels que les paramètres de configuration de la base de données, les fonctions personnalisées, etc. peuvent être partagés sur de nombreuses pages garantissant que le site Web/l'application utilise les mêmes paramètres.
  • Les commentaires sont utilisés pour aider à comprendre le code source. Ils sont destinés à la compréhension humaine
  • Les instructions de commentaire sur une seule ligne commencent par des barres obliques doubles //.
  • Les instructions de commentaires sur plusieurs lignes sont placées entre les instructions /* */.
  • Les instructions « include, include_once, require et require_once » sont utilisées pour inclure des fichiers.
  • Include_once/require_once est ignoré si le fichier demandé a déjà été inclus à l'aide de l'une des quatre instructions.
  • L'instruction « include » émet un avertissement et poursuit l'exécution si le fichier demandé n'a pas été trouvé.
  • L'instruction require génère une erreur fatale et arrête l'exécution du script.
  • L'instruction « include » doit l'être dans la plupart des cas, sauf dans les situations où sans le fichier demandé à inclure, l'intégralité du script ne peut pas s'exécuter.

Tu pourrais aimer: