Programmation PHP/Constantes


Tout comme en C, PHP peut utiliser des variables dont on précise la valeur une fois pour toutes et qui ne pourra être modifiée jusqu'à la fin de l'exécution du code.

NomModifier

Le nom d'une constante suit les mêmes règles que celles pour les variables, mis à part qu'il n'est pas précédé par $. Par convention on les baptise avec des lettres capitales.

// Noms valides
CONSTANTE1
CONSTANTE_2

// Noms invalides
0CONSTANTE

DéclarationModifier

Pour déclarer une constante, on utilise la fonction define() (depuis PHP3) qui renvoie un booléen true en cas de réussite de déclaration et false en cas d'échec[1].

La syntaxe de define est la suivante :

define(chaine_de_caractere, valeur);

La chaîne de caractère est le nom de la constante, pouvant contenir lettre, tiret, underscore et chiffre (la première lettre de la chaîne est une lettre dans [a-zA-Z]).

UtilisationModifier

L'utilisation est similaire à celle des variables.

<?php
  define("CONSTANTE", "Texte ici");
  echo CONSTANTE; // affiche "Texte ici"

Depuis PHP 5, la déclaration de constantes à l'intérieur d'une classe peut se faire avec le mot-clé const de la façon suivante :

<?php
class MaClasse
{
    const CONSTANTE = "Texte ici";
    
    function afficher()
    {
      echo self::CONSTANTE;
    }
}

$instance = new MaClasse;
$instance->afficher();

Ces constantes sont publiques par défaut, mais PHP 7.1 introduit la possibilité de les rendre privée avec : private const.

Informations supplémentairesModifier

Type de donnéesModifier

Une constante, si elle peut être de type booléen, entier, nombre à virgule flottante ou chaîne de caractère, mais en aucun cas un objet

Depuis PHP 7, elle peut aussi être un tableau de scalaires.

 <?php
 // Le code suivant va générer une erreur en PHP 5 (mais pas en PHP 7)
 define ("CONSTANTE", ["a", "b", "c"]);
 print_r(CONSTANTE);

Unicité de la déclarationModifier

La redéclaration d'une constante portant le même nom est ignorée, et la valeur de la première déclaration reste valable.

 <?php
 define ("CONSTANTE", "première définition");
 define ("CONSTANTE", "deuxième définition"); // ignoré
 echo CONSTANTE; // retournera toujours "première définition"

D'où l'utilisation de defined() pour déterminer si une constante est déjà définie ou pas[2] :

 define("CONSTANTE", "première définition");
 if not defined("CONSTANTE") {
     //...

Conflit de nomModifier

Il existe des constantes intégrées à PHP, or on ne peut créer une constante portant leurs noms, cela entraînerait une erreur. En général, évitez la syntaxe suivante pour le nom d'une variable ou d'une constante :

__NOM__

Constantes prédéfiniesModifier

Il en existe de deux types[3] :

  • fixes en valeur
  • dont la valeur est dynamique

Constantes intégrées à valeur fixeModifier

Les constantes suivantes ont des valeurs fixes, comme celles définies avec define :

  • TRUE : vrai (booléen) = 1.
  • FALSE : faux (booléen) = 0.
  • PHP_VERSION : version de PHP du serveur exécutant le script.
  • PHP_OS : nom du système d'exploitation du serveur exécutant le script.
  • PHP_EOL : end of line = \n.
  • INF : l'infinie.

Constantes intégrées à valeur dynamiqueModifier

Les constantes magiques[4] :

  • __DIR__ : dossier courant.
  • __NAMESPACE__ : namespace courant.
  • __FILE__ : chemin complet du fichier qui est actuellement exécuté par le serveur (exemple : /la/ou/est/le/fichier.php).
  • __CLASS__ : nom de la classe dans laquelle on se trouve.
  • __TRAIT__ : trait courant.
  • __FUNCTION__ : nom de la fonction dans laquelle on se trouve.
  • __METHOD__ : nom de la méthode dans laquelle on se trouve.
  • __LINE__ : ligne du fichier qui est actuellement exécuté par le serveur.

Exemple d'utilisation :

<?php
echo 'Fichier: ' . __FILE__ . "\n";
echo 'Ligne: ' . __LINE__ . "\n";

class test
{
    function foo()
    {
        echo 'Fonction: ' . __FUNCTION__ . "\n";
        echo 'Classe: ' . __CLASS__ . "\n";
    }
}

test::foo();
// ou alors
$test = new test();
$test->foo();

Qui affichera :

Fichier: /home/ze/toto.php
Ligne: 3
Fonction: foo
Classe: test
Fonction: foo
Classe: test

L'affichage de la première ligne, par exemple, dépend d'où est situé le fichier dans l'arborescence des fichiers.

RéférencesModifier