Spec-Zone.ru › CakePHP 4.3

Класс JsonFormatter

Пространство имён: Cake\Log\Formatter

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

  • $_config protected
    array<string, mixed>

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

  • $_configInitialized protected
    bool

    Указатель, сконфигурировано ли свойство config с параметрами по умолчанию

  • $_defaultConfig protected
    array<string, mixed>

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

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

  • __construct() public
  • _configDelete() protected

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

  • _configRead() protected

    Читает значение ключа конфигурации.

  • _configWrite() protected

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

  • configShallow() public

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

  • format() public

    Форматирует сообщение.

  • getConfig() public

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

  • getConfigOrFail() public

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

  • setConfig() public

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

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

__construct() public 

__construct(array<string, mixed> $config = [])

Параметры

array<string, mixed> $config 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

format() public 

format(mixed $level, string $message, array $context = []): string

Форматирует сообщение.

Параметры

mixed $level
string $message
array $context optional

Возвращает

string

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

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 optional

Произвести рекурсивное объединение или перезапись существующей конфигурации (по умолчанию true).

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
при попытке установки недопустимого ключа.

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

$_config protected

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

Тип

array<string, mixed>

$_configInitialized protected

Указатель, сконфигурировано ли свойство config с параметрами по умолчанию

Тип

bool

$_defaultConfig protected

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

Тип

array<string, mixed>

© 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.3/class-Cake.Log.Formatter.JsonFormatter.html

Spec-Zone.ru

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