Класс ConsoleLog

__construct()source public

__construct( array $config = [] )

Создаёт новый логгер консоли.

Настройка

• levels строка или массив, уровни, в которых заинтересован двигатель
• scopes строка или массив, области, в которых заинтересован двигатель
• stream путь для сохранения логов.
• outputAs целое число или ConsoleOutput::[RAW|PLAIN|COLOR]

Параметры

массив $config необязательно []

Параметры для FileLog, см. выше.

Исключения

InvalidArgumentException

Переопределяет

Cake\Log\Engine\BaseLog::__construct()

log()source public

log( string $level , string $message , array $context = [] )

Реализует запись в консоль.

Параметры

строка $level

Уровень серьёзности лога, который вы создаёте.

строка $message

Сообщение, которое вы хотите записать в лог.

массив $context необязательно []

Дополнительная информация о записанном сообщении

Возвращает

boolean
успех записи.

_format()source protected

_format( mixed $data , array $context = [] )

Преобразует предоставленные данные в строку, чтобы их можно было записать в журнал. Контекст может быть необязательно использован движками логов для интерполяции переменных или добавления дополнительной информации в записанное сообщение.

Параметры

смешанный $data

Данные, которые необходимо преобразовать в строку и записать в лог.

массив $context необязательно []

Дополнительная информация о журнале для сообщения.

Возвращает

строка

levels()source public

levels( )

Возвращает уровни, в которых заинтересован этот логгер.

Возвращает

массив

scopes()source public

scopes( )

Возвращает области, в которых заинтересован этот логгер.

Возвращает

массив

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

Ключ для удаления.

Исключения

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

строка|null $key

Ключ для чтения.

Возвращает

смешанное

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

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

Параметры

строка|массив $key

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

смешанное $value

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

boolean|строка $merge необязательно false

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

Исключения

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

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

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

Использование

Чтение всей конфигурации:

$this->config();

Чтение определённого значения:

$this->config('key');

Чтение вложенного значения:

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

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

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

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

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

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

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

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

строка|массив|null $key необязательно null

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

смешанное|null $value необязательно null

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

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

Необходимо ли рекурсивно склеивать или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

смешанное
Значение конфигурации, которое считывается, или сам объект при операциях записи.

Исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

строка|массив $key

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

смешанное|null $value необязательно null

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

Возвращает

$this

getConfig()source public

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

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

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определённого значения:

$this->getConfig('key');

Чтение вложенного значения:

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

Чтение со значением по умолчанию:

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

Параметры

строка|null $key необязательно null

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

смешанное $default необязательно null

Возвращаемое значение, когда ключ не существует.

Возвращает

смешанное
Данные конфигурации по указанному ключу или null, если ключ не существует.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

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

Использование

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

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

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

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

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

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

Параметры

строка|массив $key

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

смешанное|null $value необязательный null

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

булево $merge необязательный true

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

Возвращает

$this

Исключения

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

[
    'stream' => 'php://stderr',
    'levels' => null,
    'scopes' => [],
    'outputAs' => null,
]