CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.2 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.2
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
      • Engine
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class FileLog

File Storage stream for Logging. Writes logs to different files based on the level of log it is.

Namespace: Cake\Log\Engine

Property Summary

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default config for this class

  • $_file protected
    string

    The name of the file to save logs into.

  • $_path protected
    string

    Path to save log files on.

  • $_size protected
    int

    Max file size, used for log file rotation.

Method Summary

  • __construct() public

    Sets protected properties based on config provided

  • _configDelete() protected

    Delete a single config key

  • _configRead() protected

    Read a config variable

  • _configWrite() protected

    Write a config variable

  • _format() protected

    Converts to string the provided data so it can be logged. The context can optionally be used by log engines to interpolate variables or add additional info to the logged message.

  • _getFilename() protected

    Get filename

  • _rotateFile() protected

    Rotate log file if size specified in config is reached. Also if rotate count is reached oldest file is removed.

  • alert() public

    Action must be taken immediately.

  • config() public

    Usage

  • configShallow() public

    Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

  • critical() public

    Critical conditions.

  • debug() public

    Detailed debug information.

  • emergency() public

    System is unusable.

  • error() public

    Runtime errors that do not require immediate action but should typically be logged and monitored.

  • info() public

    Interesting events.

  • levels() public

    Get the levels this logger is interested in.

  • log() public

    Implements writing to log files.

  • notice() public

    Normal but significant events.

  • scopes() public

    Get the scopes this logger is interested in.

  • warning() public

    Exceptional occurrences that are not errors.

Method Detail

__construct() ¶ public

__construct(array $config = [])

Sets protected properties based on config provided

Parameters
array $config optional

Configuration array

_configDelete() ¶ protected

_configDelete(string $key): void

Delete a single config key

Parameters
string $key

Key to delete.

Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Read a config variable

Parameters
string|null $key

Key to read.

Returns
mixed

_configWrite() ¶ protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Write a config variable

Parameters
string|array $key

Key to write to.

mixed $value

Value to write.

bool|string $merge optional

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config

_format() ¶ protected

_format(mixed $data, array $context = []): string

Converts to string the provided data so it can be logged. The context can optionally be used by log engines to interpolate variables or add additional info to the logged message.

Parameters
mixed $data

The data to be converted to string and logged.

array $context optional

Additional logging information for the message.

Returns
string

_getFilename() ¶ protected

_getFilename(string $level): string

Get filename

Parameters
string $level

The level of log.

Returns
string

_rotateFile() ¶ protected

_rotateFile(string $filename): bool|null

Rotate log file if size specified in config is reached. Also if rotate count is reached oldest file is removed.

Parameters
string $filename

Log file name

Returns
bool|null

alert() ¶ public

alert(string $message, array $context = array()): null

Action must be taken immediately.

Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.

Parameters
string $message
array $context optional
Returns
null

config() ¶ public

config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixed

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);
Parameters
string|array|null $key optional

The key to get/set, or a complete array of configs.

mixed|null $value optional

The value to set.

bool $merge optional

Whether to recursively merge or overwrite existing config, defaults to true.

Returns
mixed
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() ¶ public

configShallow(string|array $key, mixed|null $value = null): $this

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);
Parameters
string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns
$this

critical() ¶ public

critical(string $message, array $context = array()): null

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameters
string $message
array $context optional
Returns
null

debug() ¶ public

debug(string $message, array $context = array()): null

Detailed debug information.

Parameters
string $message
array $context optional
Returns
null

emergency() ¶ public

emergency(string $message, array $context = array()): null

System is unusable.

Parameters
string $message
array $context optional
Returns
null

error() ¶ public

error(string $message, array $context = array()): null

Runtime errors that do not require immediate action but should typically be logged and monitored.

Parameters
string $message
array $context optional
Returns
null

info() ¶ public

info(string $message, array $context = array()): null

Interesting events.

Example: User logs in, SQL logs.

Parameters
string $message
array $context optional
Returns
null

levels() ¶ public

levels(): array

Get the levels this logger is interested in.

Returns
array

log() ¶ public

log(mixed $level, string $message, array $context = []): bool

Implements writing to log files.

Parameters
mixed $level

The severity level of the message being written. See Cake\Log\Log::$_levels for list of possible levels.

string $message

The message you want to log.

array $context optional

Additional information about the logged message

Returns
bool

notice() ¶ public

notice(string $message, array $context = array()): null

Normal but significant events.

Parameters
string $message
array $context optional
Returns
null

scopes() ¶ public

scopes(): array

Get the scopes this logger is interested in.

Returns
array

warning() ¶ public

warning(string $message, array $context = array()): null

Exceptional occurrences that are not errors.

Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.

Parameters
string $message
array $context optional
Returns
null

Property Detail

$_config ¶ protected

Runtime config

Type
array

$_configInitialized ¶ protected

Whether the config property has already been configured with defaults

Type
bool

$_defaultConfig ¶ protected

Default config for this class

  • levels string or array, levels the engine is interested in
  • scopes string or array, scopes the engine is interested in
  • file Log file name
  • path The path to save logs on.
  • size Used to implement basic log file rotation. If log file size reaches specified size the existing file is renamed by appending timestamp to filename and new log file is created. Can be integer bytes value or human readable string values like '10MB', '100KB' etc.
  • rotate Log files are rotated specified times before being removed. If value is 0, old versions are removed rather then rotated.
  • mask A mask is applied when log files are created. Left empty no chmod is made.
Type
array

$_file ¶ protected

The name of the file to save logs into.

Type
string

$_path ¶ protected

Path to save log files on.

Type
string

$_size ¶ protected

Max file size, used for log file rotation.

Type
int
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs