Spec-Zone.ru › CakePHP 3.1

Класс ConsoleLog

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

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

Подробное описание метода

__constructsource public

__construct( array $config [] )

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

Настройка

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

Параметры

массив $config необязательно []
Параметры для FileLog, см. выше.

Исключения

InvalidArgumentException
\InvalidArgumentException

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

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

logsource public

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

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

Параметры

строка $level
Уровень важности лога, который вы создаёте.
строка $message
Сообщение, которое вы хотите записать в лог.
массив $context необязательно []
Дополнительная информация о записанном сообщении

Возвращает

boolean
успешность записи.

Наследованные методы из Cake\Log\Engine\BaseLog

_formatsource protected

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

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

Параметры

смешанный $data
Данные, которые должны быть преобразованы в строку и записаны в журнал.
массив $context необязательно []
Дополнительная информация о сообщении в логе.

Возвращает

string
строка

levelssource public

levels( )

Получить уровни, которые интересуют этого логгера.

Возвращает

array
массив

scopessource public

scopes( )

Получить области, которые интересуют этого логгера.

Возвращает

array
массив

Наследованные методы из Cake\Core\InstanceConfigTrait

_configDeletesource protected

_configDelete( string $key )

Удаляет один ключ конфигурации

Параметры

строка $key
Ключ для удаления.

Исключения

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

_configReadsource protected

_configRead( string|null $key )

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

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed
смешанный

_configWritesource protected

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

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

Параметры

строка|массив $key
Ключ для записи.
смешанный $value
Значение для записи.
boolean|строка $merge необязательно false
True для рекурсивной слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

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

configsource 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
Флаг рекурсивного слияния или перезаписи существующей конфигурации, по умолчанию true.

Возвращает

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

Исключения

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

configShallowsource 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
Значение для установки.

Возвращает

mixed
$this Сам объект.

Резюме свойств

$_defaultConfigsource

protected массив

Значения по умолчанию конфигурации для этого класса

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

$_outputsource

protected Cake\Console\ConsoleOutput

Поток вывода

null

Используемые свойства из Cake\Core\InstanceConfigTrait

$_configsource

protected массив

Конфигурация во время выполнения

[]

$_configInitializedsource

protected boolean

Флаг, указывающий, была ли конфигурация уже настроена со значениями по умолчанию

false

© 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.1/class-Cake.Log.Engine.ConsoleLog.html

Spec-Zone.ru

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