Reserved/exceptions-Phpdoc专题

预定义异常

Exception — Exception
- Exception::__construct — 异常构造函数
- Exception::getMessage — 获取异常消息内容
- Exception::getPrevious — 返回异常链中的前一个异常
- Exception::getCode — 获取异常代码
- Exception::getFile — 创建异常时的程序文件名称
- Exception::getLine — 获取创建的异常所在文件中的行号
- Exception::getTrace — 获取异常追踪信息
- Exception::getTraceAsString — 获取字符串类型的异常追踪信息
- Exception::__toString — 将异常对象转换为字符串
- Exception::__clone — 异常克隆
ErrorException — ErrorException
- ErrorException::__construct — 构造一个异常（Exception）
- ErrorException::getSeverity — 获取异常的严重程度
Error — Error
- Error::__construct — 初始化 error 对象
- Error::getMessage — 获取错误信息
- Error::getPrevious — 返回先前的 Throwable
- Error::getCode — 获取错误代码
- Error::getFile — 获取错误发生时的文件
- Error::getLine — 获取错误发生时的行号
- Error::getTrace — 获取调用栈（stack trace）
- Error::getTraceAsString — 获取字符串形式的调用栈（stack trace）
- Error::__toString — error 的字符串表达
- Error::__clone — 克隆 error
ArgumentCountError — ArgumentCountError
ArithmeticError — ArithmeticError
AssertionError — AssertionError
DivisionByZeroError — DivisionByZeroError
CompileError — CompileError
ParseError — ParseError
TypeError — TypeError

参见 SPL 异常处理

简介

Exception是所有异常的基类。

类摘要

Exception

class Exception {

/* 属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 方法 */

final public string getMessage ( void )

final public Throwable getPrevious ( void )

final public mixed getCode ( void )

final public string getFile ( void )

final public int getLine ( void )

final public array getTrace ( void )

final public string getTraceAsString ( void )

public string __toString ( void )

final private void __clone ( void )

}

属性

message
异常消息内容

code
异常代码

file
抛出异常的文件名

line
抛出异常在该文件中的行号

简介

错误异常。

类摘要

ErrorException

class ErrorException extends Exception {

/* 属性 */

protected int $severity ;

/* 方法 */

public __construct ([ string $message = "" [, int $code = 0 [, int $severity = E_ERROR [, string $filename = __FILE__ [, int $lineno = __LINE__ [, Exception $previous = null ]]]]]] )

final public int getSeverity ( void )

/* 继承的方法 */

final public string Exception::getMessage ( void )

final public Throwable Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

}

属性

severity
异常级别

范例

示例 #1 使用set_error_handler函数将错误信息托管至ErrorException

<?php
function exception_error_handler($errno, $errstr, $errfile, $errline ) {
    throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
}
set_error_handler("exception_error_handler");

/* Trigger exception */
strpos();
?>

以上例程的输出类似于：

Fatal error: Uncaught exception 'ErrorException' with message 'Wrong parameter count for strpos()' in /home/bjori/tmp/ex.php:8
Stack trace:
#0 [internal function]: exception_error_handler(2, 'Wrong parameter...', '/home/bjori/php...', 8, Array)
#1 /home/bjori/php/cleandocs/test.php(8): strpos()
#2 {main}
  thrown in /home/bjori/tmp/ex.php on line 8

简介

Error 是所有PHP内部错误类的基类。

类摘要

Error

class Error implements Throwable {

/* 属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 方法 */

final public string getMessage ( void )

final public Throwable getPrevious ( void )

final public mixed getCode ( void )

final public string getFile ( void )

final public int getLine ( void )

final public array getTrace ( void )

final public string getTraceAsString ( void )

public string __toString ( void )

final private void __clone ( void )

}

属性

message
错误消息内容

code
错误代码

file
抛出错误的文件名

line
抛出错误的行数

简介

ArgumentCountError 当传递给用户定义的函数或方法的参数太少时被抛出。

类摘要

ArgumentCountError

class ArgumentCountError extends TypeError {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Error::getMessage ( void )

final public Throwable Error::getPrevious ( void )

final public mixed Error::getCode ( void )

final public string Error::getFile ( void )

final public int Error::getLine ( void )

final public array Error::getTrace ( void )

final public string Error::getTraceAsString ( void )

public string Error::__toString ( void )

final private void Error::__clone ( void )

}

简介

ArithmeticError 当执行数学运算时发生错误时被抛出。PHP 7.0 these errors include attempting to perform a bitshift by a negative amount, and any call to intdiv that would result in a value outside the possible bounds of an integer.

类摘要

ArithmeticError

class ArithmeticError extends Error {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Error::getMessage ( void )

final public Throwable Error::getPrevious ( void )

final public mixed Error::getCode ( void )

final public string Error::getFile ( void )

final public int Error::getLine ( void )

final public array Error::getTrace ( void )

final public string Error::getTraceAsString ( void )

public string Error::__toString ( void )

final private void Error::__clone ( void )

}

简介

AssertionError 在函数 assert 断言失败时被抛出。

类摘要

AssertionError

class AssertionError extends Error {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Error::getMessage ( void )

final public Throwable Error::getPrevious ( void )

final public mixed Error::getCode ( void )

final public string Error::getFile ( void )

final public int Error::getLine ( void )

final public array Error::getTrace ( void )

final public string Error::getTraceAsString ( void )

public string Error::__toString ( void )

final private void Error::__clone ( void )

}

简介

DivisionByZeroError 当除数为零时被抛出。

类摘要

DivisionByZeroError

class DivisionByZeroError extends ArithmeticError {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Error::getMessage ( void )

final public Throwable Error::getPrevious ( void )

final public mixed Error::getCode ( void )

final public string Error::getFile ( void )

final public int Error::getLine ( void )

final public array Error::getTrace ( void )

final public string Error::getTraceAsString ( void )

public string Error::__toString ( void )

final private void Error::__clone ( void )

}

简介

CompileError 是针对一些编译错误抛出的，之前是会发出致命错误。

类摘要

CompileError

class CompileError extends Error {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Error::getMessage ( void )

final public Throwable Error::getPrevious ( void )

final public mixed Error::getCode ( void )

final public string Error::getFile ( void )

final public int Error::getLine ( void )

final public array Error::getTrace ( void )

final public string Error::getTraceAsString ( void )

public string Error::__toString ( void )

final private void Error::__clone ( void )

}

简介

ParseError 当解析 PHP 代码时发生错误时抛出，比如当 eval被调用出错时。

Note: 从 PHP 7.3.0 开始，ParseError 继承自 CompileError。之前的版本，则继承自 Error。

类摘要

ParseError

class ParseError extends CompileError {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Error::getMessage ( void )

final public Throwable Error::getPrevious ( void )

final public mixed Error::getCode ( void )

final public string Error::getFile ( void )

final public int Error::getLine ( void )

final public array Error::getTrace ( void )

final public string Error::getTraceAsString ( void )

public string Error::__toString ( void )

final private void Error::__clone ( void )

}

简介

有三种情况会抛出 TypeError。第一种，传递给函数的参数类型与函数预期声明的参数类型不匹配；第二种，函数返回的值与声明的函数返回类型不匹配；第三种，调用 PHP 内置函数时，传递了非法的数字参数（仅限在严格模式下 / strict mode）。

类摘要

TypeError

class TypeError extends Error {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Error::getMessage ( void )

final public Throwable Error::getPrevious ( void )

final public mixed Error::getCode ( void )

final public string Error::getFile ( void )

final public int Error::getLine ( void )

final public array Error::getTrace ( void )

final public string Error::getTraceAsString ( void )

public string Error::__toString ( void )

final private void Error::__clone ( void )

}