gyselroth / micro-log

src/Log.php

<?php

declare(strict_types=1);

/**
 * Balloon
 *
 * @author      Raffael Sahli <sahli@gyselroth.net>
 * @copyright   Copryright (c) 2012-2017 gyselroth GmbH (https://gyselroth.com)
 * @license     GPL-3.0 https://opensource.org/licenses/GPL-3.0
 */

namespace Micro\Log;

use Micro\Container\AdapterAwareInterface;
use Micro\Log\Adapter\AdapterInterface;
use Psr\Log\AbstractLogger;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;

class Log extends AbstractLogger implements LoggerInterface, AdapterAwareInterface
{
    /**
     * Priorities.
     */
    const PRIORITIES = [
        LogLevel::EMERGENCY => 0,
        LogLevel::ALERT => 1,
        LogLevel::CRITICAL => 2,
        LogLevel::ERROR => 3,
        LogLevel::WARNING => 4,
        LogLevel::NOTICE => 5,
        LogLevel::INFO => 6,
        LogLevel::DEBUG => 7,
    ];

    /**
     * Adapters.
     *
     * @var array
     */
    protected $adapter = [];

    /**
     * static context.
     *
     * @var array
     */
    protected $context = [];

    /**
     * Initialize logger.
     *
     * @param iterable $config
     */
    public function __construct(? Iterable $config = null)
    {
        $this->setOptions($config);
    }

    /**
     * Set options.
     *
     * @param iterable $config
     *
     * @return Log
     */
    public function setOptions(? Iterable $config = null): self
    {
        if (null === $config) {
            return $this;
        }

        foreach ($config as $option => $value) {
            switch ($option) {
                case 'adapter':
                    foreach ($value as $name => $adapter) {
                        $this->injectAdapter($name, $adapter);
                    }

                break;
                default:
                    throw new Exception('invalid option '.$option.' given');
            }
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getDefaultAdapter(): array
    {
        return [];
    }

    /**
     * {@inheritdoc}
     */
    public function hasAdapter(string $name): bool
    {
        return isset($this->adapter[$name]);
    }

    /**
     * {@inheritdoc}
     */
    public function injectAdapter($adapter, ?string $name = null): AdapterAwareInterface
    {
        if (!($adapter instanceof AdapterInterface)) {
            throw new Exception('adapter needs to implement AdapterInterface');
        }

        if (null === $name) {
            $name = get_class($adapter);
        }

        if ($this->hasAdapter($name)) {
            throw new Exception('log adapter '.$name.' is already registered');
        }

        $this->adapter[$name] = $adapter;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getAdapter(string $name)
    {
        if (!$this->hasAdapter($name)) {
            throw new Exception('log adapter '.$name.' is not registered');
        }

        return $this->adapter[$name];
    }

    /**
     * Get adapters.
     *
     * @param array $adapters
     *
     * @return array
     */
    public function getAdapters(array $adapters = []): array
    {
        if (empty($adapter)) {

The variable $adapter does not exist. Did you maybe mean $adapters?

            return $this->adapter;
        }
        $list = [];
        foreach ($adapter as $name) {
            if (!$this->hasAdapter($name)) {
                throw new Exception('log adapter '.$name.' is not registered');
            }
            $list[$name] = $this->adapter[$name];
        }

        return $list;
    }

    /**
     * Log message.
     *
     * @param string $level
     * @param string $message
     * @param array  $context
     *
     * @return bool
     */
    public function log($level, $message, array $context = []): bool
    {
        if (!array_key_exists($level, self::PRIORITIES)) {
            throw new Exception('log level '.$level.' is unkown');
        }

        foreach ($this->adapter as $adapter) {
            $prio = $adapter->getLevel();

            if (self::PRIORITIES[$level] <= $prio) {
                $msg = $this->_format($message, $adapter->getFormat(), $adapter->getDateFormat(), $level, $context);
                $adapter->log($level, $msg);
            }
        }

        return true;

The expression return true returns the type true which is incompatible with the return type mandated by Psr\Log\LoggerInterface::log() of void.

    }

    /**
     *  Add static context.
     *
     * @param string $name
     * @param string $value
     *
     * @return Log
     */
    public function addContext(string $name, string $value): self
    {
        $this->context[$name] = $value;

        return $this;
    }

    /**
     * Log message.
     *
     * @param string $message
     * @param string $format
     * @param string $date_format
     * @param string $level
     * @param array  $context
     *
     * @return string
     */
    protected function _format(string $message, string $format, string $date_format, string $level, array $context = []): string
    {
        $parsed = preg_replace_callback('/(\{(([a-z]\.*)+)\})/', function ($match) use ($message, $level, $date_format, $context) {
            $key = '';
            $context = array_merge($this->context, $context);

            if ($sub_context = strpos($match[2], '.')) {
                $parts = explode('.', $match[2]);
                $name = $parts[0];
                $key = $parts[1];
            } else {
                $name = $match[2];
            }

            switch ($name) {
                case 'level':
                    return $match[0] = $level;
                    break;

break is not strictly necessary here and could be removed.

                case 'date':
                    return $match[0] = date($date_format);
                    break;
                case 'message':
                    $replace = [];
                    foreach ($context as $key => $val) {
                        if (!is_array($val) && (!is_object($val) || method_exists($val, '__toString'))) {
                            $replace['{'.$key.'}'] = $val;
                        } else {
                            $replace['{'.$key.'}'] = json_encode($val);
                        }
                    }

                    return $match[0] = strtr($message, $replace);
                    break;
                case 'context':
                    if ($sub_context) {
                        if (array_key_exists($key, $context)) {
                            if (!is_array($context[$key]) && (!is_object($context[$key]) || method_exists($context[$key], '__toString'))) {
                                return $match[0] = $context[$key];
                            }

                            return $match[0] = json_encode($context[$key]);
                        }
                    } else {
                        return $match[0] = json_encode($context);
                    }

                    break;
            }
        }, $format);

        return $parsed;
    }
}