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

True, если вращение выполнено успешно, или false в случае ошибки. 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

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

Исключения

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

config()source public deprecated

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

Рекурсивно сливать или перезаписывать существующую конфигурацию, по умолчанию 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
Данные конфигурации по указанному ключу или null, если ключ не существует.

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,
]