As noted on Wikipedia - "assertions are primarily a development tool, they are often disabled when a program is released to the public." and "Assertions should be used to document logically impossible situations and discover programming errors— if the 'impossible' occurs, then something fundamental is clearly wrong. This is distinct from error handling: most error conditions are possible, although some may be extremely unlikely to occur in practice. Using assertions as a general-purpose error handling mechanism is usually unwise: assertions do not allow for graceful recovery from errors, and an assertion failure will often halt the program's execution abruptly. Assertions also do not display a user-friendly error message."
This means that the advice given by "gk at proliberty dot com" to force assertions to be enabled, even when they have been disabled manually, goes against best practices of only using them as a development tool.
assert
(PHP 4, PHP 5, PHP 7, PHP 8)
assert — Vérifie si une assertion est fausse
Description
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.
Assertions traditionnelles (PHP 5 et 7)
Si assertion est donnée sous la forme d'une chaîne de caractères,
elle sera évaluée en tant que code PHP par assert().
Si une condition booléenne est donnée 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 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ébogage. 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.
Expectations (PHP 7 seulement)
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 |
|
Liste de paramètres
-
assertion -
L'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é.
AvertissementL'utilisation d'une chaîne de caractères en tant qu'
assertionest OBSOLÈTE à partir de PHP 7.2. -
description -
Une description optionnelle, qui sera incluse dans le message d'échec si l'
assertionéchoue. À partir de PHP 7, si aucune description est fournie, une description par défaut identique au code source de l'invocation de assert() est fournie. -
exception -
En 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.
Valeurs de retour
false si l'assertion est fausse, true sinon.
Historique
| Version | Description |
|---|---|
| 8.0.0 |
Déclarer une fonction qui s'appelle assert() à
l'intérieur d'un espace de nom n'est plus autorisé, et génère
une E_COMPILE_ERROR.
|
| 7.3.0 |
Déclarer une fonction qui s'appelle assert() à
l'intérieur d'un espace de nom est devenue obsolète. De telle
déclarations génère désormais une E_DEPRECATED.
|
| 7.2.0 |
L'utilisation d'une chaîne de caractères en tant qu'assertion est
est devenue obsolète. Ceci émet désormais une notice
E_DEPRECATED quand
assert.active et
zend.assertions sont tous
les deux définit à 1.
|
| 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 ultérieur.
|
Exemples
Assertions traditionnelles (PHP 5 et 7)
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
Expectations (PHP 7 seulement)
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
add a note
User Contributed Notes 8 notes
hodgman at ali dot com dot au ¶
15 years ago
mail<at>aaron-mueller.de ¶
17 years ago
Here is a simple demonstration of Design By Contract with PHP
<?php
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_BAIL, 1);
assert_options(ASSERT_CALLBACK, 'dcb_callback');
function dcb_callback($script, $line, $message) {
echo "<h1>Condition failed!</h1><br />
Script: <strong>$script</strong><br />
Line: <strong>$line</strong><br />
Condition: <br /><pre>$message</pre>";
}
// Parameters
$a = 5;
$b = 'Simple DCB with PHP';
// Pre-Condition
assert('
is_integer($a) &&
($a > 0) &&
($a < 20) &&
is_string($b) &&
(strlen($b) > 5);
');
// Function
function combine($a, $b) {
return "Kombined: " . $b . $a;
}
$result = combine($a, $b);
// Post-Condition
assert('
is_string($result) &&
(strlen($result) > 0);
');
// All right, the Function works fine
var_dump($result);
?>
Krzysztof 'ChanibaL' Bociurko ¶
16 years ago
Note that func_get_args() should be used carefully and never in a string! For example:
<?php
function asserted_normal($a, $b) {
assert(var_dump(func_get_args()));
}
function asserted_string($a, $b) {
assert('var_dump(func_get_args())');
}
?>
<?php asserted_normal(1,2) ?> prints
array(2) {
[0]=>
int(1)
[1]=>
int(2)
}
but <?php asserted_string(3,4) ?> prints
array(1) {
[0]=>
string(25) "var_dump(func_get_args())"
}
This is because of that the string passed to assert() is being evaled inside assert, and not your function. Also, note that this works correctly, because of the eval scope:
<?php
function asserted_evaled_string($a, $b) {
assert(eval('var_dump(func_get_args())'));
}
asserted_evaled_string(5,6);
?>
array(2) {
[0]=>
int(5)
[1]=>
int(6)
}
(oh, and for simplicity's sake the evaled code doesn't return true, so don't worry that it fails assertion...)
Tom ¶
4 years ago
When migrating older code to PHP 7.2+, you may get E_DEPRECATED warnings for every call to assert() you ever wrote, urging you to not pass the assertion as a string.
It may be tempting to just run a regular expression across your files to convert all strings within "assert(...)" to statements. But, before you do that, be aware of the following caveat!
For example, this code simply asserts that $input is not empty.
assert('$input;');
This works, because the string passed to assert() is evaluated as a PHP statement and the result cast to Boolean.
If you want to have an equivalent statement that doesn't pass the first parameter as a string, your regular expression should rewrite this statement as:
assert((bool) ($input));
However, this looks a bit bulky and it is tempting to instead opt for the more direct approach to convert the above line to this:
assert($input);
But! This new statement will do one of three things:
1) Looks as if it worked as intended because $input just happens to be Boolean to begin with
2) Throw a parse error if $input is a string (best case)
3) Allow an attacker on a poorly configured server to execute arbitrary PHP-Code (worst case)
The reason is that, even though on PHP 7.2+ a E_DEPRECATED warning is raised, if assert() finds the first parameter to be a string, it will still execute it as PHP-Code, just as if it was called with a string to begin with.
If an attacker finds a way to manipulate the contents of $input, you might end up with a remote code execution vulnerability. So just be extra careful when migrating assertions.
jason at jaypha dot com ¶
6 years ago
You can take advantage of how assert is handled to use it for crude conditional compilation.
For example
<?php
assert(print("Some debug message\n"));
assert(($val = "dev") || true);
?>
Since print() always returns 1, the topmost assertion will pass. For others, you may need to add a || true. Always enclose the expression in ().
In a development environment where zend.assertions=1, the above code will execute. In production environments where zend.assertions=-1, it wont even compile, thus not burdening performance.
Another, more real world, example.
<?php
$cssSrc = 'https://code.jquery.com/jquery-3.2.1.min.js';
assert(($cssSrc = 'http://dev.local/jquery-3.2.1.js') || true);
echo "<link rel='stylesheet' type='text/css' href='$cssSrc'/>\n";
?>
In a production environment, The website will use the minified version from the CDN. In a development environment, a development version, sourced locally, will be used instead.
Note: This will not work for everything. Only code that can be embedded in an expression will work.
uramihsayibok, gmail, com ¶
13 years ago
There's a nice advantage to giving assert() some code to execute, as a string, rather than a simple true/false value: commenting.
<?php
assert('is_int($int) /* $int parameter must be an int, not just numeric */');
// and my personal favorite
assert('false /* not yet implemented */');
?>
The comment will show up in the output (or in your assertion handler) and doesn't require someone debugging to go through your code trying to figure out why the assertion happened. That's no excuse to not comment your code, of course.
You need to use a block comment (/*...*/) because a line comment (//...) creates an "unexpected $end" parse error in the evaluated code. Bug? Could be.
(You can get around it with "false // not yet implemented\n" but that screws up the message)
Ben ¶
7 years ago
if there was no 'warning' message when assertion failed (FALSE), try reset the error handler:
<?php
set_error_handler ( null );
office dot stojmenovic at gmail dot com ¶
10 years ago
Example from Ikac Framework how they use assert()
<?php
/**
* Set Assertion Debug
*
* This method will check the given assertion and take appropriate -
* action if its result is FALSE.
*
* This file is part of Ikac Framework.
*
* @package Ikac Framework
* @author Ivan Stojmenovic Ikac <contact.@stojmenovic.info>
*
* @param mixed $assertion The assertion.
* @param mixed $callback Callback to call on failed assertions
* @param array $options Set the various control options or just query their current settings.
* @param string $description An optional description that will be included in the failure message if the assertion fails.
*/
public function setAssertionDebug($assertion, $callback, array $options, $description = null)
{
if (is_array($options)) {
foreach ($options AS $option => $value) {
assert_options($option, $value);
}
}
if ($callback) {
assert_options(ASSERT_CALLBACK, $callback);
}
return assert($assertion, $description);
}
?>
How to use:
<?php
use Ikac\Component\SystemBehaviour\OptionsInfo;
$system = new OptionsInfo();
$option = array(ASSERT_ACTIVE => 1,ASSERT_WARNING => 0,ASSERT_QUIET_EVAL => 1);
$system->setAssertionDebug('2<1', function(){
echo "Assertion failed";
}, $option);
?>
