Spec-Zone.ru › CakePHP 3.2

Класс FileLog

Поток хранилища файлов для ведения журнала. Записывает логи в разные файлы в зависимости от уровня лога.

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

Краткое описание свойств

  • $_defaultConfig protected
    array
    Конфигурация по умолчанию для этого класса
  • $_file protected
    string
    Имя файла для сохранения логов.
  • $_path protected
    string
    Путь для сохранения файлов логов.
  • $_size protected
    integer
    Максимальный размер файла, используемый для вращения файлов логов.

Унаследованные свойства

  • _config, _configInitialized

Краткое описание методов

  • __construct() public
    Устанавливает защищённые свойства на основе предоставленной конфигурации
  • _getFilename() protected
    Получить имя файла
  • _rotateFile() protected

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

  • log() public
    Реализует запись в файлы логов.

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

__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
Успех записи.

Методы, унаследованные от Cake\Log\Engine\BaseLog

_format()source protected

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

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

Параметры

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

Возвращает

строка

levels()source public

levels( )

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

Возвращает

массив

scopes()source public

scopes( )

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

Возвращает

массив

Методы, используемые из Cake\Core\InstanceConfigTrait

_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

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.

Возвращает

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

Выбрасывает

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

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

Возвращает


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

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

$_defaultConfigsource

protected array

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

  • levels строка или массив, уровни, которые интересуют движок
  • scopes строка или массив, области, которые интересуют движок
  • file Имя файла журнала
  • path Путь для сохранения журналов.
  • size Используется для реализации базовой ротации файлов журнала. Если размер файла журнала достигает заданного размера, существующий файл переименовывается путем добавления отметки времени к имени файла, и создается новый файл журнала. Может быть целым числом байтов или строкой, удобочитаемой для человека, например, '10МБ', '100КБ' и т.д.
  • rotate Файлы журнала поворачиваются указанное количество раз перед удалением. Если значение равно 0, старые версии удаляются, а не поворачиваются.
  • mask При создании файлов журналов применяется маска. Если поле пустое, chmod не выполняется.
[
    'path' => null,
    'file' => null,
    'types' => null,
    'levels' => [],
    'scopes' => [],
    'rotate' => 10,
    'size' => 10485760, // 10MB
    'mask' => null,
]

$_filesource

protected string

Имя файла для сохранения журналов.

null

$_pathsource

protected string

Путь для сохранения файлов журнала.

null

$_sizesource

protected integer

Максимальный размер файла, используемый для ротации файлов журнала.

null

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

Spec-Zone.ru

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