קבועים ב-PHP: define() מול const וקבועי קסם

קבוע הוא שם לערך שאף פעם לא משתנה בזמן שהסקריפט רץ. מגדירים אותו עם const MAX_USERS = 100; או define('MAX_USERS', 100);, ואז משתמשים בשם עצמו, בלי $.

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

לפי המוסכמה, שמות קבועים נכתבים ב-UPPER_SNAKE_CASE. הם גלובליים: קבוע שהוגדר בראש קובץ גלוי בתוך כל פונקציה בלי global.

define() מול const

שניהם יוצרים קבוע, אבל הם פועלים בזמנים שונים. const נפתר כש-PHP מהדרת את הקובץ, define() רצה כמו כל קריאה לפונקציה.

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

השתמשו ב-const כברירת מחדל, כי הוא קצר יותר ונבדק בזמן הידור. השתמשו ב-define() כשהקבוע תלוי בתנאי או בשם מחושב.

אי אפשר לשנות קבועים

הצבה לקבוע היא שגיאת תחביר:

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

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

הגדרה של אותו קבוע פעמיים היא לא שגיאה, אבל PHP מדפיסה אזהרה ושומרת את הערך הראשון:

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

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

כשערך אולי כבר מוגדר (למשל בקובץ הגדרות שנטען יותר מפעם אחת), בדקו קודם עם 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";

מערכים קבועים

קבוע יכול להכיל מערך. אפשר לקרוא אותו עם NAME[key], לעבור עליו בלולאה ולהעביר אותו הלאה, אבל לא לשנות אותו.

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

קבועי מחלקה

בתוך מחלקה, const מגדיר קבוע ששייך למחלקה. קוראים אותו עם ClassName::NAME מבחוץ ועם self::NAME או static::NAME מבפנים. לקבועי מחלקה יכולה להיות רמת גישה, הם יכולים להיות final, ומאז PHP 8.3 הם יכולים להצהיר על טיפוס.

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

קבוצה של קבועי מחלקה קשורים כמו STATUS_NEW ו-STATUS_PAID עדיף לעיתים קרובות לכתוב כ-enum, שגם מונע העברה של ערכים לא תקינים.

קבועי קסם: LINE, FILE, DIR ועוד

קבועי קסם משנים את הערך שלהם לפי המקום שבו הם מופיעים. הם מתמלאים בזמן הידור.

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

הנפוץ ביותר הוא __DIR__, התיקייה של הקובץ הנוכחי. בניית נתיבי include ממנו גורמת להם לעבוד לא משנה מאיזו תיקייה הסקריפט הופעל: require __DIR__ . '/config.php';. ראו include ו-require לדפוס המלא.

קבועים מובנים שכדאי להכיר

PHP מגדירה הרבה קבועים משלה. אלה עולים כל הזמן:

<?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 הוא סוף השורה של המערכת ש-PHP רצה עליה ("\n" ב-Linux וב-macOS, "\r\n" ב-Windows). הוא מיועד לטקסט שנכתב לקבצים ולטרמינל; בפלט HTML ירידת שורה לא נראית, אז השתמשו שם ב-<br>.