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

同じ定数を2回定義してもエラーにはなりませんが、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が動いているシステムの改行コードです（LinuxとmacOSでは"\n"、Windowsでは"\r\n"）。ファイルやターミナルに書き出すテキスト向けで、HTMLの出力では改行は表示されないので、そこでは<br>を使います。