Stałe w PHP: define() vs const i stałe magiczne

Stała to nazwa wartości, która nie zmienia się podczas działania skryptu. Zadeklaruj ją przez const MAX_USERS = 100; albo define('MAX_USERS', 100);, a potem używaj samej nazwy, bez $.

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

Zgodnie z konwencją nazwy stałych zapisuje się jako UPPER_SNAKE_CASE. Stałe są globalne: stała zadeklarowana na początku pliku jest widoczna w każdej funkcji bez global.

define() vs const

Oba tworzą stałą, ale działają w różnym czasie. const jest rozwiązywane, gdy PHP kompiluje plik, a define() wykonuje się jak każde inne wywołanie funkcji.

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

Domyślnie używaj const, bo jest krótsze i sprawdzane przy kompilacji. Używaj define(), gdy stała zależy od warunku albo wyliczonej nazwy.

Stałych nie można zmienić

Przypisanie do stałej to błąd parsowania:

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

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

Dwukrotne zdefiniowanie tej samej stałej nie jest błędem, ale PHP wypisuje ostrzeżenie i zachowuje pierwszą wartość:

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

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

Gdy wartość może już być ustawiona (na przykład w pliku konfiguracyjnym ładowanym więcej niż raz), sprawdź najpierw przez 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";

Stałe tablicowe

Stała może przechowywać tablicę. Możesz ją czytać przez NAME[key], iterować po niej i przekazywać dalej, ale nie możesz jej zmieniać.

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

Stałe klas

W klasie const deklaruje stałą, która należy do klasy. Z zewnątrz czytasz ją przez ClassName::NAME, a od środka przez self::NAME albo static::NAME. Stałe klas mogą mieć widoczność, mogą być final, a od PHP 8.3 mogą deklarować typ.

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

Grupę powiązanych stałych klasy, jak STATUS_NEW i STATUS_PAID, często lepiej zapisać jako enum, który przy okazji nie pozwala przekazywać niepoprawnych wartości.

Stałe magiczne: LINE, FILE, DIR i inne

Stałe magiczne zmieniają wartość w zależności od miejsca, w którym się pojawiają. Są wypełniane przy kompilacji.

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

Najczęściej używana jest __DIR__, czyli katalog bieżącego pliku. Ścieżki do dołączanych plików zbudowane na jej podstawie działają niezależnie od katalogu, z którego uruchomiono skrypt: require __DIR__ . '/config.php';. Pełny wzorzec opisuje strona o include i require.

Wbudowane stałe, które warto znać

PHP definiuje wiele własnych stałych. Te pojawiają się cały czas:

<?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 to znak końca linii systemu, na którym działa PHP ("\n" na Linuksie i macOS, "\r\n" na Windowsie). Służy do tekstu zapisywanego do plików i terminala; w wyjściu HTML znak nowej linii nie jest widoczny, więc tam użyj <br>.