Spatie\Permission\Traits\HasPermissions

Complexity

Total Complexity

11

Size/Duplication

Total Lines	116
Duplicated Lines	15.52 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	2
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	revokePermissionTo()	0	8	1
A	getStoredPermission()	0	12	3
A	givePermissionTo()	18	18	1
A	syncPermissions()	0	6	1
A	ensureGuardIsEqual()	0	6	2
A	isAssignedToGuard()	0	4	1
A	getGuardName()	0	4	1
A	getAllAuthGuardProviderModels()	0	7	1

<?php

namespace Spatie\Permission\Traits;

use Spatie\Permission\Contracts\Permission;
use Spatie\Permission\Exceptions\GuardMismatch;

trait HasPermissions
{
    /**
     * Grant the given permission(s) to a role.
     *
     * @param string|array|\Spatie\Permission\Contracts\Permission|\Illuminate\Support\Collection $permissions
     *
     * @return $this
     */
    public function givePermissionTo(...$permissions)

This method seems to be duplicated in your project.

    {
        $permissions = collect($permissions)
            ->flatten()
            ->map(function ($permission) {
                return $this->getStoredPermission($permission);
            })
            ->each(function ($permission) {
                $this->ensureGuardIsEqual($permission);
            })
            ->all();

        $this->permissions()->saveMany($permissions);

The method permissions() does not exist on Spatie\Permission\Traits\HasPermissions. Did you maybe mean syncPermissions()?

        $this->forgetCachedPermissions();

It seems like forgetCachedPermissions() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    /**
     * Remove all current permissions and set the given ones.
     *
     * @param string|array|\Spatie\Permission\Contracts\Permission|\Illuminate\Support\Collection $permissions
     *
     * @return $this
     */
    public function syncPermissions(...$permissions)
    {
        $this->permissions()->detach();

The method permissions() does not exist on Spatie\Permission\Traits\HasPermissions. Did you maybe mean syncPermissions()?

        return $this->givePermissionTo($permissions);
    }

    /**
     * Revoke the given permission.
     *
     * @param \Spatie\Permission\Contracts\Permission|string $permission
     *
     * @return $this
     */
    public function revokePermissionTo($permission)
    {
        $this->permissions()->detach($this->getStoredPermission($permission));

The method permissions() does not exist on Spatie\Permission\Traits\HasPermissions. Did you maybe mean syncPermissions()?

        $this->forgetCachedPermissions();

It seems like forgetCachedPermissions() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    /**
     * @param string|array|\Spatie\Permission\Contracts\Permission|\Illuminate\Support\Collection $permissions
     *
     * @return \Spatie\Permission\Contracts\Permission
     */
    protected function getStoredPermission($permissions): Permission
    {
        if (is_string($permissions)) {
            return app(Permission::class)->findByName($permissions, $this->getGuardName());
        }

        if (is_array($permissions)) {
            return app(Permission::class)->whereIn('name', $permissions)->where('guard_name', $this->getGuardName())->get();
        }

        return $permissions;
    }

    /**
     * @param \Spatie\Permission\Contracts\Permission|\Spatie\Permission\Contracts\Role $roleOrPermission
     *
     * @throws \Spatie\Permission\Exceptions\GuardMismatch
     */
    protected function ensureGuardIsEqual($roleOrPermission)
    {
        if ($roleOrPermission->guard_name !== $this->getGuardName()) {
            throw new GuardMismatch();
        }
    }

    /**
     * Check if the class is assigned to a guard in `config/auth.php`.
     */
    protected function isAssignedToGuard(): bool
    {
        return (bool) $this->getGuardName();
    }

    /**
     * Get the name of the guard that this class is assigned to based on it's `guard_name` property or the auth config
     * file.
     */
    protected function getGuardName(): string
    {
        return $this->guard_name ?? array_search(get_class($this), $this->getAllAuthGuardProviderModels());

The property guard_name does not exist. Did you maybe forget to declare it?

    }

    /**
     * Get an array of all models assigned to guards with the guard names as the keys.
     */
    protected function getAllAuthGuardProviderModels(): array
    {
        return collect(config('auth.guards'))
            ->map(function ($guard) {
                return config("auth.providers.{$guard['provider']}.model");
            })->toArray();
    }
}