jidaikobo-shibata / log

src/Log.php

<?php

/**
 * Log class (Static Wrapper for LogPsr3)
 *
 * Provides a static interface for the PSR-3 compliant LogPsr3 class.
 *
 * This class allows developers to use logging functionality via static
 * methods while maintaining the flexibility of the LogPsr3 instance-based design.
 *
 * @method   static void write(string $message)
 * @category Utility
 * @package  jidaikobo/log
 * @author   jidaikobo-shibata <shibata@jidaikobo.com>
 * @license  MIT License <https://opensource.org/licenses/MIT>
 * @link     https://github.com/jidaikobo-shibata/log
 */

namespace Jidaikobo;

use Jidaikobo\LogPsr3;

class Log
{
    private static ?LogPsr3 $instance = null;

    /**
     * Initialize the Logger instance.
     *
     * @param string $logFile     path of log file
     * @param int    $maxFileSize log rotation size
     *
     * @return void
     */
    public static function init(string $logFile = null, int $maxFileSize = 10 * 1024 * 1024): void
    {
        if ($logFile === null) {
            $logFile = dirname(__DIR__, 4) . '/logs/php.log'; // default project root
        }

        $logDir = dirname($logFile);
        if (!is_dir($logDir)) {
            mkdir($logDir, 0777, true);
        }

        self::$instance = new LogPsr3($logFile, $maxFileSize);
    }

    /**
     * Get the Logger instance.
     *
     * @return LogPsr3
     * @throws \RuntimeException if the instance is not initialized.
     */
    public static function getInstance(): LogPsr3
    {
        if (!self::$instance) {
            self::init();

            if (!self::$instance) {
                throw new \RuntimeException('Logger instance is not initialized.');
            }
        }

        return self::$instance;

The expression return self::instance could return the type null which is incompatible with the type-hinted return Jidaikobo\LogPsr3. Consider adding an additional type-check to rule them out.

    }

    /**
     * Forward static calls to the Logger instance.
     *
     * @param string            $method called method name
     * @param array<int, mixed> $args   arguments
     *
     * @return mixed
     */
    public static function __callStatic(string $method, array $args)
    {
        $instance = self::getInstance();

        if (!method_exists($instance, $method)) {
            $availableMethods = implode(', ', get_class_methods($instance));
            $message = sprintf(
                "Method '%s' does not exist on LogPsr3. Available methods: %s",
                $method,
                $availableMethods
            );
            throw new \BadMethodCallException($message);
        }

        return $instance->$method(...$args);
    }

    /**
     * Add static method for phpstan
     *
     * @param mixed $message The message to log.
     * @param string $level The log level.
     *
     * @return void
     */
    public static function write(mixed $message, string $level = 'INFO'): void
    {
        self::getInstance()->write($message, $level);
    }
}