الثوابت في 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 من الداخل. يمكن أن تكون لثوابت الأصناف رؤية (visibility)، ويمكن أن تكون 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__، وهو مجلد الملف الحالي. بناء مسارات التضمين منه يجعلها تعمل أيًا كان المجلد الذي بدأ منه السكربت: 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" على لينكس وmacOS، و"\r\n" على ويندوز). وهو مخصص للنص المكتوب في الملفات والطرفية، أما في مخرجات HTML فالسطر الجديد لا يظهر، فاستخدم <br> هناك.