Класс ConsoleLog
Ведение логов в консоли. Записывает логи в вывод консоли.
- Psr\Log\AbstractLogger
-
Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait -
Cake\Log\Engine\ConsoleLog
Краткое описание свойств
-
$_defaultConfigprotectedКонфигурация по умолчанию для этого классаarray - Поток вывода
$_outputprotected
Унаследованные свойства
Краткое описание методов
- __construct() publicСоздаёт новый логгер консоли.
- log() publicРеализует запись в консоль.
Подробное описание методов
__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успех записи.
Методы, унаследованные от Cake\Log\Engine\BaseLog
_format()source protected
_format( mixed $data , array $context [] )
Преобразует предоставленные данные в строку для логирования. Контекст может быть использован лог-движками для интерполяции переменных или добавления дополнительной информации в сообщение лога.
Параметры
- смешанный
$data - Данные, которые необходимо преобразовать в строку и залогировать.
- массив
$contextнеобязательный [] - Дополнительная информация о логировании сообщения.
Возвращает
строкаlevels()source public
levels( )
Получить уровни, которые интересуют этого логгера.
Возвращает
массивscopes()source public
scopes( )
Получить области, которые интересуют этого логгера.
Возвращает
массивМетоды, используемые из Cake\Core\InstanceConfigTrait
_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
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']);
Параметры
- строка|массив|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->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательный null - Значение для установки.
Возвращает
$this Сам объект.
Подробное описание свойств
$_defaultConfigsource
protected массив
Конфигурация по умолчанию для этого класса
[
'stream' => 'php://stderr',
'levels' => null,
'scopes' => [],
'outputAs' => 'see constructor'
]
© 2005–2017 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/3.3/class-Cake.Log.Engine.ConsoleLog.html