File Source for Log.php

<?php
/**
* MediaSearch
*
* LICENSE
*
* "THE BEER-WARE LICENSE" (Revision 42):
* "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
* As long as you retain this notice you can do whatever you want with
* this stuff. If we meet some day, and you think this stuff is worth it,
* you can buy me a beer in return.
*
* $Author$
* $Revision$
*
* @category MediaSearch
* @package MediaSearch
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
/**
* This pure static class provides logging facility.
*
* First you need to specify a global log level. After that you need
* to add minimum one log backend object (implementation of MediaSearch_Log_Interface).
* Then you can use the logger.
*
* Example
* <code>
* MediaSearch_Log::setLevel(MediaSearch_Log::ALL);
* // shows only info logs on cli
* MediaSearch_Log::MediaSearch_Log_Cli(MediaSearch_Log::INFO);
* // logs everything to the log file
* MediaSearch_Log::MediaSearch_Log_Cli('path/to/log', MediaSearch_Log_File::ALL);
* // ..
* MediaSearch_Log::info('log info message');
* // ..
* MediaSearch_Log::error('log an error');
* // ..
* MediaSearch_Log::Debug('log debug message', array($debugVar1);
* MediaSearch_Log::Debug('log debug message', array($debugVar1, $debugVar2);
* </code>
*
* @final
* @category MediaSearch
* @package MediaSearch
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
final class MediaSearch_Log {
const TRACE_LELVEL = 57;
/**
* Disable all logging.
*/
const DISABLED = 0;
/**
* Enables loglevel info.
*/
const INFO = 1;
/**
* Enables loglevel trace.
*/
const TRACE = 2;
/**
* Enables loglevel debug.
*/
const DEBUG = 4;
/**
* Enables loglevel warn.
*/
const WARN = 8;
/**
* Enables loglevel error.
*/
const ERROR = 16;
/**
* Enables loglevel fatal.
*/
const FATAL = 32;
/**
* Enables all loglevels together.
*/
const ALL = 63;
/**
* Global log level.
* Some bitwise combination of the loglevel constants.
*
* @static
* @access private
* @var int
*/
private static $logLevel = self::DISABLED;
/**
* Holds logging backend classes.
* These are implemenations of MediaSearch_Log_Interface.
*
* @static
* @access private
* @var array
*/
private static $logger = array();
/**
* This clas is pure static.
*
* @access private
*/
private function __construct() {}
/**
* Determines if the given loglevel is enabled in the global
* loglevel.
*
* @static
* @access public
* @param int $logLevel
* @return bool
*/
public static function isEnabled($logLevel) {
return (self::$logLevel & $logLevel) === $logLevel;
}
/**
* Applys the logging methods (info(), trace(), debug() etc.)
* on the registered log backends (implementations of MediaSearch_Log_Interface).
*
* @static
* @access private
* @param string $method
* @param string $message
* @param mixed $additional int or array
*/
private static function applyOnLogger($method, $message, $additional = null) {
if (empty(self::$logger)) {
return;
}
foreach (self::$logger as $logger) {
if ('trace' === $method || 'debug' === $method) {
$logger->$method($message, $additional);
} else {
$logger->$method($message);
}
}
}
/**
* Sets the global log level. Use anny bitewise combination
* of the class constants.
*
* Examples:
* <code>
* MediaSearch_Log::setLevel(MediaSearch_Log::DISABLED);
* MediaSearch_Log::setLevel(MediaSearch_Log::ALL);
* MediaSearch_Log::setLevel(MediaSearch_Log::INFO & MediaSearch_Log::DEBUG);
* // ...
* </code>
*
* @static
* @access public
* @param int $integer Defauklt is MediaSearch_Log::DISABLED
*/
public static function setLevel($integer = self::DISABLED) {
self::$logLevel = $integer;
}
/**
* Returns the global log level.
*
* @static
* @access public
* @return int
*/
public static function getLevel() {
return self::$logLevel;
}
/**
* Adds log backends. You can add as man as you want.
* Each logger obejct can have its own log level. So you can
* log e.g. all info() and trace() messages to file and
* all fatal() to en email implemtation.
*
* @static
* @access public
* @param MediaSearch_Log_Interface $logger
*/
public static function add(MediaSearch_Log_Interface $logger) {
if (null === $logger->getLevel()) {
$logger->setLevel(self::getLevel());
}
self::$logger[] = $logger;
}
/**
* Call this method to log a info message.
*
* @static
* @access public
* @param string $message
*/
public static function info($message) {
if (!self::isEnabled(self::INFO)) {
return;
}
self::applyOnLogger('info', $message);
}
/**
* Call this method to log a trace message.
* You can specify a trace level. You can grep for this
* like: grep "TRACE-11' if your tracelevel is 11.
*
* @static
* @access public
* @param string $message
* @param int $traceLevel
*/
public static function trace($message, $traceLevel = 0) {
if (!self::isEnabled(self::TRACE)) {
return;
}
self::applyOnLogger('trace', $message, $traceLevel);
}
/**
* Call this method to log a debug message.
* Optional passed variables are dumped in the logfile.
*
* @static
* @access public
* @param string $message
* @param array $variables Additional variabls to debug
*/
public static function debug($message, array $variables = null) {
if (!self::isEnabled(self::DEBUG)) {
return;
}
self::applyOnLogger('debug', $message, $variables);
}
/**
* Call this method to log a warn message.
*
* @static
* @access public
* @param string $message
*/
public static function warn($message) {
if (!self::isEnabled(self::WARN)) {
return;
}
self::applyOnLogger('warn', $message);
}
/**
* Call this method to log a eroor message.
*
* @static
* @access public
* @param string $message
*/
public static function error($message) {
if (!self::isEnabled(self::ERROR)) {
return;
}
self::applyOnLogger('error', $message);
}
/**
* Call this method to log a fatal message.
*
* @static
* @access public
* @param string $message
*/
public static function fatal($message) {
if (!self::isEnabled(self::FATAL)) {
return;
}
self::applyOnLogger('fatal', $message);
}
}

Source for file Log.php