Класс FileLog
Поток хранения файлов для ведения журнала. Записывает журналы в разные файлы в зависимости от уровня журнала.
- Psr\Log\AbstractLogger
-
Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait -
Cake\Log\Engine\FileLog
Подробное описание методов
__constructsource public
__construct( array $config [] )
Устанавливает защищенные свойства на основе предоставленной конфигурации
Параметры
- массив
$configнеобязательно [] - Массив конфигурации
Переопределяет
Cake\Log\Engine\BaseLog::__construct() _getFilenamesource protected
_getFilename( string $level )
Получить имя файла
Параметры
- строка
$level - Уровень журнала.
Возвращает
stringИмя файла
_rotateFilesource protected
_rotateFile( string $filename )
Вращает файл журнала, если размер, указанный в конфигурации, достигнут. Также, если rotate счет достигнут, самый старый файл удаляется.
Параметры
- строка
$filename - Имя файла журнала
Возвращает
boolean|nullTrue, если вращение выполнено успешно, или false в случае ошибки. Null, если файл не нуждается во вращении.
logsource public
log( string $level , string $message , array $context [] )
Реализует запись в файлы журнала.
Параметры
- строка
$level - Уровень серьезности сообщения, которое записывается. См. Cake\Log\Log::$_levels для списка возможных уровней.
- строка
$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 - Значение для записи.
- логическое значение|строка
$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 - Значение для установки.
- логическое значение
$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.
Резюме свойств
Свойства, используемые из Cake\Core\InstanceConfigTrait
$_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.FileLog.html