CakeLog Class Info:
- Class Declaration:
class CakeLog
- File name:
- Cake/Log/CakeLog.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.
Configuring Log adapters
You can configure log adapters in your applications
bootstrap.phpfile. 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
Properties:
-
_streams array
An array of connected streams. Each stream represents a callable that will be called when write() is called.
_autoConfig
topConfigures the automatic/default stream a FileLog.
- Method defined in:
- Cake/Log/CakeLog.php on line 152
- Return
void
config
topConfigure 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 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/Log/CakeLog.php on line 92
- Return
boolean success of configuration.
- Throws
CakeLogException
configured
topReturns the keynames of the currently active streams
- Method defined in:
- Cake/Log/CakeLog.php on line 132
- Return
array Array of configured log streams.
drop
topRemoves a stream from the active streams. Once a stream has been removed it will no longer have messages sent to it.
- Parameters:
-
-
string $streamName required
Key name of a configured stream to remove.
-
- Method defined in:
- Cake/Log/CakeLog.php on line 143
- Return
void
_getLogger
topAttempts 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/Log/CakeLog.php on line 117
- Return
mixed boolean false on any failures, string of classname to use if search was successful.
- Throws
CakeLogException
write
topWrites 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/Log/CakeLog.php on line 181
- Return
boolean Success