Класс 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

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

Исключения

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

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

Возвращает

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

Исключения

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

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

Возвращает

смешанный
Значение конфигурации, которое считывается.

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

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

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

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

Возвращает

$this

Вызывает исключения

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

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