Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

assert

Description

The assert of Options / Information for PHP checks if assertion is false.

Syntax

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

Parameters

assertion

The assertion.

In PHP 5, this must be either a string to be evaluated or a bool to be tested.

In PHP 7, this may also be any expression that returns a value, which will be executed and the result used to indicate whether the assertion succeeded or failed.

Warning Using string as the assertion is DEPRECATED as of PHP 7.2.0 and REMOVED as of PHP 8.0.0.

description

An optional description that will be included in the failure message if the assertion fails.

From PHP 7, if no description is provided, a default description equal to the source code for the invocation of assert() is provided.

exception

In PHP 7, the second parameter can be a Throwable object instead of a descriptive string, in which case this is the object that will be thrown if the assertion fails and the assert.exception configuration directive is enabled.

Return

false if the assertion is false, true otherwise.

Examples

1 · assertion

<?

$assertion = true == false;

$return = assert($assertion);

var_export($return);

?>

2 · description

<?

$assertion = true == false;
$description = 'true is false';

$return = assert($assertion, $desctiption);

var_export($return);

?>

3 · exception

<?

class MyClass extends AssertionError{}

$assertion = true == false;
$exception = new MyClass('true is false');

$return = assert($assertion, $exception);

var_export($return);

?>
HomeMenu