Класс 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

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

Возвращает

boolean|null

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

log()source public

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

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

Параметры

строка $level

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

строка $message

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

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

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

Возвращает

boolean
Результат записи.

_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

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

boolean|строка $merge необязательно 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

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

boolean $merge необязательно 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,
]