Uploading files

Author: Qu1eeeOJ

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,10 @@
+/vendor
+composer.phar
+composer.lock
+.DS_Store
+Thumbs.db
+/phpunit.xml
+/.idea
+/.fleet
+/.vscode
+.phpunit.result.cache

README.md

@@ -0,0 +1,77 @@
+# PHP LARAVEL LOGGER
+This library provides the use of laravel logger along with the output of information to the console.
+
+***This package can be useful when running laravel commands***
+
+## Installation
+```sh
+composer require qu1eeeoj/laravel-logger
+```
+
+## Example
+```php
+<?php
+
+namespace App\Console\Commands;
+
+use App\Models\User;
+use Illuminate\Console\Command;
+use Qu1eeeOJ\LaravelLogger\LoggerService;
+
+class CreateUserCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'user:create {email}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create user with admin privileges';
+
+    /**
+     * CreateUserCommand constructor
+     *
+     * @param LoggerService $logger - Logger with output console
+     */
+    public function __construct(private readonly LoggerService $logger = new LoggerService('daily'))
+    {
+        // Call parent constructor
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle(): int
+    {
+        // Create user
+        $user = User::query()->create([]);
+        $this->logger->info('User created successfully');
+
+        // Adding admin privileges
+        $user->permissions()->setRole('admin');
+        $this->logger->info('Now user has admin privileges');
+
+        return Command::SUCCESS;
+    }
+}
+```
+
+## Methods - LoggerService
+- alert(string $message): void
+- critical(string $message): void
+- debug(string $message): void - works with the console, but in working mode it does not write information to the log, but only the console!
+- emergency(string $message): void
+- error(string $message): void - works with console
+- info(string $message): void - works with console
+- notice(string $message): void
+- warning(string $message): void - works with console
+- withConsoleLogger(): bool - Determine whether the console logger is used

composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "qu1eeeoj/laravel-logger",
+    "description": "Logger with console logger",
+    "keywords": [
+        "Laravel logger",
+        "Laravel log",
+        "Laravel logger with console output"
+    ],
+    "type": "library",
+    "autoload": {
+        "psr-4": {
+            "Qu1eeeOJ\\LaravelLogger\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "qu1eeeoj"
+        }
+    ],
+    "minimum-stability": "dev",
+    "require": {
+        "php": "^8.1"
+    }
+}

src/Exceptions/MethodNotFoundException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Qu1eeeOJ\LaravelLogger\Exceptions;
+
+class MethodNotFoundException extends \Exception
+{
+    //
+}

src/Exceptions/StyleNotFoundException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Qu1eeeOJ\LaravelLogger\Exceptions;
+
+class StyleNotFoundException extends \Exception
+{
+    //
+}

src/Formatters/ConsoleMessageFormatter.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Qu1eeeOJ\LaravelLogger\Formatters;
+
+use Illuminate\Support\Carbon;
+use Qu1eeeOJ\LaravelLogger\Interfaces\FormatterWithStyleInterface;
+use Qu1eeeOJ\LaravelLogger\Traits\MessageWithPrefix;
+
+class ConsoleMessageFormatter implements FormatterWithStyleInterface
+{
+    use MessageWithPrefix;
+
+    /**
+     * @var string
+     */
+    private string $style = '';
+
+    /**
+     * Set style
+     *
+     * @param string $style
+     *
+     * @return static
+     */
+    public function setStyle(string $style): static
+    {
+        $this->style = $style;
+
+        return $this;
+    }
+
+    /**
+     * Format the message text
+     *
+     * @param string $message
+     *
+     * @return string
+     */
+    public function getFormattedMessage(string $message): string
+    {
+        return sprintf(
+            '<%s>[%s] %s: %s: %s</%s>',
+            $this->style,
+            Carbon::now()->toDateTimeLocalString(),
+            mb_strtoupper($this->style),
+            $this->getPrefix(),
+            $message,
+            $this->style
+        );
+    }
+}

src/Formatters/LogMessageFormatter.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Qu1eeeOJ\LaravelLogger\Formatters;
+
+use Qu1eeeOJ\LaravelLogger\Interfaces\FormatterInterface;
+use Qu1eeeOJ\LaravelLogger\Traits\MessageWithPrefix;
+
+class LogMessageFormatter implements FormatterInterface
+{
+    use MessageWithPrefix;
+
+    /**
+     * Format the message text
+     *
+     * @param string $message
+     *
+     * @return string
+     */
+    public function getFormattedMessage(string $message): string
+    {
+        return empty($this->getPrefix())
+            ? $message
+            : sprintf('%s: %s', $this->getPrefix(), $message);
+    }
+}

src/Interfaces/FormatterInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Qu1eeeOJ\LaravelLogger\Interfaces;
+
+interface FormatterInterface
+{
+//    /**
+//     * Set prefix to message
+//     *
+//     * @param string $prefix
+//     *
+//     * @return static
+//     */
+//    public function setPrefix(string $prefix): static;
+
+    /**
+     * Format the message text
+     *
+     * @param string $message
+     *
+     * @return string
+     */
+    public function getFormattedMessage(string $message): string;
+}

src/Interfaces/FormatterWithStyleInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Qu1eeeOJ\LaravelLogger\Interfaces;
+
+interface FormatterWithStyleInterface extends FormatterInterface
+{
+    /**
+     * Set style
+     *
+     * @param string $style
+     *
+     * @return static
+     */
+    public function setStyle(string $style): static;
+}

src/LoggerConsoleService.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace Qu1eeeOJ\LaravelLogger;
+
+use Illuminate\Support\Facades\App;
+use Qu1eeeOJ\LaravelLogger\Exceptions\StyleNotFoundException;
+use Qu1eeeOJ\LaravelLogger\Formatters\ConsoleMessageFormatter;
+use Qu1eeeOJ\LaravelLogger\Interfaces\FormatterWithStyleInterface;
+use Symfony\Component\Console\Output\ConsoleOutput;
+
+/**
+ * @method void info(string $message)
+ * @method void error(string $message)
+ * @method void warning(string $message)
+ * @method void debug(string $message)
+ */
+class LoggerConsoleService
+{
+    /**
+     * @var ConsoleOutput
+     */
+    private readonly ConsoleOutput $console;
+
+    /**
+     * We are casting the style of operation from laravel logger for console output
+     *
+     * @var array<string, string>
+     */
+     private array $styles = [
+        'info' => 'info',
+        'error' => 'error',
+        'warning' => 'warn',
+        'debug' => 'info'
+    ];
+
+    /**
+     * LoggerConsoleService constructor
+     *
+     * @param string|array|null $prefix
+     * @param FormatterWithStyleInterface $formatter
+     */
+    public function __construct(
+        protected readonly string|array|null $prefix = null,
+        public readonly FormatterWithStyleInterface $formatter = new ConsoleMessageFormatter()
+    )
+    {
+        $this->console = App::make(ConsoleOutput::class);
+
+        // if the prefix is not null, then we put the prefix
+        if (! is_null($this->prefix)) {
+            $this->formatter->setPrefix($this->prefix);
+        }
+    }
+
+    /**
+     * Magic method
+     *
+     * @param string $style
+     * @param array $arguments
+     *
+     * @return void
+     *
+     * @throws StyleNotFoundException
+     */
+    public function __call(string $style, array $arguments): void
+    {
+        $this->writeln($style, $arguments[0]);
+    }
+
+    /**
+     * Writing to console output with new line
+     *
+     * @param string $style
+     * @param string $message
+     *
+     * @return void
+     *
+     * @throws StyleNotFoundException
+     */
+    public function writeln(string $style, string $message): void
+    {
+        $this->write($style, $message, true);
+    }
+
+    /**
+     * Writing to console output
+     *
+     * @param string $style
+     * @param string $message
+     * @param bool $newLine
+     *
+     * @return void
+     *
+     * @throws StyleNotFoundException
+     */
+    public function write(string $style, string $message, bool $newLine = false): void
+    {
+        // Check style for console output
+        if (! array_key_exists($style, $this->styles)) {
+            throw new StyleNotFoundException(sprintf("Style [%s] not found in console styles", $style));
+        }
+
+        // Setting the style to the formatter
+        $this->formatter->setStyle($this->styles[$style]);
+
+        $this->console->write($this->formatter->getFormattedMessage($message), $newLine);
+    }
+}