【PHP8.x】get_declared_traits関数の使い方

作成日: 更新日:

get_declared_traits関数は、PHPにおいて現在スクリプト内で利用可能な、宣言済みのすべてのトレイトの名前のリストを取得する関数です。トレイトは、PHP 5.4以降で導入されたコード再利用の仕組みであり、クラスの継承を補完する形で、メソッドやプロパティの集合を複数のクラスで横断的に利用できるようにするものです。

この関数は引数を一切取らず、呼び出された時点でPHPスクリプト内に定義されているすべてのトレイトの名前を格納した配列を返します。返される配列の各要素は、トレイトの名前(文字列)をキーと値の両方に持ちます。例えば、MyTraitというトレイトが定義されていれば、返される配列には['MyTrait' => 'MyTrait']のようなエントリが含まれます。

システムエンジニアとして開発を進める中で、利用可能なトレイトの一覧を動的に確認したい場合や、リフレクションAPIと組み合わせて特定のトレイトに関する詳細な情報を取得したい場合にこの関数は特に役立ちます。また、フレームワークやライブラリを開発する際に、特定のトレイトがアプリケーション内で利用可能かどうかをチェックし、それに基づいて処理を分岐させるロジックを実装する際にも活用できます。この関数を使うことで、実行時にプログラムの構造を把握し、より柔軟なコード設計を行うことが可能になります。

基本的な使い方

構文(syntax)

<?php

trait ExampleTraitA {
    // トレイトの定義
}

trait ExampleTraitB {
    // トレイトの定義
}

$declaredTraits = get_declared_traits();
print_r($declaredTraits);

?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

array

定義済みのすべてのトレイト(trait)の名前を文字列の配列として返します。

【PHP8.x】get_declared_traits関数の使い方 | いっしー@Webエンジニア