PHP-Anmerkungen

PHP-Annotationen sind grundsätzlich Metadaten, die in den Quellcode und auch zwischen Klassen, Funktionen, Eigenschaften und Methoden eingefügt werden können. Sie sind überall dort, wo sie deklariert werden, mit dem Präfix @ zu beginnen und weisen auf etwas Bestimmtes hin. Diese von ihnen bereitgestellten Informationen sind für Programmierer sehr nützlich und für Dokumentationszwecke hilfreich. Eine IDE kann sie auch verwenden, um bestimmte Popup-Hinweise anzuzeigen. Dieselbe Annotation kann neben der Validierung auch für andere Zwecke verwendet werden, z. B. um zu bestimmen, welche Art von Eingabe in ein Formular eingegeben werden muss, und auch für Automatisierungszwecke. Es gibt verschiedene Arten von Annotationen wie die Typen @var und @int, die, wie der Name schon sagt, für bestimmte Zwecke verwendet werden können.

Starten Sie Ihren kostenlosen Softwareentwicklungskurs

Webentwicklung, Programmiersprachen, Softwaretests und andere

Syntax

PHP-Annotationen werden mit dem Präfix @ verwendet und haben die folgende Syntax:

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

Annotation ist hier @var und wann immer sie direkt vor dem Teil eines Codes angetroffen wird (public $new hier zum Beispiel), zeigt sie an, dass $new einen Wert vom Typ Integer haben soll, wie in der Annotation angegeben.

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

Anmerkungen können auch zur Angabe des Bereichs verwendet werden, in dem die Maximal- und Minimalwerte angezeigt werden, die als Ganzzahlwerte für die Funktion akzeptiert werden sollen, und die Beschriftung gibt den Zweck dieser Funktion an.

Arten von PHP-Anmerkungen

Nachfolgend sind die Typen aufgeführt:

1. Integrierte Anmerkungen

Es gibt zwei integrierte Funktionen in Anmerkungen, die wie folgt lauten:

a. Kompiliert: Diese Anmerkung gibt an, ob die Methode/Funktion JIT-kompiliert werden soll oder nicht. Es handelt sich auch um eine Annotation vom Typ „Funktionsbereich“.

b. SuppressWarnings: Dies ist eine weitere integrierte Annotation, die bedeutet, dass alle Warnungen, die im Rahmen der Ausführung des nachfolgenden Codes darunter ausgegeben werden, unterdrückt werden müssen.

2. Meta-Anmerkungen

Dies sind Anmerkungen, die für andere Anmerkungen verwendet werden können. Sie werden zur Konfiguration von Anmerkungen verwendet.

a. @Annotations

Es gibt eine Art Annotationsklasse, die @annotation enthält.

Code:

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

b. @Target

Wie der Name schon sagt, gibt diese Annotation die Arten von Klassenelementen oder eine Methode an, auf die die Annotation anwendbar ist.

Auf dieser Grundlage können wir ein oder mehrere Ziele beschreiben:

• Eigenschaftsanmerkungen stehen direkt vor der Eigenschaftsklassendeklaration.
• Klasse, die vor der Klassendeklaration zulässig ist.
• Funktion wird vor der Funktionsdeklaration deklariert.
• Methodenannotation ermöglicht das Fortfahren der Methodendeklaration.
• Annotationen sind zulässig, um mit der Deklaration der Annotationsklasse fortzufahren.

c. @Repeatable

Diese Anmerkung bedeutet, dass sie bei der Verwendung beliebig oft wiederholt werden kann.

d. @Inherited

Dies kann auch für die anderen benutzerdefinierten Annotationsklassen als Meta-Annotation verwendet werden. Diese geerbten Anmerkungen werden automatisch an die jeweiligen Unterklassen vererbt, wenn sie für eine Oberklasse verwendet werden.

3. Benutzerdefinierte Anmerkungen

Diese sind Deklarationen der normalen Klasse sehr ähnlich. Jedes Element des Annotationstyps wird durch jede der Eigenschaftsdeklarationen definiert.

Beispiele für PHP-Anmerkungen

Im Folgenden finden Sie die genannten Beispiele:

Beispiel #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;
}
}

Dies ist nur ein einfaches Beispiel, das die Verwendung aller oben gezeigten verschiedenen Arten von Anmerkungen zeigt. Alle im Beispiel enthaltenen Anmerkungen wie Einbettungsanmerkungen, Eigenschaftsanmerkungen und Methodenanmerkungen sind benutzerdefinierte Anmerkungen.

Beispiel #2

Code:

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

Ausgabe:

In diesem Beispiel nennen wir die Annotation „replace“, da der folgende Code die Verwendung der String-Replace-Funktion darstellt, die str_replace ist, eine integrierte Funktion von PHP. Mit dieser Funktion wird der erste in der Funktion übergebene Parameter durch den zweiten ersetzt.

Beispiel #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>

Ausgabe:

In diesem Beispiel zeigen wir Annotationen in Kombination mit der Formularvalidierung in PHP. Mithilfe von Anmerkungen kennzeichnen wir alle Parameter, die als Eingabeparameter für das Formular erforderlich sind, wie z. B. Vor- und Nachname, E-Mail, Standort und Passwort.

Fazit

Anhand der obigen Beispiele haben wir festgestellt, dass Annotationen ein leistungsstarkes Werkzeug sind, um Metadaten über unsere Methoden, Klassen oder Eigenschaften zu verwenden und auszudrücken. Wir haben auch gesehen, wie man verschiedene Arten von Anmerkungen kombiniert, um Arbeiter zu deklarieren, die bestimmte Aufgaben ausführen, indem man einige Metadaten über sie schreibt. Dies macht sie leicht auffindbar und gibt konkrete Informationen darüber, ob sie verwendet werden können oder nicht.

Das obige ist der detaillierte Inhalt vonPHP-Anmerkungen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!