Annotations PHP

Les annotations PHP sont essentiellement des métadonnées qui peuvent être incluses dans le code source ainsi qu'entre les classes, fonctions, propriétés et méthodes. Ils doivent commencer par le préfixe @ partout où ils sont déclarés et indiquent quelque chose de spécifique. Ces informations qu'ils fournissent sont très utiles aux codeurs, utiles à des fins de documentation et un IDE peut également les utiliser pour afficher certains types d'indices contextuels. La même annotation peut également être utilisée à d'autres fins que la validation, par exemple pour déterminer le type d'entrée à fournir dans un formulaire et également à des fins d'automatisation. Il existe différents types d'annotations comme les types @var et @int qui peuvent être utilisées pour des usages spécifiques comme leur nom lui-même l'indique.

PUBLICITÉ Cours populaire dans cette catégorie DEVELOPPEUR PHP - Spécialisation | Série de 8 cours | 3 tests simulés

Commencez votre cours de développement de logiciels libres

Développement Web, langages de programmation, tests de logiciels et autres

Syntaxe

Les annotations PHP sont utilisées en donnant le préfixe @ et sa syntaxe est la suivante :

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

L'annotation est @var ici et chaque fois qu'elle est rencontrée juste avant le morceau de code (public $new ici par exemple), elle indique que le $new doit avoir une valeur de type entier comme indiqué par l'annotation.

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

Les annotations peuvent également être utilisées pour spécifier la plage dans laquelle elles affiche les valeurs maximales et minimales qui doivent être acceptées comme valeurs entières pour la fonction et l'étiquette donne le but de cette fonction.

Types d'annotations PHP

Vous trouverez ci-dessous les types :

1. Annotations intégrées

Il existe 2 fonctions intégrées dans les annotations qui sont les suivantes :

a. Compilé : Cette annotation indique si la méthode/fonction doit être compilée JIT ou non. Il s'agit également d'un type d'annotation de portée de fonction.

b. SuppressWarnings : Il s'agit d'une autre annotation intégrée qui signifie que tous les avertissements émis dans le cadre de l'exécution du code suivant en dessous doivent être supprimés.

2. Méta-annotations

Ce sont ces types d'annotations qui peuvent être utilisées pour postuler à d'autres annotations. Ils sont utilisés pour la configuration des annotations.

a. @Annotations

Il existe une sorte de classes d'annotation qui contiendront @annotation.

Code :

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

b. @Cible

Comme son nom l'indique, cette annotation indique les types d'éléments de classe ou une méthode sur lesquels l'annotation sera applicable.

Sur cela nous pouvons décrire une ou plusieurs cibles :

• L'annotation de propriété se trouve juste avant la déclaration de la classe de propriété.
• Classe autorisée avant la déclaration de classe.
• La fonction est déclarée avant la déclaration de la fonction.
• L'annotation de méthode permet de procéder à la déclaration de la méthode.
• L'annotation est autorisée pour procéder à la déclaration de la classe d'annotation.

c. @Répétable

Cette annotation signifie qu'elle peut être répétée autant de fois qu'elle est utilisée.

d. @Hérité

Ceci peut également être utilisé sur les autres classes d'annotations définies par l'utilisateur en tant que méta-annotation. Ces annotations héritées sont automatiquement héritées des sous-classes respectives lorsqu'elles sont utilisées sur une superclasse.

3. Annotations personnalisées

Celles-ci sont très similaires aux déclarations de la classe normale. Chaque élément du type annotation est défini par chacune des déclarations de propriété.

Exemples d'annotations PHP

Vous trouverez ci-dessous les exemples mentionnés :

Exemple n°1

Code :

// 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;
}
}

Ceci n'est qu'un exemple de base montrant l'utilisation de tous les différents types d'annotations présentés ci-dessus. Tous ceux de l'exemple comme l'annotation intégrée, l'annotation de propriété, l'annotation de méthode sont des annotations personnalisées.

Exemple n°2

Code :

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

Sortie :

Dans cet exemple, nous nommons l'annotation replace puisque le code ci-dessous représente l'utilisation de la fonction de remplacement de chaîne qui est str_replace, une fonction intégrée de PHP. Grâce à cette fonction, le premier paramètre passé dans la fonction est remplacé par le second.

Exemple #3

Code :

<!DOCTYPE html>
<html>
<head>
<title>Simple Form Processing</title>
</head>
<body>
<h1>Form Processing using PHP</h1>
<fieldset>
<form id="formex1" method="post" action="formexample.php">
<!--Declaring First name for the form
@Annotation text first_name-->
First_Name:
<input type="text" name="First_Name"/>
<!--@var style color-->
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring Last_Name for the form
@Annotation text last_name-->
Last_Name:
<input type="text" name="last_name"/>
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring Location for the form
@Annotation text location-->
Stay location:
<input type="text" name="location"/>
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring EMAILID for the form
@Annotation text email-->
EmailID:
<input type="email" name="emailID"/>
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring Password for the form
@Annotation password-->
Password:
<input type="password" name="password"/>
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring Password for the form
@Radio button password-->
Gender:
<!-- Gender to be selected as either male or female -->
<input type="radio"
value="Male"
name="gender"> Male
<input type="radio"
value="Female"
name="gender">Female
<br>
<br>
<input type="confirm" value="confirm" name="confirm" />
</form>
</fieldset>
<?php
if(example($_POST['confirm']))
{
if(!example($error))
{
echo"<h1>DETAILS RECEIVED</h1><br>";
echo "<table border='2'>";
echo "<thead>";
echo "<th>Argument</th>";
echo "<th>Value</th>";
echo "</thead>";
echo "<tr>";
echo "<td>First Name</td>";
echo "<td>".$First_Name."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Last_Name</td>";
echo "<td>".$last_name."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Stay location</td>";
echo "<td>".$location."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Email Stay location</td>";
echo "<td>" .$emailID."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Password</td>";
echo "<td>".$password."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Gender</td>";
echo "<td>".$gender."</td>";
echo "</tr>";
echo "</table>";
}
}
?>
</body>
</html>

Sortie :

Dans cet exemple, nous affichons les annotations en combinaison avec la validation du formulaire en PHP. À l'aide d'annotations, nous étiquetons tous les paramètres requis comme paramètres d'entrée du formulaire, tels que le prénom et le nom, l'e-mail, l'emplacement et le mot de passe.

Conclusion

Avec les exemples ci-dessus, nous avons remarqué à quel point les annotations sont un outil puissant pour utiliser et exprimer des métadonnées sur nos méthodes, classes ou propriétés. Nous avons également vu comment combiner différents types d'annotations pour déclarer les travailleurs qui effectueront certaines tâches en écrivant des métadonnées à leur sujet. Cela les rend faciles à trouver et donne des informations réelles indiquant s'ils peuvent ou non être utilisés.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!