neilherbertuk / modules

src/ModuleServiceProvider.php

<?php

namespace neilherbertuk\modules;

use Illuminate\Foundation\Application as LaravelApplication;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use neilherbertuk\modules\Console\MakeModuleCommand;

/**
 * Class ModuleServiceProvider
 * @package neilherbertuk\modules
 */
class ModuleServiceProvider extends ServiceProvider
{
    /**
     *
     */
    public function register()
    {
        // Merge Configuration
        $this->mergeConfigFrom(
            __DIR__ . '/Config/modules.php',
            'modules'
        );
    }

    /**
     *
     */
    public function boot()
    {
        $this->bootInConsole();

        $this->bindClosuresToIOC();

        $this->loadModules();
    }

    /**
     *
     */
    protected function bootInConsole()
    {
        if ($this->app instanceof LaravelApplication && $this->app->runningInConsole()) {

            // Publish configuration file
            $this->publishes([
                __DIR__ . '/Config/modules.php' => config_path('modules.php'),
            ], "config");

            // Create app/Modules directory
            if (!file_exists(base_path() . "/app/Modules/")) {
                mkdir(base_path() . "/app/Modules/", 0755, true);
            }

            $this->registerCommands();
        }
    }

    /**
     * Register the commands.
     *
     * @return void
     */
    protected function registerCommands()
    {
        $this->registerModuleMakeCommand();
    }

    /**
     * Register the command.
     *
     * @return void
     */
    protected function registerModuleMakeCommand()
    {
        $this->commands([
            MakeModuleCommand::class
        ]);
    }

    /**
     *
     */
    protected function bindClosuresToIOC()
    {
        // Bind a closure to the IOC container which gets called from module's routes files and returns the module name

This line exceeds maximum limit of 100 characters; contains 119 characters

        $this->bindGetModuleNameClosureToIOC();

        // Bind a closure to the IOC container which gets called from module's routes files and returns the module controller path

This line exceeds maximum limit of 100 characters; contains 130 characters

        $this->bindGetControllerPathClosureToIOC();
    }

    /**
     * @return \Illuminate\Support\Collection
     */
    protected function getEnabledModules()
    {
        // Get what modules to load from config or directory
        if (config("modules.autoload")) {
            return $this->getDirectories(base_path() . "/app/Modules/");
        }
        return collect(config("modules.enabled"));
    }

    /**
     * @param $directory
     * @return \Illuminate\Support\Collection
     */
    protected function getDirectories($directory)
    {
        $disabledModules = collect(config('modules.disabled'));
        $directories = collect(scandir($directory))
            ->reject(function($folder) use ($directory, $disabledModules) {

Expected 1 space after FUNCTION keyword; 0 found

                return !is_dir($directory . DIRECTORY_SEPARATOR . $folder)
                    || $folder == "."
                    || $folder == ".."
                    || $this->isModuleDisabled($folder, $disabledModules);
            });

        return $directories;
    }

    /**
     * @param $moduleToLoad
     * @param $disabledModulesList
     * @return mixed
     */
    protected function isModuleDisabled($moduleToLoad, $disabledModulesList)
    {
        return $disabledModulesList->contains($moduleToLoad);
    }

    /**
     *
     */
    protected function loadModules()
    {
        $modules = $this->getEnabledModules();

        // Load each module
        $modules->each(function($module) {

Expected 1 space after FUNCTION keyword; 0 found

            $this->loadModuleProviders($module);

            $this->loadModuleRoutes($module);

            $this->loadModuleViews($module);

            $this->loadModuleTranslations($module);

            if ($this->app->runningInConsole()) {
                $this->loadModuleMigrations($module);
                $this->loadModuleCommands($module);
            }

        });

Function closing brace must go on the next line following the body; found 1 blank lines before brace

    }

    /**
     * @param $module
     */
    protected function loadModuleRoutes($module)
    {
        $this->loadModuleWebRoutes($module);

        $this->loadModuleAPIRoutes($module);

    }

Function closing brace must go on the next line following the body; found 1 blank lines before brace

    /**
     * @param $module
     */
    protected function loadModuleWebRoutes($module)
    {
        if (file_exists(base_path() .'/app/Modules/' . $module . '/web.php')) {
            $this->loadRoutesFrom(base_path('app/Modules/' . $module . '/web.php'));
        }
    }

    /**
     * @param $module
     */
    protected function loadModuleAPIRoutes($module)
    {
        if (file_exists(base_path() .'/app/Modules/' . $module . '/api.php')) {
            $this->loadRoutesFrom(base_path('app/Modules/' . $module . '/api.php'));
        }
    }

    /**
     * @param $module
     */
    protected function loadModuleViews($module)
    {
        if (is_dir(base_path('app/Modules/' . $module . '/Views'))) {
            $this->loadViewsFrom(base_path('app/Modules/' . $module . '/Views'), strtolower($module));

This line exceeds maximum limit of 100 characters; contains 102 characters

        }
        if (is_dir(base_path('app/Modules/' . $module . '/Resources/Views'))) {
            $this->loadViewsFrom(base_path('app/Modules/' . $module . '/Resources/Views'), strtolower($module));

This line exceeds maximum limit of 100 characters; contains 112 characters

        }
    }

    /**
     * @param $module
     */
    protected function loadModuleMigrations($module)
    {
        if (is_dir(base_path('app/Modules/' . $module . '/Database/Migrations'))) {
            /** @scrutinizer ignore-call */
            $this->loadMigrationsFrom(base_path('app/Modules/' . $module . '/Database/Migrations'), $module);

This line exceeds maximum limit of 100 characters; contains 109 characters

        }
    }

    /**
     * @param $module
     */
    protected function loadModuleProviders($module)
    {
        if (is_dir(base_path('app/Modules/' . $module . '/Providers'))) {
            $serviceProviderStartPos = strlen(base_path('app/Modules/' . $module . '/Providers/'));
            $files = glob(base_path('app/Modules/' . $module . '/Providers/*.php'));
            foreach ($files as $file) {
                $this->app->register($this->app->getNamespace() . "Modules\\$module\Providers\\" . substr($file, $serviceProviderStartPos, -4));

This line exceeds maximum limit of 100 characters; contains 144 characters

            }
        }
    }

    /**
     * @param $module
     */
    protected function loadModuleCommands($module)
    {
        if (is_dir(base_path('app/Modules/' . $module . '/Console/Commands'))) {
            $startPos = strlen(base_path('app/Modules/' . $module . '/Console/Commands/'));
            $files = glob(base_path('app/Modules/' . $module . '/Console/Commands/*.php'));
            foreach ($files as $file) {
                $this->commands($this->app->getNamespace() . "Modules\\$module\Console\Commands\\" . substr($file, $startPos, -4));

This line exceeds maximum limit of 100 characters; contains 131 characters

            }
        }
    }

    /**
     * @param $module
     */
    protected function loadModuleTranslations($module)
    {
        if (is_dir(base_path('app/Modules/' . $module . '/Lang'))) {
            $this->loadTranslationsFrom(base_path('app/Modules/' . $module . '/Lang'), $module);
        }
    }

    /**
     *
     */
    protected function bindGetModuleNameClosureToIOC()
    {
        $this->app->bind('Module::getNameLowerCase', function($app, $parameters) {

Expected 1 space after FUNCTION keyword; 0 found

            return strtolower(substr($parameters['path'], strrpos($parameters['path'], "/") + 1));
        });

        $this->app->bind('Module::getName', function($app, $parameters) {

Expected 1 space after FUNCTION keyword; 0 found

            return substr($parameters['path'], strrpos($parameters['path'], "/") + 1);
        });
    }

    /**
     *
     */
    protected function bindGetControllerPathClosureToIOC()
    {
        $this->app->bind('Module::getControllerPath', function($app, $parameters) {

Expected 1 space after FUNCTION keyword; 0 found

            return $this->app->getNamespace() . 'Modules\\' . substr($parameters['path'], strrpos($parameters['path'], "/") + 1) . '\Controllers';

This line exceeds maximum limit of 100 characters; contains 146 characters

        });
    }
}