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

作成日: 更新日:

get_declared_interfaces関数は、現在実行中のPHPスクリプトで宣言されているすべてのインターフェースの名前を取得する関数です。この関数はPHPの組み込み(internal)関数であり、追加のモジュールをインストールすることなく利用できます。引数は必要ありません。

この関数を実行すると、interfaceキーワードを使って定義された、PHPの環境内で利用可能なすべてのインターフェースの名前が、文字列の配列として返されます。例えば、大規模なアプリケーションを開発している際や、複数のライブラリを使用している状況で、どのインターフェースが既に読み込まれていて利用可能なのかを確認したい場合に非常に便利です。

戻り値は、宣言されているインターフェースの名前が要素として格納された配列です。もし、現時点で宣言されているインターフェースが一つも存在しない場合は、空の配列が返されます。この機能は、アプリケーションのデバッグ作業において、特定のインターフェースが正しくロードされているかを確認したり、リフレクション機能と組み合わせて動的にインターフェースの情報を取得・分析したりする際に役立ちます。インターフェースの名前は、大文字と小文字を区別しない文字列として扱われます。また、この関数はクラスやトレイトの名前は含まないため、純粋にインターフェースのみを対象とした正確な情報を提供します。これにより、プログラムの実行時に存在するインターフェースの全体像を把握し、より堅牢なコードを記述するための手助けとなります。

基本的な使い方

構文(syntax)

<?php

$declaredInterfaces = get_declared_interfaces();
print_r($declaredInterfaces);

?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

array

定義済みのすべてのインターフェースの名前を格納した配列を返します。

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