Hằng số trong PHP: define() và const, magic constant

Hằng số (constant) là tên cho một giá trị không bao giờ thay đổi trong khi script chạy. Khai báo bằng const MAX_USERS = 100; hoặc define('MAX_USERS', 100);, rồi dùng tên trần, không có $.

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

Theo quy ước, tên hằng số được viết dạng UPPER_SNAKE_CASE. Hằng số có phạm vi toàn cục: một hằng số khai báo ở đầu tệp sẽ thấy được bên trong mọi hàm mà không cần global.

define() và const

Cả hai đều tạo hằng số, nhưng chúng hoạt động vào những thời điểm khác nhau. const được xử lý khi PHP biên dịch tệp, còn define() chạy như mọi lời gọi hàm khác.

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

Mặc định hãy dùng const, vì nó ngắn hơn và được kiểm tra lúc biên dịch. Dùng define() khi hằng số phụ thuộc vào một điều kiện hoặc một tên được tính ra.

Hằng số không thể thay đổi

Gán giá trị cho một hằng số là lỗi cú pháp (parse error):

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

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

Định nghĩa cùng một hằng số hai lần thì không phải lỗi, nhưng PHP in ra cảnh báo và giữ giá trị đầu tiên:

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

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

Khi một giá trị có thể đã được đặt từ trước (ví dụ trong một tệp cấu hình được nạp nhiều lần), hãy kiểm tra bằng defined() trước:

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

Hằng số mảng

Hằng số có thể chứa một mảng. Bạn đọc được nó bằng NAME[key], duyệt qua nó và truyền nó đi khắp nơi, nhưng không sửa được.

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

Hằng số lớp

Bên trong một lớp, const khai báo một hằng số thuộc về lớp đó. Đọc nó bằng ClassName::NAME từ bên ngoài và bằng self::NAME hoặc static::NAME từ bên trong. Hằng số lớp có thể có phạm vi truy cập, có thể là final, và từ PHP 8.3 có thể khai báo kiểu.

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

Một nhóm hằng số lớp liên quan như STATUS_NEW và STATUS_PAID thường nên viết thành một enum, cách này còn ngăn các giá trị không hợp lệ bị truyền đi khắp nơi.

Magic constant: LINE, FILE, DIR và các hằng số khác

Magic constant đổi giá trị tùy theo nơi chúng xuất hiện. Giá trị của chúng được điền vào lúc biên dịch.

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

Hằng số được dùng nhiều nhất là __DIR__, thư mục của tệp hiện tại. Tạo đường dẫn include từ nó giúp đường dẫn luôn đúng, bất kể script được chạy từ thư mục nào: require __DIR__ . '/config.php';. Xem cách làm đầy đủ ở trang include và require.

Những hằng số có sẵn nên biết

PHP định nghĩa sẵn rất nhiều hằng số. Đây là những hằng số bạn sẽ gặp thường xuyên:

<?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 là ký tự xuống dòng của hệ thống mà PHP đang chạy ("\n" trên Linux và macOS, "\r\n" trên Windows). Nó dành cho văn bản ghi ra tệp và terminal; trong đầu ra HTML, ký tự xuống dòng không hiển thị, nên ở đó hãy dùng <br>.