PHP アノテーション

PHP アノテーションは基本的に、ソース コードに含めることができるメタデータであり、クラス、関数、プロパティ、メソッドの間にも含めることができます。これらは宣言される場合はどこでも接頭辞 @ で始まり、何か特定のものを示します。彼らが提供するこの情報は、プログラマーにとって非常に役立ち、ドキュメント化の目的にも役立ちます。また、IDE はこれを使用して特定のポップアップ ヒントの種類のものを表示することもあります。同じアノテーションは、フォームにどのような入力を行う必要があるかを判断するなど、検証以外の目的や自動化の目的にも使用できます。 @var 型や @int 型など、その名前が示すように特定の用途に使用できるさまざまな種類のアノテーションがあります。

広告 このカテゴリーの人気コース PHP 開発者 - 専門分野 | 8コースシリーズ | 3 つの模擬テスト

無料ソフトウェア開発コースを始めましょう

Web 開発、プログラミング言語、ソフトウェア テスト、その他

構文

PHP アノテーションは @ プレフィックスを付けることで使用され、その構文は次のとおりです。

class Example
{
// @var integer
public $new;
}

ここではアノテーションは @var であり、コードの一部 (ここでは public $new など) の直前に出現するたびに、$new がアノテーションによって指示された整数型の値を持つことを示します。

class Example
{
// @var integer
// @range(0, 51)
// @label('Count of shops')
public $shop;
}

注釈は、関数の整数値として受け入れられる最大値と最小値を表示する範囲を指定するためにも使用でき、ラベルはこの関数の目的を示します。

PHP アノテーションの種類

以下にタイプを示します:

1.組み込みの注釈

アノテーションには次の 2 つの組み込み関数があります:

a. Compiled: この注釈は、メソッド/関数を JIT コンパイルする必要があるかどうかを示します。これは、関数スコープ型のアノテーションでもあります。

b. SuppressWarnings: これは、その下にある後続コードの実行の一部としてスローされる警告を抑制する必要があることを意味する別の組み込みアノテーションです。

2.メタアノテーション

これらは、他の注釈に適用するために使用できるタイプの注釈です。これらは、注釈の構成に使用されます。

a. @アノテーション

@annotation を含む一種のアノテーション クラスがあります。

コード:

[@Annotation]
class MyAnnoExample {
// piece of code
}

b. @ターゲット

名前が示すように、このアノテーションは、アノテーションが適用されるクラス要素またはメソッドのタイプを示します。

これに基づいて、1 つまたは複数のターゲットを記述することができます:

• プロパティのアノテーションは、プロパティ クラス宣言の直前にあります。
• クラスの宣言前に許可されるクラス。
• 関数は関数宣言の前に宣言されています。
• メソッド アノテーションを使用すると、メソッド宣言を続行できます。
• アノテーションクラスの宣言に進むためにアノテーションが許可されています。

c. @Repeatable

この注釈は、使用時に何度でも繰り返してよいことを意味します。

d. @継承

これは、他のユーザー定義のアノテーション クラスでもメタ アノテーションとして使用できます。これらの継承されたアノテーションは、スーパークラスで使用されると、それぞれのサブクラスに自動的に継承されます。

3.カスタム注釈

これらは、通常のクラスの宣言と非常に似ています。注釈型の各要素は、それぞれのプロパティ宣言によって定義されます。

PHP アノテーションの例

言及されている例を以下に示します:

例 #1

コード:

// namespace declaration here
[@Annotation]
[@Target("class")]
class MyAnnoEx {
[@Required]
public string $prop;
public array $arrayProp = [];
public embedAnno $embed;
}
[@Annotation]
// code for embedded annotation goes here
[@Target(["class", "annotation"])]
class embedAnno {
}
[@Annotation]
// example for target annotation
[@Target("property")]
class propAnno {
}
@Annotation
// code for method annotation goes here
@Target("method")
class methodAnno {
public string $val;
public function __construct(string $val) {
$this->val = $val;
}
}

これは、上に示したさまざまなタイプの注釈の使用法を示す単なる基本的な例です。例にある埋め込みアノテーション、プロパティ アノテーション、メソッド アノテーションなどはすべてカスタム アノテーションです。

例 #2

コード:

<?php /**
* @Replace("exmaple", "for", "annotation")
*/
class MyNamedComponent
{
}
echo str_replace("First", "Second", "First Example");
?>

出力:

この例では、以下のコードが PHP の組み込み関数 str_replace である文字列置換関数の使用法を表しているため、アノテーションに replace という名前を付けています。この関数を使用すると、関数に渡された最初のパラメータが 2 番目のパラメータに置き換えられます。

例 #3

コード:

<title>Simple Form Processing</title>


<h1 id="Form-Processing-using-PHP">Form Processing using PHP</h1>

First_Name: *

Last_Name: *

Stay location: *

EmailID: *

Password: *

Gender: Male Female

DETAILS RECEIVED
"; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo ""; echo "

Argument	Value
First Name	".$First_Name."
Last_Name	".$last_name."
Stay location	".$location."
Email Stay location	" .$emailID."
Password	".$password."
Gender	".$gender."

"; } } ?>

出力:

この例では、PHP のフォーム検証と組み合わせた注釈を示しています。注釈を使用して、姓名、電子メール、場所、パスワードなど、フォームへの入力パラメータとして必要なすべてのパラメータにラベルを付けています。

結論

上記の例では、アノテーションがメソッド、クラス、またはプロパティに関するメタデータを使用および表現するための強力なツールであることがわかりました。また、さまざまな種類のアノテーションを組み合わせて、特定のタスクを実行するワーカーに関するメタデータを記述することでワーカーを宣言する方法も見てきました。これにより、それらを見つけやすくなり、使用できるかどうかに関する実際の情報が得られます。

以上がPHP アノテーションの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。