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.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 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
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
      • Engine
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class SyslogLog

Syslog stream for Logging. Writes logs to the system logger

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

  • $_levelMap protected
    int[]

    Used to map the string names back to their LOG_* constants

  • $_open protected
    bool

    Whether the logger connection is open or not

Method Summary

  • __construct() public

    __construct method

  • __destruct() public

    Closes the logger connection

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • _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.

  • _open() protected

    Extracts the call to openlog() in order to run unit tests on it. This function will initialize the connection to the system logger

  • _write() protected

    Extracts the call to syslog() in order to run unit tests on it. This function will perform the actual write in the system logger

  • alert() public

    Action must be taken immediately.

  • config() public deprecated

    Gets/Sets the config.

  • 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.

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • info() public

    Interesting events.

  • levels() public

    Get the levels this logger is interested in.

  • log() public

    Writes a message to syslog

  • notice() public

    Normal but significant events.

  • scopes() public

    Get the scopes this logger is interested in.

  • setConfig() public

    Sets the config.

  • warning() public

    Exceptional occurrences that are not errors.

Method Detail

__construct() ¶ public

__construct(array $config = [])

__construct method

Parameters
array $config optional

Configuration array

__destruct() ¶ public

__destruct()

Closes the logger connection

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes 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

Reads a config key.

Parameters
string|null $key

Key to read.

Returns
mixed

_configWrite() ¶ protected

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

Writes a config key.

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

_open() ¶ protected

_open(string $ident, int $options, int $facility): void

Extracts the call to openlog() in order to run unit tests on it. This function will initialize the connection to the system logger

Parameters
string $ident

the prefix to add to all messages logged

int $options

the options flags to be used for logged messages

int $facility

the stream or facility to log to

Returns
void

_write() ¶ protected

_write(int $priority, string $message): bool

Extracts the call to syslog() in order to run unit tests on it. This function will perform the actual write in the system logger

Parameters
int $priority

Message priority.

string $message

Message to log.

Returns
bool

alert() ¶ public

alert(string $message, mixed[] $context = array()): void

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
mixed[] $context optional
Returns
void

config() ¶ public

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

Gets/Sets the config.

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->configShallow('key', $value);

Setting a nested value:

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

Updating multiple config settings at the same time:

$this->configShallow(['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, mixed[] $context = array()): void

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameters
string $message
mixed[] $context optional
Returns
void

debug() ¶ public

debug(string $message, mixed[] $context = array()): void

Detailed debug information.

Parameters
string $message
mixed[] $context optional
Returns
void

emergency() ¶ public

emergency(string $message, mixed[] $context = array()): void

System is unusable.

Parameters
string $message
mixed[] $context optional
Returns
void

error() ¶ public

error(string $message, mixed[] $context = array()): void

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

Parameters
string $message
mixed[] $context optional
Returns
void

getConfig() ¶ public

getConfig(string|null $key = null, mixed|null $default = null): mixed|null

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

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

Reading with default value:

$this->getConfig('some-key', 'default-value');
Parameters
string|null $key optional

The key to get or null for the whole config.

mixed|null $default optional

The return value when the key does not exist.

Returns
mixed|null

getConfigOrFail() ¶ public

getConfigOrFail(string|null $key): mixed

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters
string|null $key

The key to get.

Returns
mixed
Throws
InvalidArgumentException

info() ¶ public

info(string $message, mixed[] $context = array()): void

Interesting events.

Example: User logs in, SQL logs.

Parameters
string $message
mixed[] $context optional
Returns
void

levels() ¶ public

levels(): array

Get the levels this logger is interested in.

Returns
array

log() ¶ public

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

Writes a message to syslog

Map the $level back to a LOG_ constant value, split multi-line messages into multiple log messages, pass all messages through the format defined in the configuration

Parameters
mixed $level

The severity level of log you are making.

string $message

The message you want to log.

mixed[] $context optional

Additional information about the logged message

Returns
bool

notice() ¶ public

notice(string $message, mixed[] $context = array()): void

Normal but significant events.

Parameters
string $message
mixed[] $context optional
Returns
void

scopes() ¶ public

scopes(): array|false

Get the scopes this logger is interested in.

Returns
array|false

setConfig() ¶ public

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

Sets the config.

Usage

Setting a specific value:

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

Setting a nested value:

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

Updating multiple config settings at the same time:

$this->setConfig(['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.

bool $merge optional

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

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

warning() ¶ public

warning(string $message, mixed[] $context = array()): void

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
mixed[] $context optional
Returns
void

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

By default messages are formatted as: level: message

To override the log format (e.g. to add your own info) define the format key when configuring this logger

If you wish to include a prefix to all messages, for instance to identify the application or the web server, then use the prefix option. Please keep in mind the prefix is shared by all streams using syslog, as it is dependent of the running process. For a local prefix, to be used only by one stream, you can use the format key.

Example:

 Log::config('error', ]
     'engine' => 'Syslog',
     'levels' => ['emergency', 'alert', 'critical', 'error'],
     'format' => "%s: My-App - %s",
     'prefix' => 'Web Server 01'
 ]);
Type
array

$_levelMap ¶ protected

Used to map the string names back to their LOG_* constants

Type
int[]

$_open ¶ protected

Whether the logger connection is open or not

Type
bool
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