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
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.1 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.1
      • 4.2
      • 4.1
      • 4.0
      • 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

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
    • Network
      • Email
      • Http
    • Routing
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • CakeLog

Interfaces

  • CakeLogInterface

Class CakeLog

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.

Configuring Log adapters

You can configure log adapters in your applications bootstrap.php file. A sample configuration would look like:

CakeLog::config('my_log', array('engine' => 'FileLog'));

See the documentation on CakeLog::config() for more detail.

Writing to the log

You write to the logs using CakeLog::write(). See its documentation for more information.

Package: Cake\Log
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/Log/CakeLog.php

Properties summary

  • $_streams protected static
    array

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

Method Summary

  • _autoConfig() protected static
    Configures the automatic/default stream a FileLog.
  • _getLogger() protected static

    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.

  • config() public static

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

  • configured() public static
    Returns the keynames of the currently active streams
  • drop() public static

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

  • write() public static

    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.

Method Detail

_autoConfig() protected static ¶

_autoConfig( )

Configures the automatic/default stream a FileLog.

_getLogger() protected static ¶

_getLogger( string $loggerName )

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
the plugin.className of the logger class you want to build.
Returns
mixed
boolean false on any failures, string of classname to use if search was successful.
Throws
CakeLogException

config() public static ¶

config( string $key , array $config )

Configure and add a new logging stream to CakeLog You can use add loggers from app/Log/Engine use app.loggername, or any plugin/Log/Engine 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 the methods in CakeLogInterface.

Parameters
string $key
The keyname for this logger, used to remove the logger later.
array $config
Array of configuration information for the logger
Returns
boolean
success of configuration.
Throws
CakeLogException

configured() public static ¶

configured( )

Returns the keynames of the currently active streams

Returns
array
Array of configured log streams.

drop() public static ¶

drop( string $streamName )

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

Parameters
string $streamName
Key name of a configured stream to remove.

write() public static ¶

write( string $type , string $message )

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
Type of message being written
string $message
Message content to log
Returns
boolean
Success

Properties detail

$_streams ¶

protected static array

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

array()
OpenHub
Rackspace
Rackspace
  • 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
  • Slack
  • Paid Support

Generated using CakePHP API Docs