Spec-Zone.ru › CakePHP 3.3

Класс ConsoleLog

Ведение логов в консоли. Записывает логи в вывод консоли.

Psr\Log\AbstractLogger
Расширяется Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait
Расширяется Cake\Log\Engine\ConsoleLog
Пространство имён: Cake\Log\Engine
Расположение: Log/Engine/ConsoleLog.php

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

  • $_defaultConfig protected
    array
    Конфигурация по умолчанию для этого класса
  • $_output protected
    Cake\Console\ConsoleOutput
    Поток вывода

Унаследованные свойства

  • _config, _configInitialized

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

  • __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'
]

$_outputsource

protected Cake\Console\ConsoleOutput

Поток вывода

null

© 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

Spec-Zone.ru

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