CakeLog Class Info:

Class Declaration:

class CakeLog

File name:
cake/libs/cake_log.php
Description:

Logs messages to configured Log adapters. One or more adapters can be configured using CakeLogs's methods. If you don't configure any adapters, and write to the logs a default FileLog will be autoconfigured for you.

Package
cake
Subpackage
cake.cake.libs

Properties:

Show/Hide parent properties

  • _streams array

    An array of connected streams. Each stream represents a callable that will be called when write() is called.

Method Summary:

Show/Hide parent methods

_autoConfig

top

Configures the automatic/default stream a FileLog.

Method defined in:
cake/libs/cake_log.php on line 178
Return

void

Access

protected

config

top

Configure and add a new logging stream to CakeLog You can use add loggers from app/libs use app.loggername, or any plugin/libs using plugin.loggername.

Usage:

CakeLog::config('second_file', array(
        'engine' => 'FileLog',
        'path' => '/var/logs/my_app/'
));

Will configure a FileLog instance to use the specified path. All options that are not engine are passed onto the logging adapter, and handled there. Any class can be configured as a logging adapter as long as it implements a write method with the following signature.

write($type, $message)

For an explaination of these parameters, see CakeLog::write()

Parameters:
  • string $key required

    The keyname for this logger, used to remove the logger later.

  • array $config required

    Array of configuration information for the logger

Method defined in:
cake/libs/cake_log.php on line 99
Return

boolean success of configuration.

Static

configured

top

Returns the keynames of the currently active streams

Method defined in:
cake/libs/cake_log.php on line 153
Return

array Array of configured log streams.

Access

public

Static

drop

top

Removes a stream from the active streams. Once a stream has been removed it will no longer have messages sent to it.

Parameters:
  • $streamName required

Method defined in:
cake/libs/cake_log.php on line 167
Return

void

Access

public

Static

getInstance

top

Get an instance

Method defined in:
cake/libs/cake_log.php on line 65
Return

void

Static

_getLogger

top

Attempts to import a logger class from the various paths it could be on. Checks that the logger class implements a write method as well.

Parameters:
  • string $loggerName required

    the plugin.className of the logger class you want to build.

Method defined in:
cake/libs/cake_log.php on line 122
Return

mixed boolean false on any failures, string of classname to use if search was successful.

Access

protected

handleError

top

An error_handler that will log errors to file using CakeLog::write(); You can control how verbose and what type of errors this error_handler will catch using Configure::write('log', $value). See core.php for more information.

Parameters:
  • integer $code required

    Code of error

  • string $description required

    Error description

  • string $file optional NULL

    File on which error occurred

  • integer $line optional NULL

    Line that triggered the error

  • array $context optional NULL

    Context

Method defined in:
cake/libs/cake_log.php on line 255
Return

void

write

top

Writes the given message and type to all of the configured log adapters. Configured adapters are passed both the $type and $message variables. $type is one of the following strings/values.

Types:

  • LOG_WARNING => 'warning',
  • LOG_NOTICE => 'notice',
  • LOG_INFO => 'info',
  • LOG_DEBUG => 'debug',
  • LOG_ERR => 'error',
  • LOG_ERROR => 'error'

Usage:

Write a message to the 'warning' log:

CakeLog::write('warning', 'Stuff is broken here');

Parameters:
  • string $type required

    Type of message being written

  • string $message required

    Message content to log

Method defined in:
cake/libs/cake_log.php on line 211
Return

boolean Success

Access

public

Static