Spatie\Permission\Traits\HasPermissions

Complexity

Total Complexity

10

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	revokePermissionTo()	0	8	1
A	getStoredPermission()	0	12	3
A	usingMultipleArguments()	0	4	1
A	givePermissionTo()	0	16	3
A	savePermissions()	0	10	2

<?php

namespace Spatie\Permission\Traits;

use Spatie\Permission\Contracts\Permission;
use Spatie\Permission\Exceptions\PermissionMustNotBeEmpty;

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

The return type HasPermissions is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    public function givePermissionTo(...$permissions)
    {
        if(count($permissions) < 1) {
            throw new PermissionMustNotBeEmpty();
        }

        if (!$this->usingMultipleArguments($permissions)) {
            $permissions = current($permissions);
        }

        $this->savePermissions($permissions);

        $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;
    }
    
    /**
     * Save the given permissions to a role.
     *
     * @param array|Permission|\Illuminate\Support\Collection $permissions
     * 
     * @return array|\Illuminate\Database\Eloquent\Model
     */
    protected function savePermissions($permissions)
    {
        $permissions = $this->getStoredPermission($permissions);

        if($permissions instanceof \Illuminate\Database\Eloquent\Collection) {
            return $this->permissions()->saveMany($permissions);

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

        }

        return $this->permissions()->save($permissions);

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

    }

    /**
     * Revoke the given permission.
     *
     * @param $permission
     *
     * @return HasPermissions

The return type HasPermissions is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    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 savePermissions()?

        $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|Permission|\Illuminate\Support\Collection $permissions
     *
     * @return Permission
     */
    protected function getStoredPermission($permissions)
    {
        if (is_string($permissions)) {
            return app(Permission::class)->findByName($permissions);
        }

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

        return $permissions;
    }

    /**
     * @param $params
     * @return bool
     */
    private function usingMultipleArguments($params)
    {
        return count($params) > 1;
    }

}