assert
(PHP 4, PHP 5, PHP 7, PHP 8)
assert — Prüft, ob eine Assertion (Zusicherung) false ist
Beschreibung
PHP 5 und 7
PHP 7
assert() überprüft den übergebenen Parameter
assertion (Zusicherung) und führt entsprechende
Maßnahmen durch, wenn das Ergebnis false ist.
Traditionelle Assertions (PHP 5 und 7)
Wird der Parameter assertion als Zeichenkette
übergeben, so wird die Zeichenkette von assert() als
PHP-Code interpretiert. Wenn eine boolesche Bedingung als
assertion übergeben wird, wird diese Bedingung, die
eventuell mit assert_options() definiert wurde, nicht
als Parameter an die Assertion-Funktion weitergegeben. Die Bedingung wird
in eine Zeichenkette umgewandelt, bevor die Handler-Funktion aufgerufen
wird, und das boolesche false wird in eine leere Zeichenkette
umgewandelt.
assert() sollte nur zum Debuggen des Codes verwendet
werden. Es kann für Plausibilitätsprüfungen verwendet werden, um auf
Bedingungen zu prüfen, die immer true sein sollten, und die andernfalls
Programmierfehler anzeigen, oder um auf die Verfügbarkeit bestimmter
Merkmale, wie Erweiterungsfunktionen oder bestimmte Systembeschränkungen
und Eigenschaften, zu prüfen.
Assertions sollten nicht für normale Laufzeitoperationen wie die Überprüfung von Eingaben verwendet werden. Als Faustregel sollte der Code immer korrekt funktionieren können, auch wenn die Assertion-Prüfung deaktiviert ist.
Die Optionen für assert() können über die Funktion assert_options() oder durch .ini-Einstellungen, die in der Handbuchseite dieser Funktion beschrieben werden, konfiguriert werden.
Die Funktion assert_options() und/oder die
Konfigurationsoption ASSERT_CALLBACK ermöglichen es,
eine Funktion anzugeben, die bei fehlgeschlagenen Assertions aufgerufen
wird.
Callback-Funktionen im Zusammenhang mit assert() sind insbesondere nützlich, um beispielsweise automatisierte Tests durchzuführen, da die Callback-Funktion über die Information verfügt, von welcher Stelle sie aufgerufen wurde. Auch wenn diese Information mit anderen Methoden zugänglich ist, macht es die Verwendung von Assertions viel schneller und leichter!
Die Callback-Funktion wird mit drei Parametern aufgerufen. Der erste
Parameter enthält den Namen des Skripts, in dem die Assertion fehlschlug,
der zweite Parameter die Zeilennummer und der dritte Parameter enthält die
über assertion angegebene Bedingung (falls
vorhanden, wobei Literale wie 1 oder "zwei" in diesem Argument nicht
übergeben werden). Nutzer von PHP 5.4.8 und höher können auch ein viertes
optionales Argument angeben, das die Beschreibung
description enthält, die an
assert() übergeben wird.
Expectations (Annahmen) (nur PHP 7)
assert() ist in PHP 7 ein Sprachkonstrukt, das die Definition von Expectations ermöglicht: Assertions, die in Entwicklungs- und Testumgebungen wirken, aber so optimiert werden, dass sie in Produktionsumgebungen keinen Mehraufwand verursachen.
Während assert_options() noch immer verwendet werden kann, um das oben beschriebene Verhalten aus Gründen der Abwärtskompatibilität zu steuern, sollte Code, der nur für PHP 7 geschrieben wird, die beiden neuen Konfigurationsoptionen zur Steuerung von assert() verwenden und nicht assert_options() aufrufen.
| Option | Vorgabewert | Mögliche Werte |
|---|---|---|
| zend.assertions | 1 |
|
| assert.exception | 0 |
|
Parameter-Liste
-
assertion -
Die Assertion. In PHP 5 muss dies entweder ein auszuwertender String sein, oder ein zu testender bool. In PHP 7 kann dies auch ein beliebiger Ausdruck sein, der einen Wert zurückgibt, der ausgeführt und dessen Ergebnis verwendet wird, um anzuzeigen, ob die Zusicherung erfolgreich war oder fehlschlug.
WarnungDie Verwendung eines Strings als
assertionist von PHP 7.2 an MISSBILLIGT und von PHP 8.0.0 an ENTFERNT. -
description -
Eine optionale Beschreibung, die in der Fehlermeldung enthalten ist, wenn die
assertionfehlschlägt. Von PHP 7 an wird, falls keine Beschreibung angegeben wurde, eine Standardbeschreibung, die gleich dem Quellcode des Aufrufs von assert() ist, bereitgestellt. -
exception -
In PHP 7 kann der zweite Parameter ein Throwable-Objekt anstatt eines beschreibenden Strings sein, so dass dieses Objekt als Exception geworfen wird, wenn die Zusicherung fehlschlägt und die Konfigurationsoption assert.exception aktiviert ist.
Rückgabewerte
false, wenn die Assertion nicht erfüllt ist, anderfalls true.
Changelog
| Version | Beschreibung |
|---|---|
| 8.0.0 |
assert() wertet Zeichenketten nicht mehr aus,
sondern behandelt sie stattdessen wie jeden anderen Parameter.
Anstelle von assert('$a == $b') sollte
assert($a == $b) verwendet werden. Die
php.ini-Direktive assert.quiet_eval und die
Konstante ASSERT_QUIET_EVAL wurden ebenfalls
entfernt, da sie keine Auswirkungen mehr haben.
|
| 8.0.0 |
Die Deklaration einer Funktion namens assert()
innerhalb eines Namensraums ist nicht mehr erlaubt und führt zu einem
Fehler der Stufe E_COMPILE_ERROR.
|
| 7.3.0 |
Die Deklaration einer Funktion namens assert()
innerhalb eines Namensraums ist veraltet und gibt nun einen
E_DEPRECATED-Hinweis aus.
|
| 7.2.0 |
Die Verwendung eines Strings als assertion
wird missbilligt. Dies erzeugt nun einen
E_DEPRECATED-Hinweis, wenn sowohl
assert.active als auch
zend.assertions auf
1 gesetzt sind.
|
| 7.0.0 |
assert() ist nun ein Sprachkonstrukt und keine
Funktion mehr. assertion kann nun ein Ausdruck
sein. Der zweite Parameter wird nun entweder als
exception interpretiert (wenn ein
Throwable-Objekt übergeben wird), oder als
description, was ab PHP 5.4.8 unterstützt wird.
|
Beispiele
Traditionelle Assertions (PHP 5 und 7)
Beispiel #1 Überprüfung mit benutzerdefinierter Funktion
<?php
// Assertions aktivieren und stummschalten
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_QUIET_EVAL, 1);
// Eine Handlerfunktion erzeugen
function my_assert_handler($file, $line, $code)
{
echo "<hr>Assertion fehlgeschlagen:
Datei '$file'<br />
Zeile '$line'<br />
Code '$code'<br /><hr />";
}
// Den Callback definieren
assert_options(ASSERT_CALLBACK, 'my_assert_handler');
// Eine Assertion, die fehlschlagen sollte
assert('mysql_query("")');
?>
Beispiel #2 Verwendung eines benutzerdefinierten Handlers um eine Beschreibung anzuzeigen
<?php
// Assertions aktivieren und stummschalten
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_QUIET_EVAL, 1);
// Eine Handlerfunktion erzeugen
function my_assert_handler($file, $line, $code, $desc = null)
{
echo "Assertion fehlgeschlagen in $file:$line: $code";
if ($desc) {
echo ": $desc";
}
echo "\n";
}
// Den Callback definieren
assert_options(ASSERT_CALLBACK, 'my_assert_handler');
// Assertions, die fehlschlagen sollten
assert('2 < 1');
assert('2 < 1', 'Zwei ist kleiner als Eins');
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
Assertion fehlgeschlagen in test.php:21: 2 < 1 Assertion fehlgeschlagen in test.php:22: 2 < 1: Zwei ist kleiner als Eins
Expectations (nur PHP 7)
Beispiel #3 Expectations ohne benutzerdefinierte Exception
<?php
assert(true == false);
echo 'Hi!';
?>
Ist zend.assertions auf 0 gesetzt, gibt das obige Beispiel folgendes aus:
Hi!
Ist zend.assertions auf 1 gesetzt und assert.exception auf 0, gibt das obige Beispiel folgendes aus:
Warning: assert(): assert(true == false) failed in - on line 2 Hi!
Ist zend.assertions auf 1 gesetzt und assert.exception auf 1, gibt das obige Beispiel folgendes aus:
Fatal error: Uncaught AssertionError: assert(true == false) in -:2 Stack trace: #0 -(2): assert(false, 'assert(true == ...') #1 thrown in - on line 2
Beispiel #4 Expectations mit einer benutzerdefinierten Exception
<?php
class CustomError extends AssertionError {}
assert(true == false, new CustomError('True ist nicht false!'));
echo 'Hi!';
?>
Ist zend.assertions auf 0 gesetzt, gibt das obige Beispiel folgendes aus:
Hi!
Ist zend.assertions auf 1 gesetzt und assert.exception auf 0, gibt das obige Beispiel folgendes aus:
Warning: assert(): CustomError: True ist nicht false! in -:4 Stack trace: #0 failed in - on line 4 Hi!
Ist zend.assertions auf 1 gesetzt und assert.exception auf 1, gibt das obige Beispiel aus:
Fatal error: Uncaught CustomError: True ist nicht false! in -:4 Stack trace: #0 thrown in - on line 4
