You are here

Home » API reference » Service Container 7.2 » LoggerTrait.php

trait LoggerTrait in Service Container 7.2

Same name and namespace in other branches
  1. 7 lib/Psr/Log/LoggerTrait.php \Psr\Log\LoggerTrait

This is a simple Logger trait that classes unable to extend AbstractLogger (because they extend another class, etc) can include.

It simply delegates all log-level-specific methods to the `log` method to reduce boilerplate code that a simple Logger that does the same thing with messages regardless of the error level has to implement.

Hierarchy

File

lib/Psr/Log/LoggerTrait.php, line 13

Namespace

Psr\Log
View source 
trait LoggerTrait {

  /**
   * System is unusable.
   *
   * @param string $message
   * @param array $context
   * @return null
   */
  public function emergency($message, array $context = array()) {
    $this
      ->log(LogLevel::EMERGENCY, $message, $context);
  }

  /**
   * 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(LogLevel::ALERT, $message, $context);
  }

  /**
   * 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(LogLevel::CRITICAL, $message, $context);
  }

  /**
   * 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(LogLevel::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(LogLevel::WARNING, $message, $context);
  }

  /**
   * Normal but significant events.
   *
   * @param string $message
   * @param array $context
   * @return null
   */
  public function notice($message, array $context = array()) {
    $this
      ->log(LogLevel::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(LogLevel::INFO, $message, $context);
  }

  /**
   * Detailed debug information.
   *
   * @param string $message
   * @param array $context
   * @return null
   */
  public function debug($message, array $context = array()) {
    $this
      ->log(LogLevel::DEBUG, $message, $context);
  }

  /**
   * Logs with an arbitrary level.
   *
   * @param mixed $level
   * @param string $message
   * @param array $context
   * @return null
   */
  public abstract function log($level, $message, array $context = array());

}

Members

Namesort descending Modifiers Type Description Overrides
LoggerTrait::alert public function Action must be taken immediately.
LoggerTrait::critical public function Critical conditions.
LoggerTrait::debug public function Detailed debug information.
LoggerTrait::emergency public function System is unusable.
LoggerTrait::error public function Runtime errors that do not require immediate action but should typically be logged and monitored.
LoggerTrait::info public function Interesting events.
LoggerTrait::log abstract public function Logs with an arbitrary level.
LoggerTrait::notice public function Normal but significant events.
LoggerTrait::warning public function Exceptional occurrences that are not errors.