Класс FileLog

__construct()source public

__construct( array $config [] )

Устанавливает защищённые свойства на основе предоставленной конфигурации

Параметры

массив $config необязательно []

Массив конфигурации

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

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

_getFilename()source protected

_getFilename( string $level )

Получить имя файла

Параметры

строка $level

Уровень журнала.

Возвращает

строка
Имя файла

_rotateFile()source protected

_rotateFile( string $filename )

Вращает файл журнала, если размер, указанный в конфигурации, достигнут. Также, если количество rotate достигло предела, удаляется самый старый файл.

Параметры

строка $filename

Имя файла журнала

Возвращает

логическое значение|null

True, если вращение выполнено успешно, или false в случае ошибки. Null, если файл не нужно вращать.

log()source public

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

Реализует запись в файлы журнала.

Параметры

строка $level

Уровень важности сообщения, которое записывается. См. Cake\Log\Log::$_levels для списка возможных уровней.

строка $message

Сообщение, которое вы хотите записать в журнал.

массив $context необязательно []

Дополнительная информация о записанном сообщении

Возвращает

логическое значение
Успех записи.

_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

Значение для записи.

логическое значение|строка $merge необязательно false

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

Выбрасывает

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']);

Устарело

3.4.0 использовать setConfig()/getConfig() вместо этого.

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанный|null $value необязательно null

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

логическое значение $merge необязательно true

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию 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');

Параметры

string|null $key необязательно null

Ключ для получения или null для всей конфигурации.

mixed $default необязательно null

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

Возвращает

mixed
Значение конфигурации.

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']);

Параметры

string|array $key

Ключ для установки или полный массив конфигураций.

mixed|null $value необязательно null

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

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

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

Возвращает

$this

Выбрасывает

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

[
    'path' => null,
    'file' => null,
    'types' => null,
    'levels' => [],
    'scopes' => [],
    'rotate' => 10,
    'size' => 10485760, // 10MB
    'mask' => null,
]