Spec-Zone.ru › CakePHP 3.2

Класс ConsoleLog

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

Psr\Log\AbstractLogger
Extended by Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait
Extended by 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–2016 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.
http://api.cakephp.org/3.2/class-Cake.Log.Engine.ConsoleLog.html

Spec-Zone.ru

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