Spec-Zone.ru › CakePHP 4.2

Класс BaseErrorHandler

Базовый обработчик ошибок, предоставляющий логику, общую для обработчиков ошибок CLI и веб-приложений.

Подклассы должны реализовать методы шаблонов для обработки отображения ошибок в своей среде.

Абстрактный
Пространство имён: Cake\Error

Краткое описание свойств

  • $_config protected
    array

    Конфигурация выполнения

  • $_configInitialized protected
    bool

    Указание того, была ли конфигурация свойства уже настроена по умолчанию

  • $_defaultConfig protected
    array

    Параметры для обработки ошибок.

  • $_handled protected
    bool
  • $logger protected
    Cake\Error\ErrorLoggerInterface|null

    Экземпляр регистратора исключений.

Краткое описание методов

  • _configDelete() protected

    Удаляет единственный ключ конфигурации.

  • _configRead() protected

    Считывает ключ конфигурации.

  • _configWrite() protected

    Записывает ключ конфигурации.

  • _displayError() abstract protected

    Отображает сообщение об ошибке специфичным для среды способом.

  • _displayException() abstract protected

    Отображает исключение специфичным для среды способом.

  • _logError() protected

    Записывает ошибку в журнал.

  • _stop() protected

    Останавливает процесс.

  • configShallow() public

    Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

  • getConfig() public

    Возвращает конфигурацию.

  • getConfigOrFail() public

    Возвращает конфигурацию для конкретного ключа.

  • getLogger() public

    Получает регистратор исключений.

  • handleError() public

    Устанавливается в качестве обработчика ошибок по умолчанию CakePHP.

  • handleException() public

    Обрабатывает неперехваченные исключения.

  • handleFatalError() public

    Отображает/Записывает в журнал критическую ошибку.

  • increaseMemoryLimit() public

    Увеличивает настройку PHP "memory_limit" в ini-файле на указанную величину в килобайтах.

  • logException() public

    Записывает ошибку для исключения, если применимо.

  • mapErrorCode() public static

    Преобразует код ошибки в слово ошибки и местоположение записи в журнал.

  • register() public

    Регистрирует обработчики ошибок и исключений.

  • setConfig() public

    Устанавливает конфигурацию.

  • wrapAndHandleException() public deprecated

    Проверяет тип переданного исключения. Если это экземпляр Error, то он оборачивает переданный объект внутри другого объекта исключения для обеспечения обратной совместимости.

Подробное описание методов

_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(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

bool|string $merge необязательно

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписи существующей конфигурации

_displayError() abstract protected 

_displayError(array $error, bool $debug): void

Отображает сообщение об ошибке в зависимости от среды.

Подклассы должны реализовывать этот метод для отображения ошибки в соответствии с требуемой средой выполнения.

Параметры

array $error

Массив данных об ошибке.

bool $debug

Флаг включения режима отладки.

Возвращает

void

_displayException() abstract protected 

_displayException(Throwable $exception): void

Отображает исключение в зависимости от среды.

Подклассы должны реализовывать этот метод для отображения необработанного исключения в соответствии с требуемой средой выполнения.

Параметры

Throwable $exception

Необработанное исключение.

Возвращает

void

_logError() protected 

_logError(int|string $level, array $data): bool

Записывает ошибку в журнал.

Параметры

int|string $level

Уровень лога.

array $data

Массив данных об ошибке.

Возвращает

bool

_stop() protected 

_stop(int $code): void

Останавливает процесс.

Реализовано в подклассах, где это необходимо.

Параметры

int $code

Код завершения.

Возвращает

void

configShallow() public 

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

Сливает предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка конкретного значения:

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

Установка вложенного значения:

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

Обновление нескольких настроек конфигурации одновременно:

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

Параметры

string|array $key

Ключ для установки или массив конфигурации.

mixed|null $value необязательно

Значение для установки.

Возвращает

$this

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 необязательно

Ключ для получения или null для всей конфигурации.

mixed $default необязательно

Значение по умолчанию, если ключ не найден.

Возвращает

mixed

getConfigOrFail() public 

getConfigOrFail(string $key): mixed

Возвращает значение конфигурации для данного ключа.

Значение конфигурации для данного ключа должно существовать, оно никогда не может быть null.

Параметры

string $key

Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

getLogger() public 

getLogger(): Cake\Error\ErrorLoggerInterface

Получить логгер исключений.

Возвращает

Cake\Error\ErrorLoggerInterface

handleError() public 

handleError(int $code, string $description, string|null $file = null, int|null $line = null, array|null $context = null): bool

Установлен как обработчик ошибок по умолчанию в CakePHP.

Используйте config/error.php для настройки или замены этого обработчика ошибок. Эта функция будет использовать Debugger для отображения ошибок в режиме отладки. И будет записывать ошибки в Log, когда режим отладки выключен.

Можно использовать опцию 'errorLevel' для настройки типов обрабатываемых ошибок. Стек вызовов для ошибок может быть включен с помощью опции 'trace'.

Параметры

int $code

Код ошибки

string $description

Описание ошибки

string|null $file необязательно

Файл, в котором произошла ошибка

int|null $line необязательно

Строка, вызвавшая ошибку

array|null $context необязательно

Контекст

Возвращает

bool

handleException() public 

handleException(Throwable $exception): void

Обработка необработанных исключений.

Использует метод шаблона, предоставляемый подклассами, для отображения ошибок соответствующим образом.

Параметры

Throwable $exception

Экземпляр исключения.

Возвращает

void

Исключения

Exception
При отсутствии класса рендерера

См. также

https://secure.php.net/manual/en/function.set-exception-handler.php

handleFatalError() public 

handleFatalError(int $code, string $description, string $file, int $line): bool

Отображение/запись критической ошибки.

Параметры

int $code

Код ошибки

string $description

Описание ошибки

string $file

Файл, в котором произошла ошибка

int $line

Строка, вызвавшая ошибку

Возвращает

bool

increaseMemoryLimit() public 

increaseMemoryLimit(int $additionalKb): void

Увеличивает значение php ini "memory_limit" на указанную величину в килобайтах

Параметры

int $additionalKb

Значение в килобайтах

Возвращает

void

logException() public 

logException(Throwable $exception, Psr\Http\Message\ServerRequestInterface $request = null): bool

Запись ошибки для исключения, если применимо.

Параметры

Throwable $exception

Исключение для записи сообщения.

Psr\Http\Message\ServerRequestInterface $request необязательно

Текущий запрос.

Возвращает

bool

mapErrorCode() public static 

mapErrorCode(int $code): array

Преобразовать код ошибки в слово ошибки и местоположение записи.

Параметры

int $code

Код ошибки для преобразования

Возвращает

array

register() public 

register(): void

Зарегистрировать обработчики ошибок и исключений.

Возвращает

void

setConfig() public 

setConfig(string|array $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']);

Параметры

string|array $key

Ключ для установки или полный массив конфигураций.

mixed|null $value необязательно

Значение для установки.

bool $merge необязательно

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию. По умолчанию – true.

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
При попытке установить неверный ключ.

wrapAndHandleException() public 

wrapAndHandleException(Throwable $exception): void

Проверяет тип переданного исключения. Если это экземпляр Error, то он оборачивает переданный объект внутри другого объекта исключения для обеспечения обратной совместимости.

Параметры

Throwable $exception

Исключение для обработки

Возвращает

void

Подробное описание свойств

$_config protected

Конфигурация во время выполнения

Тип

array

$_configInitialized protected

Указывает, была ли конфигурация уже настроена с значениями по умолчанию

Тип

bool

$_defaultConfig protected

Параметры для использования при обработке ошибок.

Тип

array

$_handled protected

Тип

bool

$logger protected

Экземпляр логгера исключений.

Тип

Cake\Error\ErrorLoggerInterface|null

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Error.BaseErrorHandler.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API