nextcloud/lib/log.php

157 lines
3.2 KiB
PHP
Raw Normal View History

2011-10-16 22:49:14 +04:00
<?php
/**
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
2012-03-31 01:15:48 +04:00
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
2011-10-16 22:49:14 +04:00
*/
namespace OC;
2011-10-16 22:49:14 +04:00
/**
2012-03-31 01:15:48 +04:00
* logging utilities
2011-10-16 22:49:14 +04:00
*
* This is a stand in, this should be replaced by a Psr\Log\LoggerInterface
* compatible logger. See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
* for the full interface specification.
*
* MonoLog is an example implementing this interface.
2011-10-16 22:49:14 +04:00
*/
class Log {
2011-10-16 22:49:14 +04:00
const DEBUG=0;
const INFO=1;
const WARN=2;
const ERROR=3;
const FATAL=4;
const NOTICE=5;
const CRITICAL=6;
const ALERT=7;
2012-03-31 01:15:48 +04:00
2011-10-16 22:49:14 +04:00
/**
* System is unusable.
*
2011-10-16 22:49:14 +04:00
* @param string $message
* @param array $context
* @return null
2011-10-16 22:49:14 +04:00
*/
public function emergency($message, array $context = array())
{
$this->log(self::FATAL, $message, $context);
2011-10-16 22:49:14 +04:00
}
2013-01-14 23:30:39 +04:00
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
* @param array $context
* @return null
*/
public function alert($message, array $context = array())
{
$this->log(self::ALERT, $message, $context);
2012-09-12 23:30:04 +04:00
}
2013-01-14 23:30:39 +04:00
/**
* Critical conditions.
*
* Example: Application component unavailable, unexpected exception.
*
* @param string $message
* @param array $context
* @return null
*/
public function critical($message, array $context = array())
{
$this->log(self::CRITICAL, $message, $context);
2012-09-26 15:38:06 +04:00
}
2012-09-12 23:30:04 +04:00
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
* @param array $context
* @return null
*/
public function error($message, array $context = array())
{
$this->log(self::ERROR, $message, $context);
}
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
* @param array $context
* @return null
*/
public function warning($message, array $context = array())
{
$this->log(self::WARN, $message, $context);
}
2012-09-12 23:30:04 +04:00
/**
* Normal but significant events.
*
* @param string $message
* @param array $context
* @return null
*/
public function notice($message, array $context = array())
{
$this->log(self::NOTICE, $message, $context);
}
/**
* Interesting events.
*
* Example: User logs in, SQL logs.
*
* @param string $message
* @param array $context
* @return null
*/
public function info($message, array $context = array())
{
$this->log(self::INFO, $message, $context);
}
/**
* Detailed debug information.
*
* @param string $message
* @param array $context
* @return null
*/
public function debug($message, array $context = array())
{
$this->log(self::DEBUG, $message, $context);
}
/**
* Logs with an arbitrary level.
*
* @param mixed $level
* @param string $message
* @param array $context
* @return null
*/
protected function log($level, $message, array $context = array())
{
if (isset($context['app'])) {
$app = $context['app'];
} else {
$app = 'no app in context';
}
\OC_Log::write($app, $message, $level);
2012-09-12 23:30:04 +04:00
}
2011-10-16 22:49:14 +04:00
}