annotate vendor/psr/log/Psr/Log/AbstractLogger.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Psr\Log;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * This is a simple Logger implementation that other Loggers can inherit from.
Chris@0 7 *
Chris@0 8 * It simply delegates all log-level-specific methods to the `log` method to
Chris@0 9 * reduce boilerplate code that a simple Logger that does the same thing with
Chris@0 10 * messages regardless of the error level has to implement.
Chris@0 11 */
Chris@0 12 abstract class AbstractLogger implements LoggerInterface
Chris@0 13 {
Chris@0 14 /**
Chris@0 15 * System is unusable.
Chris@0 16 *
Chris@0 17 * @param string $message
Chris@0 18 * @param array $context
Chris@0 19 *
Chris@0 20 * @return void
Chris@0 21 */
Chris@0 22 public function emergency($message, array $context = array())
Chris@0 23 {
Chris@0 24 $this->log(LogLevel::EMERGENCY, $message, $context);
Chris@0 25 }
Chris@0 26
Chris@0 27 /**
Chris@0 28 * Action must be taken immediately.
Chris@0 29 *
Chris@0 30 * Example: Entire website down, database unavailable, etc. This should
Chris@0 31 * trigger the SMS alerts and wake you up.
Chris@0 32 *
Chris@0 33 * @param string $message
Chris@0 34 * @param array $context
Chris@0 35 *
Chris@0 36 * @return void
Chris@0 37 */
Chris@0 38 public function alert($message, array $context = array())
Chris@0 39 {
Chris@0 40 $this->log(LogLevel::ALERT, $message, $context);
Chris@0 41 }
Chris@0 42
Chris@0 43 /**
Chris@0 44 * Critical conditions.
Chris@0 45 *
Chris@0 46 * Example: Application component unavailable, unexpected exception.
Chris@0 47 *
Chris@0 48 * @param string $message
Chris@0 49 * @param array $context
Chris@0 50 *
Chris@0 51 * @return void
Chris@0 52 */
Chris@0 53 public function critical($message, array $context = array())
Chris@0 54 {
Chris@0 55 $this->log(LogLevel::CRITICAL, $message, $context);
Chris@0 56 }
Chris@0 57
Chris@0 58 /**
Chris@0 59 * Runtime errors that do not require immediate action but should typically
Chris@0 60 * be logged and monitored.
Chris@0 61 *
Chris@0 62 * @param string $message
Chris@0 63 * @param array $context
Chris@0 64 *
Chris@0 65 * @return void
Chris@0 66 */
Chris@0 67 public function error($message, array $context = array())
Chris@0 68 {
Chris@0 69 $this->log(LogLevel::ERROR, $message, $context);
Chris@0 70 }
Chris@0 71
Chris@0 72 /**
Chris@0 73 * Exceptional occurrences that are not errors.
Chris@0 74 *
Chris@0 75 * Example: Use of deprecated APIs, poor use of an API, undesirable things
Chris@0 76 * that are not necessarily wrong.
Chris@0 77 *
Chris@0 78 * @param string $message
Chris@0 79 * @param array $context
Chris@0 80 *
Chris@0 81 * @return void
Chris@0 82 */
Chris@0 83 public function warning($message, array $context = array())
Chris@0 84 {
Chris@0 85 $this->log(LogLevel::WARNING, $message, $context);
Chris@0 86 }
Chris@0 87
Chris@0 88 /**
Chris@0 89 * Normal but significant events.
Chris@0 90 *
Chris@0 91 * @param string $message
Chris@0 92 * @param array $context
Chris@0 93 *
Chris@0 94 * @return void
Chris@0 95 */
Chris@0 96 public function notice($message, array $context = array())
Chris@0 97 {
Chris@0 98 $this->log(LogLevel::NOTICE, $message, $context);
Chris@0 99 }
Chris@0 100
Chris@0 101 /**
Chris@0 102 * Interesting events.
Chris@0 103 *
Chris@0 104 * Example: User logs in, SQL logs.
Chris@0 105 *
Chris@0 106 * @param string $message
Chris@0 107 * @param array $context
Chris@0 108 *
Chris@0 109 * @return void
Chris@0 110 */
Chris@0 111 public function info($message, array $context = array())
Chris@0 112 {
Chris@0 113 $this->log(LogLevel::INFO, $message, $context);
Chris@0 114 }
Chris@0 115
Chris@0 116 /**
Chris@0 117 * Detailed debug information.
Chris@0 118 *
Chris@0 119 * @param string $message
Chris@0 120 * @param array $context
Chris@0 121 *
Chris@0 122 * @return void
Chris@0 123 */
Chris@0 124 public function debug($message, array $context = array())
Chris@0 125 {
Chris@0 126 $this->log(LogLevel::DEBUG, $message, $context);
Chris@0 127 }
Chris@0 128 }