类 ErrorHandlerMiddleware

错误处理中间件。

捕获异常并使用 CakePHP ExceptionRenderer 将其转换为 HTML 或内容类型合适的错误页面。

命名空间: Cake\Error\Middleware

属性摘要

$_config protected

array<string, mixed>

运行时配置
$_configInitialized protected

bool

配置属性是否已使用默认值配置
$_defaultConfig protected

array<string, mixed>

默认配置值。
$_eventClass protected

string

新事件对象的默认类名。
$_eventManager protected

Cake\Event\EventManagerInterface|null

此对象用于分派内部事件的 Cake\Event\EventManager 实例。
$app protected

Cake\Routing\RoutingApplicationInterface|null
$exceptionTrap protected

Cake\Error\ExceptionTrap|null

ExceptionTrap 实例

方法摘要

__construct() public

构造函数
_configDelete() protected

删除单个配置键。
_configRead() protected

读取配置键。
_configWrite() protected

写入配置键。
configShallow() public

将提供的配置与现有配置合并。与 config()（对嵌套键进行递归合并）不同，此方法进行简单的合并。
dispatchEvent() public

创建和分派事件的包装器。
getConfig() public

返回配置。
getConfigOrFail() public

返回此特定键的配置。
getEventManager() public

返回此对象的 Cake\Event\EventManager 管理器实例。
getExceptionTrap() protected

获取异常陷阱实例
handleException() public

处理异常并生成错误响应
handleInternalError() protected

处理内部错误。
handleRedirect() public

将重定向异常转换为响应。
loadRoutes() protected

确保加载应用程序的路由。
process() public

用错误处理包装剩余的中间件。
setConfig() public

设置配置。
setEventManager() public

返回此对象的 Cake\Event\EventManagerInterface 实例。

方法详细

__construct() ¶ public

__construct(Cake\Error\ExceptionTrap|array $config = [], Cake\Routing\RoutingApplicationInterface|null $app = null)

构造函数

参数

Cake\Error\ExceptionTrap|array $config optional: 错误处理程序实例或配置数组。
Cake\Routing\RoutingApplicationInterface|null $app optional: 应用程序实例。

_configDelete() ¶ protected

_configDelete(string $key): void

删除单个配置键。

参数

string $key: 要删除的键。

void

抛出

Cake\Core\Exception\CakeException
如果尝试覆盖现有配置

_configRead() ¶ protected

_configRead(string|null $key): mixed

读取配置键。

参数

string|null $key: 要读取的键。

mixed

_configWrite() ¶ protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

写入配置键。

参数

array<string, mixed>|string $key: 要写入的键。
mixed $value: 要写入的值。
string|bool $merge optional: True 表示递归合并，'shallow' 表示简单合并，false 表示覆盖，默认为 false。

void

抛出

Cake\Core\Exception\CakeException
如果尝试覆盖现有配置

configShallow() ¶ public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

将提供的配置与现有配置合并。与 config()（对嵌套键进行递归合并）不同，此方法进行简单的合并。

设置特定值

$this->configShallow('key', $value);

设置嵌套值

$this->configShallow('some.nested.key', $value);

同时更新多个配置设置

$this->configShallow(['one' => 'value', 'another' => 'value']);

参数

array<string, mixed>|string $key: 要设置的键，或配置的完整数组。
mixed|null $value optional: 要设置的值。

$this

dispatchEvent() ¶ public

dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>

创建和分派事件的包装器。

返回分派的事件。

参数

string $name: 事件的名称。
array $data optional: 您希望通过此事件传输的任何值，监听器都可以读取。
TSubject|null $subject optional: 此事件适用的对象（默认情况下为 $this）。

Cake\Event\EventInterface<TSubject>

getConfig() ¶ public

getConfig(string|null $key = null, mixed $default = null): mixed

返回配置。

用法

读取整个配置

$this->getConfig();

读取特定值

$this->getConfig('key');

读取嵌套值

$this->getConfig('some.nested.key');

使用默认值读取

$this->getConfig('some-key', 'default-value');

参数

string|null $key optional: 要获取的键，或整个配置的 null。
mixed $default optional: 键不存在时的返回值。

mixed

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

返回此特定键的配置。

此键的配置值必须存在，它不能为 null。

参数

string $key: 要获取的键。

mixed

抛出

InvalidArgumentException

getEventManager() ¶ public

getEventManager(): Cake\Event\EventManagerInterface

返回此对象的 Cake\Event\EventManager 管理器实例。

您可以使用此实例向对象事件注册任何新的监听器或回调，或者创建自己的事件并随意触发它们。

Cake\Event\EventManagerInterface

getExceptionTrap() ¶ protected

getExceptionTrap(): Cake\Error\ExceptionTrap

获取异常陷阱实例

Cake\Error\ExceptionTrap

handleException() ¶ public

handleException(Throwable $exception, Psr\Http\Message\ServerRequestInterface $request): Psr\Http\Message\ResponseInterface

处理异常并生成错误响应

参数

Throwable $exception: 要处理的异常。
Psr\Http\Message\ServerRequestInterface $request: 请求。

Psr\Http\Message\ResponseInterface

handleInternalError() ¶ protected

handleInternalError(): Psr\Http\Message\ResponseInterface

处理内部错误。

Psr\Http\Message\ResponseInterface

handleRedirect() ¶ public

handleRedirect(Cake\Http\Exception\RedirectException $exception): Psr\Http\Message\ResponseInterface

将重定向异常转换为响应。

参数

Cake\Http\Exception\RedirectException $exception: 要处理的异常

Psr\Http\Message\ResponseInterface

loadRoutes() ¶ protected

loadRoutes(): void

确保加载应用程序的路由。

void

process() ¶ public

process(ServerRequestInterface $request, RequestHandlerInterface $handler): Psr\Http\Message\ResponseInterface

用错误处理包装剩余的中间件。

处理传入的服务器请求以生成响应。如果无法自己生成响应，它可能会委托给提供的请求处理程序来执行此操作。

参数

ServerRequestInterface $request: 请求。
RequestHandlerInterface $handler: 请求处理程序。

Psr\Http\Message\ResponseInterface

setConfig() ¶ public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

设置配置。

用法

设置特定值

$this->setConfig('key', $value);

设置嵌套值

$this->setConfig('some.nested.key', $value);

同时更新多个配置设置

$this->setConfig(['one' => 'value', 'another' => 'value']);

参数

array<string, mixed>|string $key: 要设置的键，或配置的完整数组。
mixed|null $value optional: 要设置的值。
bool $merge 可选: 是否递归合并或覆盖现有配置，默认为 true。

$this

抛出

Cake\Core\Exception\CakeException
尝试设置无效键时。

setEventManager() ¶ public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

返回此对象的 Cake\Event\EventManagerInterface 实例。

您可以使用此实例向对象事件注册任何新的监听器或回调，或者创建自己的事件并随意触发它们。

参数

Cake\Event\EventManagerInterface $eventManager: 要设置的事件管理器

$this

属性详情

`$_config` ¶ protected

运行时配置

类型

array<string, mixed>

`$_configInitialized` ¶ protected

配置属性是否已使用默认值配置

类型

bool

`$_defaultConfig` ¶ protected

默认配置值。

如果构造函数传递了一个 ExceptionTrap 实例，则会被忽略。

配置键和值与 ExceptionTrap 共享。如果您使用的是数组样式构造函数，则此类会将它的配置传递给 ExceptionTrap 类。

类型

array<string, mixed>

`$_eventClass` ¶ protected

新事件对象的默认类名。

类型

string

`$_eventManager` ¶ protected

此对象用于分派内部事件的 Cake\Event\EventManager 实例。

类型

Cake\Event\EventManagerInterface|null

`$app` ¶ protected

类型

Cake\Routing\RoutingApplicationInterface|null

`$exceptionTrap` ¶ protected

ExceptionTrap 实例

类型

Cake\Error\ExceptionTrap|null

命名空间

类 ErrorHandlerMiddleware

属性摘要

方法摘要

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

configShallow() public

dispatchEvent() public

getConfig() public

getConfigOrFail() public

getEventManager() public

getExceptionTrap() protected

handleException() public

handleInternalError() protected

handleRedirect() public

loadRoutes() protected

process() public

setConfig() public

setEventManager() public

方法详细

__construct() ¶ public

参数

_configDelete() ¶ protected

参数

返回

抛出

_configRead() ¶ protected

参数

返回

_configWrite() ¶ protected

参数

返回

抛出

configShallow() ¶ public

参数

返回

dispatchEvent() ¶ public

参数

返回

getConfig() ¶ public

用法

参数

返回

getConfigOrFail() ¶ public

参数

返回

抛出

getEventManager() ¶ public

返回

getExceptionTrap() ¶ protected

返回

handleException() ¶ public

参数

返回

handleInternalError() ¶ protected

返回

handleRedirect() ¶ public

参数

返回

loadRoutes() ¶ protected

返回

process() ¶ public

参数

返回

setConfig() ¶ public

用法

参数

返回

抛出

setEventManager() ¶ public

参数

返回

属性详情

$_config ¶ protected

类型

$_configInitialized ¶ protected

类型

$_defaultConfig ¶ protected

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_eventClass` ¶ protected

`$_eventManager` ¶ protected

`$app` ¶ protected

`$exceptionTrap` ¶ protected