PHP マニュアル: クラス定数

クラス定数

値が変更できない定数をクラス内に定義することができます。クラス定数のデフォルトのアクセス範囲は public です。

注意:
クラス定数は、子クラスで再定義することもできます。 PHP 8.1.0 以降では、final として定義されたクラス定数は、子クラスで再定義できません。

インターフェイスに定数を持たせることもできます。インターフェイスについてのドキュメントで例を御覧ください。

変数を用いてクラスを参照することも可能です。変数の値に (self や parent、 static といった) キーワードを指定することはできません。

クラス定数はクラス単位で割り当てられるものです。インスタンス単位ではないことに注意しましょう。

PHP 8.3.0 以降では、クラス定数は bool, int, float, string, array のようなスカラー型を持つことができます。 array を使う場合、その内容は他のスカラー型に限ります。

例1 定数の定義と使用

<?php
class MyClass
{
    const CONSTANT = 'constant value';

    function showConstant() {
        echo  self::CONSTANT . "\n";
    }
}

echo MyClass::CONSTANT . "\n";

$classname = "MyClass";
echo $classname::CONSTANT . "\n";

$class = new MyClass();
$class->showConstant();

echo $class::CONSTANT."\n";
?>

特別な ::class 定数を使うと、コンパイル時の完全修飾クラス名が解決できます。これは名前空間クラスに役立ちます。

例2 名前空間の ::class の例

<?php
namespace foo {
    class bar {
    }

    echo bar::class; // foo\bar
}
?>

例3 クラス内での定数式の例

<?php
const ONE = 1;
class foo {
    const TWO = ONE * 2;
    const THREE = ONE + self::TWO;
    const SENTENCE = 'The value of THREE is '.self::THREE;
}
?>

例4 PHP 7.1.0 以降の、クラス定数のアクセス範囲

<?php
class Foo {
    public const BAR = 'bar';
    private const BAZ = 'baz';
}
echo Foo::BAR, PHP_EOL;
echo Foo::BAZ, PHP_EOL;
?>

上の例の PHP 7.1 での出力は、このようになります。

bar

Fatal error: Uncaught Error: Cannot access private const Foo::BAZ in …

注意:
PHP 7.1.0 以降は、クラス定数のアクセス範囲を指定できるようになりました。

例5 PHP 8.3.0 以降で行われる、クラス定数のアクセス権の関係チェック

<?php

interface MyInterface
{
    public const VALUE = 42;
}

class MyClass implements MyInterface
{
    protected const VALUE = 42;
}
?>

上の例の PHP 8.3 での出力は、このようになります。:

Fatal error: Access level to MyClass::VALUE must be public (as in interface MyInterface) …

注意: PHP 8.3.0 以降では、アクセス権の関係がより厳密にチェックされるようになりました。これより前のバージョンでは、クラス定数のアクセス権は、インターフェイスを実装した側の定数のそれと異なっていても問題ありませんでした。

例6 PHP 8.3.0 以降で有効な、クラス定数を取得する文法

<?php
class Foo {
    public const BAR = 'bar';
    private const BAZ = 'baz';
}

$name = 'BAR';
echo Foo::{$name}, PHP_EOL; // bar
?>

注意:
PHP 8.3.0 以降では、クラス定数は変数を使って動的に取得できます。

例7 PHP 8.3.0 以降で有効な、クラス定数の型付け

<?php

class MyClass {
    public const bool MY_BOOL = true;
    public const int MY_INT = 1;
    public const float MY_FLOAT = 1.01;
    public const string MY_STRING = 'one';
    public const array MY_ARRAY = [self::MY_BOOL, self::MY_INT, self::MY_FLOAT, self::MY_STRING];
}

var_dump(MyClass::MY_BOOL);
var_dump(MyClass::MY_INT);
var_dump(MyClass::MY_FLOAT);
var_dump(MyClass::MY_STRING);
var_dump(MyClass::MY_ARRAY);
?>

上の例の PHP 8.3 での出力は、このようになります。:

bool(true)
int(1)
float(1.01)
string(3) "one"
array(4) {
  [0]=>
  bool(true)
  [1]=>
  int(1)
  [2]=>
  float(1.01)
  [3]=>
  string(3) "one"
}