flipbox\ember\modules\LoggerTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
	getLogFileName()	0	1	?
A	isDebugModeEnabled()	0	4	1
A	getLogFile()	0	4	1
A	getLogger()	0	8	2
A	resolveLogger()	0	17	3
A	loggerComponent()	0	14	1
A	loggerFileTarget()	0	16	3
A	prepLogFileName()	0	6	1
A	debug()	0	4	1
A	error()	0	4	1
A	warning()	0	4	1
A	info()	0	4	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/craft-ember/blob/master/LICENSE
 * @link       https://github.com/flipboxfactory/craft-ember
 */

namespace flipbox\ember\modules;

use Craft;
use craft\helpers\StringHelper;
use craft\log\FileTarget;
use yii\log\Dispatcher;
use yii\log\Logger;

/**
 * This trait will create and attach a separate log dispatcher / logger.  It allows modules to log to a separate
 * log file, while still supporting the use of categories.
 *
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.2
 */
trait LoggerTrait
{
    /**
     * @var Logger|null
     */
    private static $logger;

    /**
     * The log file name
     *
     * @return string
     */
    abstract protected static function getLogFileName(): string;

    /**
     * @inheritdoc
     */
    protected static function isDebugModeEnabled()
    {
        return false;
    }

    /**
     * @return string
     */
    public static function getLogFile(): string
    {
        return '@storage/logs/' . self::prepLogFileName(static::getLogFileName());
    }

    /**
     * @return Logger
     */
    public static function getLogger(): Logger
    {
        if (self::$logger === null) {
            self::$logger = static::resolveLogger();
        }

        return self::$logger;
    }

    /**
     * @return Logger
     */
    protected static function resolveLogger(): Logger
    {
        try {
            $logger = Craft::createObject(static::loggerComponent());

            if ($logger instanceof Logger) {
                return $logger;
            }
        } catch (\Throwable $e) {
            Craft::error(
                'An exception was caught trying to create a logger: ' . $e->getMessage(),
                static::getLogFileName()
            );
        }

        return Craft::getLogger();
    }

    /**
     * @return \Closure
     */
    protected static function loggerComponent()
    {
        return function () {
            $dispatcher = Craft::createObject([
                'class' => Dispatcher::class,
                'logger' => new Logger(),
                'targets' => [
                    static::loggerFileTarget()
                ]
            ]);

            return $dispatcher->getLogger();
        };
    }

    /**
     * @return array
     */
    protected static function loggerFileTarget()
    {
        $generalConfig = Craft::$app->getConfig()->getGeneral();

        return [
            'class' => FileTarget::class,
            'fileMode' => $generalConfig->defaultFileMode,
            'dirMode' => $generalConfig->defaultDirMode,
            'logVars' => [],
            'levels' => array_merge(
                ['error', 'warning'],
                (static::isDebugModeEnabled() || YII_DEBUG) ? ['trace', 'info'] : []
            ),
            'logFile' => static::getLogFile()
        ];
    }

    /**
     * @param string $fileName
     * @return string
     */
    private static function prepLogFileName(string $fileName): string
    {
        return StringHelper::toKebabCase(
            StringHelper::removeRight($fileName, '.log')
        ) . '.log';
    }

    /**
     * Logs a debug message.
     * Trace messages are logged mainly for development purpose to see
     * the execution work flow of some code. This method will only log
     * a message when the application is in debug mode.
     * @param string|array $message the message to be logged. This can be a simple string or a more
     * complex data structure, such as array.
     * @param string $category the category of the message.
     * @since 2.0.14
     */
    public static function debug($message, $category = 'general')
    {
        static::getLogger()->log($message, Logger::LEVEL_TRACE, $category);
    }

    /**
     * Logs an error message.
     * An error message is typically logged when an unrecoverable error occurs
     * during the execution of an application.
     * @param string|array $message the message to be logged. This can be a simple string or a more
     * complex data structure, such as array.
     * @param string $category the category of the message.
     */
    public static function error($message, $category = 'general')
    {
        static::getLogger()->log($message, Logger::LEVEL_ERROR, $category);
    }

    /**
     * Logs a warning message.
     * A warning message is typically logged when an error occurs while the execution
     * can still continue.
     * @param string|array $message the message to be logged. This can be a simple string or a more
     * complex data structure, such as array.
     * @param string $category the category of the message.
     */
    public static function warning($message, $category = 'general')
    {
        static::getLogger()->log($message, Logger::LEVEL_WARNING, $category);
    }

    /**
     * Logs an informative message.
     * An informative message is typically logged by an application to keep record of
     * something important (e.g. an administrator logs in).
     * @param string|array $message the message to be logged. This can be a simple string or a more
     * complex data structure, such as array.
     * @param string $category the category of the message.
     */
    public static function info($message, $category = 'general')
    {
        static::getLogger()->log($message, Logger::LEVEL_INFO, $category);
    }
}