Constantes PHP : define() ou const et constantes magiques

Une constante est un nom pour une valeur qui ne change jamais pendant l'exécution du script. Déclarez-la avec const MAX_USERS = 100; ou define('MAX_USERS', 100);, puis utilisez le nom seul, sans $.

<?php
const SITE_NAME = "Coffee Corner";
define("MAX_ITEMS", 5);

echo SITE_NAME, "\n";
echo "You can order up to " . MAX_ITEMS . " items\n";

$price = 3.5;
const TAX_RATE = 0.2;
echo "Total: ", $price * (1 + TAX_RATE), "\n";

Par convention, les noms de constantes s'écrivent en UPPER_SNAKE_CASE. Elles sont globales : une constante déclarée en haut d'un fichier est visible dans toutes les fonctions sans global.

define() ou const

Les deux créent une constante, mais pas au même moment. const est résolue quand PHP compile le fichier, define() s'exécute comme n'importe quel appel de fonction.

<?php
// const accepts expressions made of literals and other constants
const SECONDS_PER_DAY = 24 * 60 * 60;
const GREETING = "Hello, " . "world";

// define() can run conditionally and take a computed name
$env = "dev";
if ($env === "dev") {
    define("DEBUG", true);
}
foreach (["RED" => "#f00", "GREEN" => "#0f0"] as $name => $hex) {
    define("COLOR_" . $name, $hex);
}

echo SECONDS_PER_DAY, "\n";
echo GREETING, "\n";
var_dump(DEBUG);
echo COLOR_GREEN, "\n";

Utilisez const par défaut, car elle est plus courte et vérifiée à la compilation. Utilisez define() quand la constante dépend d'une condition ou d'un nom calculé.

Une constante ne peut pas être modifiée

Affecter une valeur à une constante est une erreur de syntaxe :

<?php
const LIMIT = 10;
LIMIT = 20;

PHP Parse error:  syntax error, unexpected token "=" in /home/index.php on line 3

Définir deux fois la même constante n'est pas une erreur, mais PHP affiche un warning et garde la première valeur :

<?php
define("LIMIT", 10);
define("LIMIT", 20);
echo LIMIT; // 10

Warning: Constant LIMIT already defined in /home/index.php on line 3

Quand une valeur peut déjà être définie (par exemple dans un fichier de configuration chargé plusieurs fois), vérifiez d'abord avec defined() :

<?php
if (!defined("APP_ENV")) {
    define("APP_ENV", "production");
}
if (!defined("APP_ENV")) {
    define("APP_ENV", "testing");   // skipped
}
echo APP_ENV, "\n";

var_dump(defined("APP_ENV"));
var_dump(defined("NOT_THERE"));

// Read a constant whose name is in a string
$name = "APP_ENV";
echo constant($name), "\n";

Constantes tableaux

Une constante peut contenir un tableau. Vous pouvez le lire avec NAME[key], le parcourir et le transmettre, mais pas le modifier.

<?php
const WEEKDAYS = ["Mon", "Tue", "Wed", "Thu", "Fri"];
define("HTTP_CODES", [200 => "OK", 404 => "Not Found", 500 => "Server Error"]);

echo WEEKDAYS[0], "\n";
echo count(WEEKDAYS), " weekdays\n";
echo HTTP_CODES[404], "\n";

foreach (HTTP_CODES as $code => $text) {
    echo "$code $text\n";
}

Constantes de classe

Dans une classe, const déclare une constante qui appartient à la classe. Lisez-la avec ClassName::NAME depuis l'extérieur et self::NAME ou static::NAME depuis l'intérieur. Les constantes de classe peuvent avoir une visibilité, être final et, depuis PHP 8.3, déclarer un type.

<?php
class Order
{
    public const STATUS_NEW = "new";
    public const STATUS_PAID = "paid";
    private const MAX_LINES = 50;
    final public const string CURRENCY = "EUR";   // typed, PHP 8.3

    public function __construct(public string $status = self::STATUS_NEW) {}

    public function canAddLine(int $lines): bool
    {
        return $lines < self::MAX_LINES;
    }
}

$order = new Order();
echo $order->status, "\n";
echo Order::STATUS_PAID, "\n";
echo Order::CURRENCY, "\n";
var_dump($order->canAddLine(10));

// Dynamic access by name
$which = "STATUS_PAID";
echo constant("Order::$which"), "\n";

Un groupe de constantes de classe liées comme STATUS_NEW et STATUS_PAID s'écrit souvent mieux sous forme d'enum, qui empêche aussi de faire circuler des valeurs invalides.

Constantes magiques : LINE, FILE, DIR et autres

Les constantes magiques changent de valeur selon l'endroit où elles apparaissent. Elles sont remplies à la compilation.

<?php
namespace App\Billing;

class Invoice
{
    public function describe(): string
    {
        return "class: " . __CLASS__ . "\n"
            . "method: " . __METHOD__ . "\n"
            . "function: " . __FUNCTION__ . "\n";
    }
}

echo (new Invoice())->describe();
echo "namespace: ", __NAMESPACE__, "\n";
echo "line: ", __LINE__, "\n";
echo "file: ", basename(__FILE__), "\n";
echo "dir is a directory: ", var_export(is_dir(__DIR__), true), "\n";

La plus utilisée est __DIR__, le dossier du fichier courant. Construire les chemins d'inclusion à partir d'elle les fait fonctionner quel que soit le dossier depuis lequel le script a été lancé : require __DIR__ . '/config.php';. Voir include et require pour le modèle complet.

Les constantes natives à connaître

PHP définit beaucoup de constantes. Celles-ci reviennent tout le temps :

<?php
echo "PHP_VERSION:   ", PHP_VERSION, "\n";
echo "PHP_INT_MAX:   ", PHP_INT_MAX, "\n";
echo "PHP_INT_SIZE:  ", PHP_INT_SIZE, " bytes\n";
echo "PHP_FLOAT_EPSILON: ", PHP_FLOAT_EPSILON, "\n";
echo "M_PI:          ", M_PI, "\n";
echo "PHP_OS_FAMILY: ", PHP_OS_FAMILY, "\n";
echo "E_ALL:         ", E_ALL, "\n";
echo "PHP_EOL is a newline: ", var_export(PHP_EOL === "\n", true), PHP_EOL;

PHP_EOL est la fin de ligne du système sur lequel tourne PHP ("\n" sur Linux et macOS, "\r\n" sur Windows). Elle sert pour le texte écrit dans des fichiers et le terminal ; dans une sortie HTML, un saut de ligne ne se voit pas, utilisez donc <br>.