PermissionServiceProvider::boot() - Code Metrics - spatie/laravel-permission - Measure and Improve Code Quality continuously with Scrutinizer

PermissionServiceProvider::boot() A
last analyzed 2020-09-27 20:44 UTC

↳ Parent: PermissionServiceProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	2
dl	0
loc	30
rs	9.44
c	0
b	0
f	0

<?php

namespace Spatie\Permission;

use Illuminate\Routing\Route;
use Illuminate\Support\Collection;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\ServiceProvider;
use Illuminate\View\Compilers\BladeCompiler;
use Spatie\Permission\Contracts\Role as RoleContract;
use Spatie\Permission\Contracts\Permission as PermissionContract;

class PermissionServiceProvider extends ServiceProvider
{
    public function boot(PermissionRegistrar $permissionLoader, Filesystem $filesystem)
    {
        if (function_exists('config_path')) { // function not available and 'publish' not relevant in Lumen
            $this->publishes([
                __DIR__.'/../config/permission.php' => config_path('permission.php'),
            ], 'config');

            $this->publishes([
                __DIR__.'/../database/migrations/create_permission_tables.php.stub' => $this->getMigrationFileName($filesystem),
            ], 'migrations');
        }

        $this->registerMacroHelpers();

        $this->commands([
            Commands\CacheReset::class,
            Commands\CreateRole::class,
            Commands\CreatePermission::class,
            Commands\Show::class,
        ]);

        $this->registerModelBindings();

        $permissionLoader->clearClassPermissions();
        $permissionLoader->registerPermissions();

        $this->app->singleton(PermissionRegistrar::class, function ($app) use ($permissionLoader) {

            return $permissionLoader;
        });
    }

    public function register()
    {
        $this->mergeConfigFrom(
            __DIR__.'/../config/permission.php',
            'permission'
        );

        $this->registerBladeExtensions();
    }

    protected function registerModelBindings()
    {
        $config = $this->app->config['permission.models'];
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        if (! $config) {
            return;
        }

        $this->app->bind(PermissionContract::class, $config['permission']);
        $this->app->bind(RoleContract::class, $config['role']);
    }

    protected function registerBladeExtensions()
    {
        $this->app->afterResolving('blade.compiler', function (BladeCompiler $bladeCompiler) {
            $bladeCompiler->directive('role', function ($arguments) {

                list($role, $guard) = explode(',', $arguments.',');

                return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
            });
            $bladeCompiler->directive('elserole', function ($arguments) {

                list($role, $guard) = explode(',', $arguments.',');

                return "<?php elseif(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
            });
            $bladeCompiler->directive('endrole', function () {
                return '<?php endif; ?>';
            });

            $bladeCompiler->directive('hasrole', function ($arguments) {

                list($role, $guard) = explode(',', $arguments.',');

                return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
            });
            $bladeCompiler->directive('endhasrole', function () {
                return '<?php endif; ?>';
            });

            $bladeCompiler->directive('hasanyrole', function ($arguments) {

                list($roles, $guard) = explode(',', $arguments.',');

                return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasAnyRole({$roles})): ?>";
            });
            $bladeCompiler->directive('endhasanyrole', function () {
                return '<?php endif; ?>';
            });

            $bladeCompiler->directive('hasallroles', function ($arguments) {

                list($roles, $guard) = explode(',', $arguments.',');

                return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasAllRoles({$roles})): ?>";
            });
            $bladeCompiler->directive('endhasallroles', function () {
                return '<?php endif; ?>';
            });

            $bladeCompiler->directive('unlessrole', function ($arguments) {

                list($role, $guard) = explode(',', $arguments.',');

                return "<?php if(!auth({$guard})->check() || ! auth({$guard})->user()->hasRole({$role})): ?>";
            });
            $bladeCompiler->directive('endunlessrole', function () {
                return '<?php endif; ?>';
            });
        });
    }

    protected function registerMacroHelpers()
    {
        if (! method_exists(Route::class, 'macro')) { // Lumen
            return;
        }

        Route::macro('role', function ($roles = []) {

            if (! is_array($roles)) {
                $roles = [$roles];
            }

            $roles = implode('|', $roles);

            $this->middleware("role:$roles");


            return $this;
        });

        Route::macro('permission', function ($permissions = []) {

            if (! is_array($permissions)) {
                $permissions = [$permissions];
            }

            $permissions = implode('|', $permissions);

            $this->middleware("permission:$permissions");


            return $this;
        });
    }

    /**
     * Returns existing migration file if found, else uses the current timestamp.
     *
     * @param Filesystem $filesystem
     * @return string
     */
    protected function getMigrationFileName(Filesystem $filesystem): string
    {
        $timestamp = date('Y_m_d_His');

        return Collection::make($this->app->databasePath().DIRECTORY_SEPARATOR.'migrations'.DIRECTORY_SEPARATOR)
            ->flatMap(function ($path) use ($filesystem) {
                return $filesystem->glob($path.'*_create_permission_tables.php');
            })->push($this->app->databasePath()."/migrations/{$timestamp}_create_permission_tables.php")
            ->first();
    }
}


1		<?php
2
3		namespace Spatie\Permission;
4
5		use Illuminate\Routing\Route;
6		use Illuminate\Support\Collection;
7		use Illuminate\Filesystem\Filesystem;
8		use Illuminate\Support\ServiceProvider;
9		use Illuminate\View\Compilers\BladeCompiler;
10		use Spatie\Permission\Contracts\Role as RoleContract;
11		use Spatie\Permission\Contracts\Permission as PermissionContract;
12
13		class PermissionServiceProvider extends ServiceProvider
14		{
15		public function boot(PermissionRegistrar $permissionLoader, Filesystem $filesystem)
16		{
17		if (function_exists('config_path')) { // function not available and 'publish' not relevant in Lumen
18		$this->publishes([
19		__DIR__.'/../config/permission.php' => config_path('permission.php'),
20		], 'config');
21
22		$this->publishes([
23		__DIR__.'/../database/migrations/create_permission_tables.php.stub' => $this->getMigrationFileName($filesystem),
24		], 'migrations');
25		}
26
27		$this->registerMacroHelpers();
28
29		$this->commands([
30		Commands\CacheReset::class,
31		Commands\CreateRole::class,
32		Commands\CreatePermission::class,
33		Commands\Show::class,
34		]);
35
36		$this->registerModelBindings();
37
38		$permissionLoader->clearClassPermissions();
39		$permissionLoader->registerPermissions();
40
41		$this->app->singleton(PermissionRegistrar::class, function ($app) use ($permissionLoader) {
		0 ignored issues – show Unused Code introduced 2018-11-08 11:43 UTC by Report Bug Copy Issue Report The parameter `$app` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
42		return $permissionLoader;
43		});
44		}
45
46		public function register()
47		{
48		$this->mergeConfigFrom(
49		__DIR__.'/../config/permission.php',
50		'permission'
51		);
52
53		$this->registerBladeExtensions();
54		}
55
56		protected function registerModelBindings()
57		{
58		$config = $this->app->config['permission.models'];
		0 ignored issues – show Bug introduced 2017-06-11 00:59 UTC by Report Bug Copy Issue Report Accessing `config` on the interface `Illuminate\Contracts\Foundation\Application` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
59
60		if (! $config) {
61		return;
62		}
63
64		$this->app->bind(PermissionContract::class, $config['permission']);
65		$this->app->bind(RoleContract::class, $config['role']);
66		}
67
68		protected function registerBladeExtensions()
69		{
70		$this->app->afterResolving('blade.compiler', function (BladeCompiler $bladeCompiler) {
71	View Code Duplication	$bladeCompiler->directive('role', function ($arguments) {
		0 ignored issues – show Duplication introduced 2017-04-10 14:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
72		list($role, $guard) = explode(',', $arguments.',');
73
74		return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
75		});
76	View Code Duplication	$bladeCompiler->directive('elserole', function ($arguments) {
		0 ignored issues – show Duplication introduced 2018-09-29 02:54 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
77		list($role, $guard) = explode(',', $arguments.',');
78
79		return "<?php elseif(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
80		});
81		$bladeCompiler->directive('endrole', function () {
82		return '<?php endif; ?>';
83		});
84
85	View Code Duplication	$bladeCompiler->directive('hasrole', function ($arguments) {
		0 ignored issues – show Duplication introduced 2017-04-10 14:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
86		list($role, $guard) = explode(',', $arguments.',');
87
88		return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasRole({$role})): ?>";
89		});
90		$bladeCompiler->directive('endhasrole', function () {
91		return '<?php endif; ?>';
92		});
93
94	View Code Duplication	$bladeCompiler->directive('hasanyrole', function ($arguments) {
		0 ignored issues – show Duplication introduced 2017-04-10 14:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95		list($roles, $guard) = explode(',', $arguments.',');
96
97		return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasAnyRole({$roles})): ?>";
98		});
99		$bladeCompiler->directive('endhasanyrole', function () {
100		return '<?php endif; ?>';
101		});
102
103	View Code Duplication	$bladeCompiler->directive('hasallroles', function ($arguments) {
		0 ignored issues – show Duplication introduced 2018-09-29 02:54 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104		list($roles, $guard) = explode(',', $arguments.',');
105
106		return "<?php if(auth({$guard})->check() && auth({$guard})->user()->hasAllRoles({$roles})): ?>";
107		});
108		$bladeCompiler->directive('endhasallroles', function () {
109		return '<?php endif; ?>';
110		});
111
112	View Code Duplication	$bladeCompiler->directive('unlessrole', function ($arguments) {
		0 ignored issues – show Duplication introduced 2017-04-10 14:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
113		list($role, $guard) = explode(',', $arguments.',');
114
115		return "<?php if(!auth({$guard})->check() \|\| ! auth({$guard})->user()->hasRole({$role})): ?>";
116		});
117		$bladeCompiler->directive('endunlessrole', function () {
118		return '<?php endif; ?>';
119		});
120		});
121		}
122
123		protected function registerMacroHelpers()
124		{
125		if (! method_exists(Route::class, 'macro')) { // Lumen
126		return;
127		}
128
129	View Code Duplication	Route::macro('role', function ($roles = []) {
		0 ignored issues – show Duplication introduced 2018-10-10 18:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
130		if (! is_array($roles)) {
131		$roles = [$roles];
132		}
133
134		$roles = implode('\|', $roles);
135
136		$this->middleware("role:$roles");
		0 ignored issues – show Bug introduced 2018-10-10 18:56 UTC by Report Bug Copy Issue Report The method `middleware()` does not seem to exist on `object<Spatie\Permission...missionServiceProvider>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
137
138		return $this;
139		});
140
141	View Code Duplication	Route::macro('permission', function ($permissions = []) {
		0 ignored issues – show Duplication introduced 2018-10-10 18:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
142		if (! is_array($permissions)) {
143		$permissions = [$permissions];
144		}
145
146		$permissions = implode('\|', $permissions);
147
148		$this->middleware("permission:$permissions");
		0 ignored issues – show Bug introduced 2018-10-10 18:56 UTC by Report Bug Copy Issue Report The method `middleware()` does not seem to exist on `object<Spatie\Permission...missionServiceProvider>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
149
150		return $this;
151		});
152		}
153
154		/**
155		* Returns existing migration file if found, else uses the current timestamp.
156		*
157		* @param Filesystem $filesystem
158		* @return string
159		*/
160		protected function getMigrationFileName(Filesystem $filesystem): string
161		{
162		$timestamp = date('Y_m_d_His');
163
164		return Collection::make($this->app->databasePath().DIRECTORY_SEPARATOR.'migrations'.DIRECTORY_SEPARATOR)
165		->flatMap(function ($path) use ($filesystem) {
166		return $filesystem->glob($path.'*_create_permission_tables.php');
167		})->push($this->app->databasePath()."/migrations/{$timestamp}_create_permission_tables.php")
168		->first();
169		}
170		}
171

spatie / laravel-permission

PermissionServiceProvider::boot() A last analyzed 2020-09-27 20:44 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

PermissionServiceProvider::boot() A
last analyzed 2020-09-27 20:44 UTC