Costanti PHP: define() vs const e costanti magiche

Una costante è un nome per un valore che non cambia mai mentre lo script è in esecuzione. Dichiarala con const MAX_USERS = 100; oppure define('MAX_USERS', 100);, poi usa il nome da solo, senza $.

<?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";

Per convenzione i nomi delle costanti sono in UPPER_SNAKE_CASE. Sono globali: una costante dichiarata in cima a un file è visibile dentro ogni funzione senza global.

define() vs const

Entrambi creano una costante, ma lavorano in momenti diversi. const viene risolto quando PHP compila il file, define() viene eseguito come qualsiasi altra chiamata di funzione.

<?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";

Usa const come scelta predefinita, perché è più breve e viene verificato in fase di compilazione. Usa define() quando la costante dipende da una condizione o da un nome calcolato.

Le costanti non si possono modificare

Assegnare un valore a una costante è un errore di parsing:

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

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

Definire due volte la stessa costante non è un errore, ma PHP stampa un warning e mantiene il primo valore:

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

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

Quando un valore potrebbe essere già impostato (per esempio in un file di configurazione caricato più di una volta), controlla prima con 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";

Costanti array

Una costante può contenere un array. Puoi leggerla con NAME[key], scorrerla con un ciclo e passarla in giro, ma non modificarla.

<?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";
}

Costanti di classe

Dentro una classe, const dichiara una costante che appartiene alla classe. Leggila con ClassName::NAME dall'esterno e con self::NAME o static::NAME dall'interno. Le costanti di classe possono avere una visibilità, possono essere final e da PHP 8.3 possono dichiarare un tipo.

<?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 gruppo di costanti di classe correlate come STATUS_NEW e STATUS_PAID spesso si scrive meglio come enum, che impedisce anche di far circolare valori non validi.

Costanti magiche: LINE, FILE, DIR e altre

Le costanti magiche cambiano valore a seconda di dove compaiono. Vengono riempite in fase di compilazione.

<?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 più usata è __DIR__, la cartella del file corrente. Costruire i percorsi degli include a partire da essa li fa funzionare indipendentemente dalla cartella da cui è stato avviato lo script: require __DIR__ . '/config.php';. Vedi include e require per lo schema completo.

Costanti predefinite da conoscere

PHP definisce molte costanti proprie. Queste compaiono di continuo:

<?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 è il fine riga del sistema su cui gira PHP ("\n" su Linux e macOS, "\r\n" su Windows). Serve per il testo scritto su file e nel terminale; nell'output HTML un a capo non si vede, quindi lì usa <br>.