www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/console/Logger/ConsoleLogger.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\Console\Logger;
  13
  14 use Psr\Log\AbstractLogger;
  15 use Psr\Log\InvalidArgumentException;
  16 use Psr\Log\LogLevel;
  17 use Symfony\Component\Console\Output\ConsoleOutputInterface;
  18 use Symfony\Component\Console\Output\OutputInterface;
  19
  20 /**
  21  * PSR-3 compliant console logger.
  22  *
  23  * @author Kévin Dunglas <dunglas@gmail.com>
  24  *
  25  * @see http://www.php-fig.org/psr/psr-3/
  26  */
  27 class ConsoleLogger extends AbstractLogger
  28 {
  29     const INFO = 'info';
  30     const ERROR = 'error';
  31
  32     private $output;
  33     private $verbosityLevelMap = array(
  34         LogLevel::EMERGENCY => OutputInterface::VERBOSITY_NORMAL,
  35         LogLevel::ALERT => OutputInterface::VERBOSITY_NORMAL,
  36         LogLevel::CRITICAL => OutputInterface::VERBOSITY_NORMAL,
  37         LogLevel::ERROR => OutputInterface::VERBOSITY_NORMAL,
  38         LogLevel::WARNING => OutputInterface::VERBOSITY_NORMAL,
  39         LogLevel::NOTICE => OutputInterface::VERBOSITY_VERBOSE,
  40         LogLevel::INFO => OutputInterface::VERBOSITY_VERY_VERBOSE,
  41         LogLevel::DEBUG => OutputInterface::VERBOSITY_DEBUG,
  42     );
  43     private $formatLevelMap = array(
  44         LogLevel::EMERGENCY => self::ERROR,
  45         LogLevel::ALERT => self::ERROR,
  46         LogLevel::CRITICAL => self::ERROR,
  47         LogLevel::ERROR => self::ERROR,
  48         LogLevel::WARNING => self::INFO,
  49         LogLevel::NOTICE => self::INFO,
  50         LogLevel::INFO => self::INFO,
  51         LogLevel::DEBUG => self::INFO,
  52     );
  53     private $errored = false;
  54
  55     public function __construct(OutputInterface $output, array $verbosityLevelMap = array(), array $formatLevelMap = array())
  56     {
  57         $this->output = $output;
  58         $this->verbosityLevelMap = $verbosityLevelMap + $this->verbosityLevelMap;
  59         $this->formatLevelMap = $formatLevelMap + $this->formatLevelMap;
  60     }
  61
  62     /**
  63      * {@inheritdoc}
  64      */
  65     public function log($level, $message, array $context = array())
  66     {
  67         if (!isset($this->verbosityLevelMap[$level])) {
  68             throw new InvalidArgumentException(sprintf('The log level "%s" does not exist.', $level));
  69         }
  70
  71         $output = $this->output;
  72
  73         // Write to the error output if necessary and available
  74         if (self::ERROR === $this->formatLevelMap[$level]) {
  75             if ($this->output instanceof ConsoleOutputInterface) {
  76                 $output = $output->getErrorOutput();
  77             }
  78             $this->errored = true;
  79         }
  80
  81         // the if condition check isn't necessary -- it's the same one that $output will do internally anyway.
  82         // We only do it for efficiency here as the message formatting is relatively expensive.
  83         if ($output->getVerbosity() >= $this->verbosityLevelMap[$level]) {
  84             $output->writeln(sprintf('<%1$s>[%2$s] %3$s</%1$s>', $this->formatLevelMap[$level], $level, $this->interpolate($message, $context)), $this->verbosityLevelMap[$level]);
  85         }
  86     }
  87
  88     /**
  89      * Returns true when any messages have been logged at error levels.
  90      *
  91      * @return bool
  92      */
  93     public function hasErrored()
  94     {
  95         return $this->errored;
  96     }
  97
  98     /**
  99      * Interpolates context values into the message placeholders.
 100      *
 101      * @author PHP Framework Interoperability Group
 102      *
 103      * @param string $message
 104      * @param array  $context
 105      *
 106      * @return string
 107      */
 108     private function interpolate($message, array $context)
 109     {
 110         if (false === strpos($message, '{')) {
 111             return $message;
 112         }
 113
 114         $replacements = array();
 115         foreach ($context as $key => $val) {
 116             if (null === $val || is_scalar($val) || (\is_object($val) && method_exists($val, '__toString'))) {
 117                 $replacements["{{$key}}"] = $val;
 118             } elseif ($val instanceof \DateTimeInterface) {
 119                 $replacements["{{$key}}"] = $val->format(\DateTime::RFC3339);
 120             } elseif (\is_object($val)) {
 121                 $replacements["{{$key}}"] = '[object '.\get_class($val).']';
 122             } else {
 123                 $replacements["{{$key}}"] = '['.\gettype($val).']';
 124             }
 125         }
 126
 127         return strtr($message, $replacements);
 128     }
 129 }