Programmation PHP/Constantes

Un livre de Wikilivres.
Sauter à la navigation Sauter à la recherche


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

Nom[modifier | modifier le wikicode]

Le nom d'une constante suit les mêmes règles que celles pour les variables, mis à part que le nom d'une constante n'est pas précédé par $.

<?php
// Noms valides
CONSTANTE1
CONSTANTE2
CONSTANTE_plus

// Noms invalides
0CONSTANTE

?>

Déclaration[modifier | modifier le wikicode]

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]).

Utilisation[modifier | modifier le wikicode]

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émentaires[modifier | modifier le wikicode]

Type de données[modifier | modifier le wikicode]

Une constante, si elle peut être de type booléen, entier, nombre à virgule flottante ou chaîne de caractère, ne peut en aucun cas être un tableau ou un objet. Elle est donc forcément scalaire.

 <?php
 // Le code suivant va générer une erreur
 define ("CONSTANTE", array("a", "b", "c"));
 echo CONSTANTE;
 ?>

Unicité de la déclaration[modifier | modifier le wikicode]

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 nom[modifier | modifier le wikicode]

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éfinies[modifier | modifier le wikicode]

Il en existe de deux types[3] :

  • fixes en valeur
  • dont la valeur est dynamique

Constantes intégrées à valeur fixe[modifier | modifier le wikicode]

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 dynamique[modifier | modifier le wikicode]

Les constantes parfois dites "magiques":

  • __FILE__ : retourne le chemin complet (exemple: /la/ou/est/le/fichier.php) du fichier qui est actuellement exécuté par le serveur.
  • __LINE__ : retourne la ligne du fichier qui est actuellement exécuté par le serveur.
  • __FUNCTION__ : retourne le nom de la fonction dans laquelle on se trouve.
  • __CLASS__ : retourne le nom de la classe dans laquelle on se trouve.

Exemple:

<?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érences[modifier | modifier le wikicode]