(PHP 4, PHP 5, PHP 7)
assert — Vérifie si une assertion est fausse
PHP 5 et 7
PHP 7
assert() va vérifier l'assertion
assertion et prendre la mesure appropriée
si le résultat est FALSE.
Si assertion est donnée sous la forme
d'une chaîne, elle sera évaluée comme un code PHP
par la fonction assert(). Les avantages de ce type
d'assertion sont d'être moins lourd si la vérification
d'assertion est désactivée, et les messages contenant l'assertion
lorsque l'assertion échoue. Cela signifie que si vous passez une condition
booléenne en tant qu'assertion, cette condition ne sera pas considérée
comme un paramètre par la fonction d'assertion que vous avez définie avec
la fonction assert_options(), la condition est convertie
en chaîne de caractères avant l'appel à ce gestionnaire de fonction, et le booléen FALSE
sera converti en chaîne de caractères vide.
Il est recommandé de n'utiliser les assertions que comme outil de déboguage. Vous pouvez les utiliser pour les vérifications d'usage : ces conditions doivent normalement être vraies, et indiquer une erreur de programmation si ce n'est pas le cas. Vous pouvez aussi vérifier la présence de certaines extensions ou limitations du système.
Les assertions ne doivent pas être utilisées pour faire des opérations de vérifications en production, comme des vérifications de valeur d'argument. En conditions normales, votre code doit être en état de fonctionner si la vérification d'assertion est désactivée.
Le comportement de assert() peut être configuré par assert_options() ou par les directives de configuration décrites dans la page de manuel de cette fonction.
La fonction assert_options() et la directive
ASSERT_CALLBACK permettent de configurer une
fonction qui sera appelée lorsque l'assertion échoue.
Les fonctions de rappel pour assert() sont particulièrement utiles pour bâtir des suites de tests automatiques, car elles vous permettent de capturer facilement le code passé à l'assertion, ainsi que des informations sur le lieu et le moment de l'assertion. Même si ces informations peuvent être appelées par d'autres méthodes, les assertions sont plus rapides et plus faciles.
La fonction de rappel doit accepter trois arguments. Le premier
contient le nom du fichier qui a vu l'assertion échouer. Le second
contient le numéro de ligne dans le fichier précédent.
Le troisième argument contient l'expression qui a échoué (s'il
y en a : les valeurs littérales — comme 1 ou "deux" ne seront
pas passées par cet argument). Les utilisateurs de PHP 5.4.8 ou supérieur
peuvent également fournir un quatrième argument optionnel, qui contiendra
la description fournie à la fonction
assert(), s'il est défini.
assert() est une construction de langage en PHP 7, autorisé pour la définition des expectations : les assertions qui prennent effet dans les environnements de développement et de test, mais qui sont optimisées de sorte à avoir un coût zéro en production.
Bien que assert_options() peut toujours être utilisé pour contrôler le comportement tel que décrit ci-dessus pour des raisons de compatibilité ascendante, le code purement PHP 7 doit utiliser les deux nouvelles directives de configuration pour contrôler le comportement de la fonction assert() et ne pas appeler la fonction assert_options().
| Directive | Valeur par défaut | Valeurs possibles |
|---|---|---|
| zend.assertions | 1 |
|
| assert.exception | 0 |
|
assertionL'assertion. En PHP 5, ceci peut être soit une chaîne de caractères à évaluer, soit un booléen à tester. En PHP 7, ceci peut également être toute expression qui retourne une valeur, qui peut être exécuté et le résultat utilisé pour indiquer si l'assertion a réussi ou a échoué.
description
Une description optionnelle, qui sera incluse dans le message
d'échec si l'assertion échoue.
exceptionEn PHP 7, le second paramètre peut être un objet Throwable au lieu d'une chaîne descriptive, auquel cas, ceci sera un objet qui sera lancé si l'assertion échoue et que la directive de configuration assert.exception est activée.
FALSE si l'assertion est fausse, TRUE sinon.
| Version | Description |
|---|---|
| 7.0.0 |
assert() est maintenant une construction de langage
et non une fonction. assertion() peut maintenant
être une expression. Le second paramètre est maintenant interprété
soit comme une exception (si un objet
Throwable est fourni), soit comme une
description supportée depuis PHP 5.4.8 et suivants.
|
| 5.4.8 |
La paramètre description a été ajoutée.
La description est également maintenant fournie
à la fonction de rappel en mode ASSERT_CALLBACK
comme quatrième argument.
|
Exemple #1 Gestion des assertions avec un gestionnaire personnalisé
<?php
// Activation des assertions et mise en mode discret
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_QUIET_EVAL, 1);
// Création d'un gestionnaire d'assertions
function my_assert_handler($file, $line, $code)
{
echo "<hr>Échec de l'assertion :
File '$file'<br />
Line '$line'<br />
Code '$code'<br /><hr />";
}
// Configuration de la méthode de callback
assert_options(ASSERT_CALLBACK, 'my_assert_handler');
// Utilisation d'une assertion qui va échouer
assert('mysql_query("")');
?>
Exemple #2 Utilisation d'un gestionnaire personnalisé pour afficher une description
<?php
// Activation de l'assertion et on le rend silencieux
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_QUIET_EVAL, 1);
// Création d'une fonction de gestionnaire
function my_assert_handler($file, $line, $code, $desc = null)
{
echo "Echec de l'assertion : $file:$line: $code";
if ($desc) {
echo ": $desc";
}
echo "\n";
}
// Définition de la fonction de rappel
assert_options(ASSERT_CALLBACK, 'my_assert_handler');
// Effectue une assertion qui doit échouer
assert('2 < 1');
assert('2 < 1', 'Deux est inférieur à un');
?>
L'exemple ci-dessus va afficher :
Echec de l'assertion : test.php:21: 2 < 1 Echec de l'assertion : test.php:22: 2 < 1: Deux est inférieur à un
Exemple #3 Expectations sans exception personalisée
<?php
assert(true == false);
echo 'Hi!';
?>
Avec zend.assertions défini à 0, l'exemple ci-dessus afficherait :
Hi!
Avec zend.assertions défini à 1 et assert.exception défini à 0, l'exemple ci-dessus afficherait :
Warning: assert(): assert(true == false) failed in - on line 2 Hi!
AVec zend.assertions défini à 1 et assert.exception défini à 1, l'exemple ci-dessus afficherait :
Fatal error: Uncaught AssertionError: assert(true == false) in -:2
Stack trace:
#0 -(2): assert(false, 'assert(true == ...')
#1 {main}
thrown in - on line 2
Exemple #4 Expectations avec une exception personalisée
<?php
class CustomError extends AssertionError {}
assert(true == false, new CustomError('True is not false!'));
echo 'Hi!';
?>
Avec zend.assertions défini à 0, l'exemple ci-dessus afficherait :
Hi!
Avec zend.assertions défini à 1 et assert.exception défini à 0, l'exemple ci-dessus afficherait :
Warning: assert(): CustomError: True is not false! in -:4
Stack trace:
#0 {main} failed in - on line 4
Hi!
Avec zend.assertions défini à 1 et assert.exception défini à 1, l'exemple ci-dessus afficherait :
Fatal error: Uncaught CustomError: True is not false! in -:4
Stack trace:
#0 {main}
thrown in - on line 4