値が変更できない定数をクラス内に定義することができます。 定数は、通常の変数とは異なり、定義または使用する際に $ 記号を付けません。 クラス定数のデフォルトのアクセス範囲は public です。
定義する値は定数表現である必要があり、(例えば)変数・プロパティ あるいは関数のコールなどであってはいけません。
インターフェイスに 定数 を持たせることもできます。 インターフェイスについてのドキュメント で例をごらんください。
PHP 5.3.0 以降では、変数を用いてクラスを参照することも可能です。 変数の値に (self や parent、 static といった) キーワードを指定することはできません。
クラス定数はクラス単位で割り当てられるものです。インスタンス単位ではないことに注意しましょう。
例1 定数の定義と使用
<?php
class MyClass
{
const CONSTANT = 'constant value';
function showConstant() {
echo self::CONSTANT . "\n";
}
}
echo MyClass::CONSTANT . "\n";
$classname = "MyClass";
echo $classname::CONSTANT . "\n"; // PHP 5.3.0 以降で対応
$class = new MyClass();
$class->showConstant();
echo $class::CONSTANT."\n"; // PHP 5.3.0 以降で対応
?>
例2 静的なデータの例
<?php
class foo {
// PHP 5.3.0 以降で対応
const BAR = <<<'EOT'
bar
EOT;
// PHP 5.3.0 以降で対応
const BAZ = <<<EOT
baz
EOT;
}
?>
注意:
ヒアドキュメントや Nowdoc を用いた定数の初期化は PHP 5.3.0 以降で使えるようになりました。
PHP 5.5.0 以降では、特別な ::class 定数が使用可能です。
この定数により、コンパイル時の完全修飾クラス名が解決できます。
これは名前空間クラスに役立ちます。
例3 名前空間の ::class の例
<?php
namespace foo {
class bar {
}
echo bar::class; // foo\bar
}
?>
例4 定数式の例
<?php
const ONE = 1;
class foo {
// PHP 5.6.0 以降
const TWO = ONE * 2;
const THREE = ONE + self::TWO;
const SENTENCE = 'The value of THREE is '.self::THREE;
}
?>
クラス定数のコンテキストで、数値リテラルや文字列リテラルそして定数を含むスカラー式を指定できます。
注意:
定数における式のサポートは PHP 5.6.0 で追加されました。
例5 クラス定数のアクセス範囲
<?php
class Foo {
// PHP 7.1.0 以降
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 以降は、クラス定数のアクセス範囲を指定できるようになりました。