rinvex / laravel-widgets

src/Providers/WidgetsServiceProvider.php

<?php

declare(strict_types=1);

namespace Rinvex\Widgets\Providers;

use Illuminate\Routing\Router;
use Illuminate\Support\ServiceProvider;
use Rinvex\Support\Traits\ConsoleTools;
use Rinvex\Widgets\Factories\WidgetFactory;
use Illuminate\View\Compilers\BladeCompiler;
use Rinvex\Widgets\Console\Commands\WidgetMakeCommand;

class WidgetsServiceProvider extends ServiceProvider
{
    use ConsoleTools;

    /**
     * The commands to be registered.
     *
     * @var array
     */
    protected $commands = [
        WidgetMakeCommand::class => 'command.rinvex.widgets.make',
    ];

    /**
     * Register the service provider.
     *
     * @return void
     */
    public function register(): void
    {
        // Merge config
        $this->mergeConfigFrom(realpath(__DIR__.'/../../config/config.php'), 'rinvex.widgets');

        $this->registerWidgetFactory();
        $this->registerWidgetCollection();

        // Register console commands
        $this->registerCommands($this->commands);
    }

    /**
     * Register the widget collection.
     *
     * @return void
     */
    public function registerWidgetCollection(): void
    {
        // Register widget collection
        $this->app->singleton('rinvex.widgets.list', function ($app) {

The parameter $app is not used and could be removed.

            return collect();
        });
    }

    /**
     * Register the widget factory.
     *
     * @return void
     */
    public function registerWidgetFactory(): void
    {
        $this->app->singleton('rinvex.widgets', WidgetFactory::class);

        $this->app->singleton('rinvex.widgets.group', function () {
            return collect();
        });
    }

    /**
     * Bootstrap the application events.
     *
     * @return void
     */
    public function boot(Router $router): void
    {
        // Load resources
        $this->loadRoutes($router);
        $this->loadViewsFrom(__DIR__.'/../../resources/views', 'rinvex/widgets');

        // Publish Resources
        $this->publishesViews('rinvex/laravel-widgets');
        $this->publishesConfig('rinvex/laravel-widgets');

        // Register blade extensions
        $this->registerBladeExtensions();
    }

    /**
     * Load the routes.
     *
     * @param \Illuminate\Routing\Router $router
     *
     * @return void
     */
    protected function loadRoutes(Router $router): void
    {
        // Load routes
        if (! $this->app->routesAreCached() && config('rinvex.widgets.register_routes')) {

The method routesAreCached() does not seem to exist on object<Illuminate\Contracts\Foundation\Application>.

            $router->get('widget', function () {
                $factory = app('rinvex.widgets');
                $widgetName = urldecode(request()->input('name'));
                $widgetParams = $factory->decryptWidgetParams(request()->input('params', ''));

                return call_user_func_array([$factory, $widgetName], $widgetParams);
            })->name('rinvex.widgets.async')->middleware('web');

            $this->app->booted(function () use ($router) {
                $router->getRoutes()->refreshNameLookups();
                $router->getRoutes()->refreshActionLookups();
            });
        }
    }

    /**
     * Register console commands.
     *
     * @param array $commands
     *
     * @return void
     */
    protected function registerCommands(array $commands): void
    {
        // Register artisan commands
        $this->app->singleton('command.rinvex.widgets.make', function ($app) {
            return new WidgetMakeCommand($app['files']);
        });

        $this->commands(array_values($commands));
    }

    /**
     * Register the blade extensions.
     *
     * @return void
     */
    protected function registerBladeExtensions(): void
    {
        $this->app->afterResolving('blade.compiler', function (BladeCompiler $bladeCompiler) {
            // @widget('App\Widgets\ExampleWidget', $paramArray, $asyncFlag)
            $bladeCompiler->directive('widget', function ($expression) {
                return "<?php echo app('rinvex.widgets')->make({$expression}); ?>";
            });

            // @widgetGroup('widgetGroupName')
            $bladeCompiler->directive('widgetGroup', function ($expression) {
                return "<?php echo app('rinvex.widgets.group')->group({$expression})->render(); ?>";
            });
        });
    }
}