php-flasher/src/Laravel/Support/PluginServiceProvider.php

<?php

declare(strict_types=1);

namespace Flasher\Laravel\Support;

use Flasher\Prime\Factory\NotificationFactoryLocator;
use Flasher\Prime\Plugin\PluginInterface;
use Illuminate\Contracts\Config\Repository;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Contracts\Foundation\CachesConfiguration;
use Illuminate\Support\ServiceProvider;

/**
 * Base service provider for PHPFlasher plugins in Laravel.
 */
abstract class PluginServiceProvider extends ServiceProvider
{
    /**
     * The plugin instance.
     */
    protected PluginInterface $plugin;

    abstract public function createPlugin(): PluginInterface;

    public function register(): void
    {
        $this->plugin = $this->createPlugin();

        $this->registerConfiguration();
        $this->afterRegister();
    }

    public function boot(): void
    {
        $this->registerFactory();
        $this->afterBoot();
    }

    public function getConfigurationFile(): string
    {
        return rtrim($this->getResourcesDir(), '/').'/config.php';
    }

    protected function getConfig(?string $key = null, mixed $default = null): mixed
    {
        /** @var Repository $config */
        $config = $this->app->make('config');

        return $key ? $config->get('flasher.'.$key, $default) : $config->get('flasher');
    }

    protected function getResourcesDir(): string
    {
        $r = new \ReflectionClass($this);

        return pathinfo($r->getFileName() ?: '', \PATHINFO_DIRNAME).'/Resources/';
    }

    protected function registerConfiguration(): void
    {
        if ($this->app instanceof CachesConfiguration && $this->app->configurationIsCached()) {
            return;
        }

        $alias = $this->plugin->getAlias();
        $config = $this->app->make('config');

        $key = 'flasher' === $alias ? $alias : "flasher.plugins.$alias";
        /**
         * @var array{
         *      scripts?: string|string[],
         *      styles?: string|string[],
         *      options?: array<string, mixed>,
         *  } $current
         */
        $current = $config->get($key, []);

        $config->set($key, $this->plugin->normalizeConfig($current));
    }

    protected function afterRegister(): void
    {
    }

    protected function afterBoot(): void
    {
    }

    protected function registerFactory(): void
    {
        $this->app->singleton($this->plugin->getServiceId(), function (Application $app) {
            $factory = $this->plugin->getFactory();

            return new $factory($app->make('flasher.storage_manager'));
        });

        $identifier = $this->plugin->getServiceId();
        foreach ((array) $this->plugin->getServiceAliases() as $alias) {
            $this->app->alias($identifier, $alias);
        }

        $this->app->extend('flasher.factory_locator', function (NotificationFactoryLocator $factoryLocator, Application $app) {
            $factoryLocator->addFactory($this->plugin->getAlias(), fn () => $app->make($this->plugin->getServiceId()));

            return $factoryLocator;
        });
    }
}