BeyondCode\LaravelWebSockets\Server\Loggers\Logger

Complexity

Total Complexity

10

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	3

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	isEnabled()	0	6	1
A	__construct()	0	4	1
A	enable()	0	6	1
A	verbose()	0	6	1
A	info()	0	4	1
A	warn()	0	10	2
A	error()	0	4	1
A	line()	0	6	2

<?php

namespace BeyondCode\LaravelWebSockets\Server\Loggers;

use Symfony\Component\Console\Formatter\OutputFormatterStyle;
use Symfony\Component\Console\Output\OutputInterface;

class Logger
{
    /**
     * The console output interface.
     *
     * @var \Symfony\Component\Console\Output\OutputInterface
     */
    protected $consoleOutput;

    /**
     * Wether the logger is enabled.
     *
     * @var bool
     */
    protected $enabled = false;

    /**
     * Wether the verbose mode is on.
     *
     * @var bool
     */
    protected $verbose = false;

    /**
     * Check if the logger is active.
     *
     * @return bool
     */
    public static function isEnabled(): bool
    {
        $logger = app(WebSocketsLogger::class);

        return $logger->enabled;
    }

    /**
     * Create a new Logger instance.
     *
     * @param  \Symfony\Component\Console\Output\OutputInterface  $consoleOutput
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(OutputInterface $consoleOutput)
    {
        $this->consoleOutput = $consoleOutput;
    }

    /**
     * Enable the logger.
     *
     * @param  bool  $enabled
     * @return $this
     */
    public function enable($enabled = true)
    {
        $this->enabled = $enabled;

        return $this;
    }

    /**
     * Enable the verbose mode.
     *
     * @param  bool  $verbose
     * @return $this
     */
    public function verbose($verbose = false)
    {
        $this->verbose = $verbose;

        return $this;
    }

    /**
     * Trigger an Info message.
     *
     * @param  string  $message
     * @return void
     */
    protected function info(string $message)
    {
        $this->line($message, 'info');
    }

    /**
     * Trigger a Warning message.
     *
     * @param  string  $message
     * @return void
     */
    protected function warn(string $message)
    {
        if (! $this->consoleOutput->getFormatter()->hasStyle('warning')) {
            $style = new OutputFormatterStyle('yellow');

            $this->consoleOutput->getFormatter()->setStyle('warning', $style);
        }

        $this->line($message, 'warning');
    }

    /**
     * Trigger an Error message.
     *
     * @param  string  $message
     * @return void
     */
    protected function error(string $message)
    {
        $this->line($message, 'error');
    }

    protected function line(string $message, string $style)
    {
        $this->consoleOutput->writeln(
            $style ? "<{$style}>{$message}</{$style}>" : $message
        );
    }
}