PHP Conference Japan 2024

assert_options

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

assert_options设置/获取各种断言标志

警告

此函数自 PHP 8.3.0 起已弃用。强烈建议不要依赖此函数。

描述

assert_options(int $option, mixed $value = ?): mixed

设置各种assert()控制选项,或者仅查询其当前设置。

注意不建议使用assert_options(),而是建议使用ini_set()ini_get()分别设置和获取php.ini指令zend.assertionsassert.exception

参数

option

断言选项
选项 INI 设置 默认值 描述
ASSERT_ACTIVE assert.active 1 启用assert()评估
ASSERT_EXCEPTION assert.exception 1 为每个失败的断言抛出AssertionError
ASSERT_WARNING assert.warning 1 为每个失败的断言发出 PHP 警告
ASSERT_BAIL assert.bail 0 在断言失败时终止执行
ASSERT_QUIET_EVAL assert.quiet_eval 0 在断言表达式评估期间禁用 error_reporting。自 PHP 8.0.0 起移除。
ASSERT_CALLBACK assert.callback (null) 在断言失败时调用的回调函数

value

选项的一个可选新值。

通过ASSERT_CALLBACKassert.callback设置的回调函数应具有以下签名

assert_callback(
    string $file,
    int $line,
    ?string $assertion,
    string $description = ?
): void
file
已调用assert()的文件。
line
已调用assert()的行。
assertion
在 PHP 8.0.0 之前,传递给assert()的断言,但仅当断言作为字符串给出时。(如果断言是布尔条件,则此参数将为空字符串。)自 PHP 8.0.0 起,此参数始终为null
description
传递给assert()的描述。

将空字符串作为value传递会重置断言回调。

返回值

返回任何选项的原始设置。

错误/异常

如果option不是有效的选项,则会抛出ValueError

变更日志

版本 描述
8.3.0 assert_option()现已弃用。
8.0.0 如果option不是有效的选项,则现在会抛出ValueError。以前会返回false

示例

示例 #1 assert_options() 示例

<?php
// 这是我们处理
// 断言失败的函数
function assert_failure($file, $line, $assertion, $message)
{
echo
"断言 $assertion$file$line 行失败: $message";
}

// 这是我们的测试函数
function test_assert($parameter)
{
assert(is_bool($parameter));
}

// 设置我们的断言选项
assert_options(ASSERT_ACTIVE, true);
assert_options(ASSERT_BAIL, true);
assert_options(ASSERT_WARNING, false);
assert_options(ASSERT_CALLBACK, 'assert_failure');

// 进行一个会导致失败的断言
test_assert(1);

// 由于 ASSERT_BAIL
// 为 true,因此永远不会到达这里
echo '从未到达';
?>

参见

添加注释

用户贡献注释 1 条注释

4
Fr?d?ric Bouchery
21 年前
以下是如何使用断言回调函数的示例

<?php
assert_options
( ASSERT_CALLBACK, 'assert_callback');

function
assert_callback( $script, $line, $message ) {
echo
'您的脚本中存在设计错误 <b>', $script,'</b> : 行 <b>', $line,'</b> :<br />';
echo
'<b>', ereg_replace( '^.*//\*', '', $message ), '</b><br /><br />';
echo
'打开源文件并检查它,因为它不是正常行为!';
exit;
}

$x = 3;
assert('is_integer( $x ) && ($x >= 0) && ($x <= 10); //* $x 必须是 0 到 10 之间的整数' );
echo
"0 <= $x <= 10";
?>

断言对于“契约式设计”方法论很有用…
To Top