Konstanta PHP: define() vs const dan Magic Constant

Konstanta adalah nama untuk nilai yang tidak pernah berubah selama script berjalan. Deklarasikan dengan const MAX_USERS = 100; atau define('MAX_USERS', 100);, lalu pakai namanya saja, tanpa $.

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

Menurut konvensi, nama konstanta ditulis UPPER_SNAKE_CASE. Konstanta bersifat global: konstanta yang dideklarasikan di bagian atas file terlihat di dalam setiap fungsi tanpa global.

define() vs const

Keduanya membuat konstanta, tetapi bekerja pada waktu yang berbeda. const diproses saat PHP mengompilasi file, sedangkan define() berjalan seperti panggilan fungsi lainnya.

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

Pakai const sebagai pilihan utama, karena lebih pendek dan diperiksa saat kompilasi. Pakai define() saat konstanta bergantung pada sebuah kondisi atau nama yang dihitung.

Konstanta tidak bisa diubah

Mengisi nilai ke konstanta menghasilkan parse error:

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

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

Mendefinisikan konstanta yang sama dua kali bukan error, tetapi PHP mencetak warning dan menyimpan nilai yang pertama:

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

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

Saat sebuah nilai mungkin sudah di-set (misalnya di file konfigurasi yang dimuat lebih dari sekali), periksa dulu dengan 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";

Konstanta array

Konstanta bisa berisi array. Kamu bisa membacanya dengan NAME[key], menelusurinya dengan loop, dan mengirimnya ke mana-mana, tetapi tidak bisa mengubahnya.

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

Konstanta class

Di dalam class, const mendeklarasikan konstanta milik class itu. Baca dengan ClassName::NAME dari luar, dan self::NAME atau static::NAME dari dalam. Konstanta class bisa punya visibilitas, bisa final, dan sejak PHP 8.3 bisa mendeklarasikan tipe.

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

Sekelompok konstanta class yang berkaitan seperti STATUS_NEW dan STATUS_PAID sering kali lebih baik ditulis sebagai enum, yang juga mencegah nilai yang tidak valid dikirim ke mana-mana.

Magic constant: LINE, FILE, DIR, dan lainnya

Nilai magic constant berubah tergantung tempat ia muncul. Nilainya diisi saat kompilasi.

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

Yang paling sering dipakai adalah __DIR__, direktori dari file saat ini. Menyusun path include dari konstanta ini membuat path-nya tetap bekerja dari direktori mana pun script dijalankan: require __DIR__ . '/config.php';. Lihat include dan require untuk pola lengkapnya.

Konstanta bawaan yang perlu kamu tahu

PHP mendefinisikan banyak konstanta sendiri. Yang berikut ini sering sekali muncul:

<?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 adalah akhir baris dari sistem tempat PHP berjalan ("\n" di Linux dan macOS, "\r\n" di Windows). Konstanta ini dimaksudkan untuk teks yang ditulis ke file dan terminal; di output HTML, baris baru tidak terlihat, jadi pakai <br> di sana.