assert

(PHP 4, PHP 5, PHP 7, PHP 8)

assert — Verifica se un'asserzione è false

Descrizione

PHP 5

assert(mixed $assertion, string $description = ?): bool

PHP 7

assert(mixed $assertion, Throwable $exception = ?): bool

assert() verifica l' assertion data e prende gli opportuni provvedimenti se il suo risultato è false.

Asserzioni tradizionali (PHP 5 e 7)

Se il parametro assertion è una stringa, verrà valutata come codice PHP da assert(). I vantaggi di usare le stringhe con assertion sono meno overhead nella verifica e la visualizzazione dei messaggi che contengono assertion quando questa fallisce. Ciò significa che se si passa una condizione booleana come assertion, questa condizione non sarà mostrata come parametro della funzione di asserzione che può essere definita con la funzione assert_options(), la condizione è convertita in una stringa prima di chiamare la funzione handler, e il valore booleano false viene convertito in una stringa vuota.

Le asserzioni dovrebbero essere utilizzate solo per il debug. Si possono usare per controlli di coerenza che testano per condizioni che dovrebbero essere sempre true e che, in caso contrario, indichino errori di programmazione, oppure per verificare la presenza o meno di certe caratteristiche, tipo le estensioni, oppure certi limiti di sistema o caratteristiche.

Le asserzioni non dovrebbero essere utilizzate per le normali operazioni di runtime quali il controllo dei parametri di input. Come regola si deve avere che il programma debba funzionare correttamente anche disabilitando le regole di asserzione.

Il comportamento di assert() può essere impostato tramite assert_options() oppure tramite .ini-settings come descritto nelle pagine del manuale relative a quelle funzioni.

La funzione assert_options() e/o il parametro ASSERT_CALLBACK permettono/e di attivare una funzione di callback per gestire una asserzione fallita.

Le callback di assert() sono particolarmente utili per costruire suite di test poiché permettono di catturare facilmente il codice passato all'assert, oltre alle informazioni su dove l'assert è scattato. Sebbene quest'ultime informazioni siano rilevabili anche con altri metodi, l'uso delle asserzione rende il tutto molto più veloce e semplice!

Le funzioni di callback devono accettare tre parametri. Il primo conterrà il nome del file in cui si trova l'asserzione fallita. Il secondo parametro conterrà il numero di linea dell'asserzione fallita, ed il terzo parametro conterrà l'espressione dell'asserzione fallita (se qualsiasi — valore letterale come 1 o "due" non verrà passato con questo parametro). Gli utenti di PHP 5.4.8 e successivi possono anche fornire un quarto parametro opzionale, che conterrà la description data all'assert(), se è stata impostata.

Aspettative (solo PHP 7)

assert() è un costrutto del linguaggio in PHP 7, consentendo la definizione delle aspettative: asserzioni che hanno effetto in ambienti di sviluppo e di test, ma sono ottimizzate per avere un costo zero in produzione.

Mentre assert_options() può ancora essere utilizzata per controllare il comportamento come sopra descritto per ragioni di retrocompatibilità, il codice solo per PHP 7 dovrebbe usare le due nuove direttive di configurazione per controllare il comportamento di assert() e non chiamare assert_options().

Direttive di configurazione di PHP 7 per **assert()**
Direttiva	Valore predefinito	Valori possibili
zend.assertions	`1`	`1`: genera ed esegue il codice (modalità di sviluppo) `0`: genera il codice ma lo salta in fase di runtime `-1`: non genera il codice (modalità di produzione)
assert.exception	`0`	`1`: segnala quando l'asserzione fallisce, o sollevando l'oggetto fornito come `exception` o sollevando un nuovo oggetto AssertionError se `exception` non è stato fornito `0`: utilizza o genera un Throwable come descritto sopra, ma genera solo un warning basato su quell'oggetto al posto di sollevarlo (compatibile con il comportamento di PHP 5)

Elenco dei parametri

assertion: L'asserzione. In PHP 5, questo deve essere o una string da essere valutata o un boolean da testare. In PHP 7, questo può anche essere qualsiasi espressione che restituisce un valore, che verrà eseguita e il risultato usato per indicare se l'asserzione è riuscita o meno.
description: Una descrizione opzionale che sarà inclusa nel messaggio di fallimento se l'assertion fallisce.
exception: In PHP 7, il secondo parametro può essere un oggetto Throwable al posto di una string descrittiva, nel qual caso questo è l'oggetto che sarà sollevato se l'asserzione fallisce e la direttiva di configurazione assert.exception è abilitata.

Valori restituiti

false se l'asserzione è false, true in caso contrario.

Log delle modifiche

Versione	Descrizione
7.0.0	assert() è ora un costrutto del linguaggio e non una funzione. assertion() ora può essere usata come un'espressione. Il secondo parametro è ora interpretato o come un `exception` (se viene passato un oggettoThrowable), o come la `description` supportato da PHP 5.4.8 in poi.
5.4.8	È stato aggiunto il parametro `description`. La `description` è anche ora fornita ad una funzione di callback in modalità `ASSERT_CALLBACK` come quarto parametro.

Esempi

Asserzioni tradizionali (PHP 5 e 7)

Example #1 Gestione di un'asserzione fallita con un handler personalizzato

<?php
// Attiva l'asserzione e la rende silenziosa
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_QUIET_EVAL, 1);

// Crea una funzione handler
function my_assert_handler($file, $line, $code)
{
    echo "<hr>Assertion Failed:
        File '$file'<br />
        Line '$line'<br />
        Code '$code'<br /><hr />";
}

// Imposta la callback
assert_options(ASSERT_CALLBACK, 'my_assert_handler');

// Fa un'asserzione che dovrebbe fallire
assert('mysql_query("")');
?>

Example #2 Uso di un gestore personalizzato per stampare una descrizione

<?php
// Attiva l'asserzione e la rende silenziosa
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_QUIET_EVAL, 1);

// Crea una funzione handler
function my_assert_handler($file, $line, $code, $desc = null)
{
    echo "Assertion failed at $file:$line: $code";
    if ($desc) {
        echo ": $desc";
    }
    echo "\n";
}

// Imposta la callback
assert_options(ASSERT_CALLBACK, 'my_assert_handler');

// Fa un'asserzione che dovrebbe fallire
assert('2 < 1');
assert('2 < 1', 'Two is less than one');
?>

Il precedente esempio visualizzerà:

 Assertion failed at test.php:21: 2 < 1
 Assertion failed at test.php:22: 2 < 1: Two is less than one

Aspettative (solo PHP 7)

Example #3 Aspettative senza un'eccezione personalizzata

<?php
assert(true == false);
echo 'Hi!';
?>

Con zend.assertions impostato a 0, l'esempio di sopra stamperà:

Hi!

Con zend.assertions impostato a 1 e assert.exception impostato a 0, l'esempio di sopra stamperà:

Warning: assert(): assert(true == false) failed in - on line 2
Hi!

Con zend.assertions impostato a 1 e assert.exception impostato a 1, l'esempio di sopra stamperà:

Fatal error: Uncaught AssertionError: assert(true == false) in -:2
Stack trace:
#0 -(2): assert(false, 'assert(true == ...')
#1 {main}
  thrown in - on line 2

Example #4 Aspettative con un'eccezione personalizzata

<?php
class CustomError extends AssertionError {}

assert(true == false, new CustomError('True is not false!'));
echo 'Hi!';
?>

Con zend.assertions impostato a 0, l'esempio di sopra stamperà:

Hi!

Con zend.assertions impostato a 1 e assert.exception impostato a 0, l'esempio di sopra stamperà:

Warning: assert(): CustomError: True is not false! in -:4
Stack trace:
#0 {main} failed in - on line 4
Hi!

Con zend.assertions impostato a 1 e assert.exception impostato a 1, l'esempio di sopra stamperà:

Fatal error: Uncaught CustomError: True is not false! in -:4
Stack trace:
#0 {main}
  thrown in - on line 4

Vedere anche:

assert_options() - Imposta/ottiene vari parametri per assert

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

hodgman at ali dot com dot au ¶

16 years ago

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.

down

sven at rtbg dot de ¶

8 months ago

With the current changes made in PHP 8.3 (deprecating the INI settings affecting assertions) and the increasing amount of open source libraries utilizing `assert()` as an easy means to ensure obscure return cases of PHP core function calls are in fact not triggered (e.g. no NULL or FALSE has been returned, but the useful value), the comment made about assertions only being a tool used during development should be considered invalid.

In addition, static code analysis tools use the knowledge gained from `assert($x instanceof MyClass)` to know the type or types that are possible.

Assertions are actively being used in production code, they are useful, and disabling them would only gain minimal performance benefits because the asserted expression usually is very small.

Use this tool where applicable!

＋add a note