Arcanedev\LaravelAuth\Models\PermissionsGroup

Complexity

Total Complexity

23

Size/Duplication

Total Lines	316
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	16

Test Coverage

Coverage

100%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	permissions()	0	7	1
A	setNameAttribute()	0	5	1
A	setSlugAttribute()	0	4	1
A	createPermission()	0	6	1
A	attachPermission()	0	10	2
A	attachPermissionById()	0	9	2
A	attachPermissions()	0	10	1
A	detachPermission()	0	14	2
A	detachPermissionById()	0	7	2
A	detachPermissions()	0	10	1
A	detachAllPermissions()	0	10	1
A	hasPermission()	0	6	2
A	getPermissionFromGroup()	0	12	2
A	getPermissionById()	0	4	1
A	loadPermissions()	0	4	2

<?php namespace Arcanedev\LaravelAuth\Models;

use Arcanedev\LaravelAuth\Events\PermissionsGroups\AttachedPermissionsToGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\AttachedPermissionToGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\AttachingPermissionsToGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\AttachingPermissionToGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\CreatedPermissionsGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\CreatingPermissionsGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\DeletedPermissionsGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\DeletingPermissionsGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\DetachedAllPermissions;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\DetachedPermissionFromGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\DetachedPermissionsFromGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\DetachingAllPermissions;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\DetachingPermissionFromGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\DetachingPermissionsFromGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\SavedPermissionsGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\SavingPermissionsGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\UpdatedPermissionsGroup;
use Arcanedev\LaravelAuth\Events\PermissionsGroups\UpdatingPermissionsGroup;
use Arcanesoft\Contracts\Auth\Models\Permission as PermissionContract;
use Arcanesoft\Contracts\Auth\Models\PermissionsGroup as PermissionsGroupContract;
use Illuminate\Database\Eloquent\Model as Eloquent;
use Illuminate\Support\Str;

/**
 * Class     PermissionsGroup
 *
 * @package  Arcanedev\LaravelAuth\Models
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @property  int                                       id
 * @property  string                                    name
 * @property  string                                    slug
 * @property  string                                    description
 * @property  \Carbon\Carbon                            created_at
 * @property  \Carbon\Carbon                            updated_at
 * @property  \Illuminate\Database\Eloquent\Collection  permissions
 */
class PermissionsGroup extends AbstractModel implements PermissionsGroupContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['name', 'slug', 'description'];

    /**
     * The event map for the model.
     *
     * @var array
     */
    protected $dispatchesEvents = [
        'creating' => CreatingPermissionsGroup::class,
        'created'  => CreatedPermissionsGroup::class,
        'updating' => UpdatingPermissionsGroup::class,
        'updated'  => UpdatedPermissionsGroup::class,
        'saving'   => SavingPermissionsGroup::class,
        'saved'    => SavedPermissionsGroup::class,
        'deleting' => DeletingPermissionsGroup::class,
        'deleted'  => DeletedPermissionsGroup::class,
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'id' => 'integer',
    ];

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Create a new Eloquent model instance.
     *
     * @param  array  $attributes
     */
    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->setTable(
            config('laravel-auth.permissions-groups.table', 'permissions_groups')
        );
    }

    /* -----------------------------------------------------------------
     |  Relationships
     | -----------------------------------------------------------------
     */

    /**
     * Permissions Groups has many permissions.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function permissions()
    {
        return $this->hasMany(
            config('laravel-auth.permissions.model', Permission::class),
            'group_id'
        );
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the name attribute.
     *
     * @param  string  $name
     */
    public function setNameAttribute($name)
    {
        $this->attributes['name'] = $name;
        $this->setSlugAttribute($name);
    }

    /**
     * Set the slug attribute.
     *
     * @param  string  $slug
     */
    public function setSlugAttribute($slug)
    {
        $this->attributes['slug'] = Str::slug($slug, config('laravel-auth.permissions-groups.slug-separator', '-'));
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create and attach a permission.
     *
     * @param  array  $attributes
     * @param  bool   $reload
     */
    public function createPermission(array $attributes, $reload = true)
    {
        $this->permissions()->create($attributes);

        $this->loadPermissions($reload);
    }

    /**
     * Attach the permission to a group.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission  $permission
     * @param  bool                                          $reload
     */
    public function attachPermission(&$permission, $reload = true)
    {
        if ($this->hasPermission($permission)) return;

        event(new AttachingPermissionToGroup($this, $permission));
        $permission = $this->permissions()->save($permission);

$permission of type object<Arcanesoft\Contracts\Auth\Models\Permission> is not a sub-type of object<Illuminate\Database\Eloquent\Model>. It seems like you assume a concrete implementation of the interface Arcanesoft\Contracts\Auth\Models\Permission to be always present.

        event(new AttachedPermissionToGroup($this, $permission));

It seems like $permission defined by $this->permissions()->save($permission) on line 171 can also be of type false; however, Arcanedev\LaravelAuth\Events\PermissionsGroups\AttachedPermissionToGroup::__construct() does only seem to accept object<Arcanesoft\Contracts\Auth\Models\Permission>, did you maybe forget to handle an error condition?

        $this->loadPermissions($reload);
    }

    /**
     * Attach the permission by id to a group.
     *
     * @param  int   $id
     * @param  bool  $reload
     *
     * @return \Arcanesoft\Contracts\Auth\Models\Permission|null
     */
    public function attachPermissionById($id, $reload = true)
    {
        $permission = $this->getPermissionById($id);

        if ($permission !== null)
            $this->attachPermission($permission, $reload);

        return $permission;
    }

    /**
     * Attach a collection of permissions to the group.
     *
     * @param  \Illuminate\Database\Eloquent\Collection|array  $permissions
     * @param  bool                                            $reload
     *
     * @return \Illuminate\Database\Eloquent\Collection|array
     */
    public function attachPermissions($permissions, $reload = true)
    {
        event(new AttachingPermissionsToGroup($this, $permissions));
        $permissions = $this->permissions()->saveMany($permissions);
        event(new AttachedPermissionsToGroup($this, $permissions));

It seems like $permissions defined by $this->permissions()->saveMany($permissions) on line 206 can also be of type object<Traversable>; however, Arcanedev\LaravelAuth\Events\PermissionsGroups\AttachedPermissionsToGroup::__construct() does only seem to accept object<Illuminate\Support\Collection>|array, maybe add an additional type check?

        $this->loadPermissions($reload);

        return $permissions;
    }

    /**
     * Attach the permission from a group.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission  $permission
     * @param  bool                                          $reload
     */
    public function detachPermission(&$permission, $reload = true)
    {
        if ( ! $this->hasPermission($permission))
            return;

        /** @var  \Arcanesoft\Contracts\Auth\Models\Permission  $permission */
        $permission = $this->getPermissionFromGroup($permission);

        event(new DetachingPermissionFromGroup($this, $permission));
        $permission->update(['group_id' => 0]);
        event(new DetachedPermissionFromGroup($this, $permission));

        $this->loadPermissions($reload);
    }

    /**
     * Attach the permission by id to a group.
     *
     * @param  int   $id
     * @param  bool  $reload
     *
     * @return \Arcanesoft\Contracts\Auth\Models\Permission
     */
    public function detachPermissionById($id, $reload = true)
    {
        if ( ! is_null($permission = $this->getPermissionById($id)))
            $this->detachPermission($permission, $reload);

        return $permission;
    }

    /**
     * Detach multiple permissions by ids.
     *
     * @param  array  $ids
     * @param  bool   $reload
     *
     * @return int
     */
    public function detachPermissions(array $ids, $reload = true)
    {
        event(new DetachingPermissionsFromGroup($this, $ids));
        $detached = $this->permissions()->whereIn('id', $ids)->update(['group_id' => 0]);
        event(new DetachedPermissionsFromGroup($this, $ids, $detached));

        $this->loadPermissions($reload);

        return $detached;
    }

    /**
     * Detach all permissions from the group.
     *
     * @param  bool  $reload
     *
     * @return int
     */
    public function detachAllPermissions($reload = true)
    {
        event(new DetachingAllPermissions($this));
        $detached = $this->permissions()->update(['group_id' => 0]);
        event(new DetachedAllPermissions($this, $detached));

        $this->loadPermissions($reload);

        return $detached;
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if role has the given permission (Permission Model or Id).
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission|int  $id
     *
     * @return bool
     */
    public function hasPermission($id)
    {
        if ($id instanceof Eloquent) $id = $id->getKey();

        return $this->getPermissionFromGroup($id) !== null;
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get a permission from the group.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission|int  $id
     *
     * @return \Arcanesoft\Contracts\Auth\Models\Permission|null
     */
    private function getPermissionFromGroup($id)
    {
        if ($id instanceof Eloquent) $id = $id->getKey();

        $this->loadPermissions();

        return $this->permissions
            ->filter(function (PermissionContract $permission) use ($id) {
                return $permission->getKey() == $id;
            })
            ->first();
    }

    /**
     * Get a permission by id.
     *
     * @param  int  $id
     *
     * @return \Arcanesoft\Contracts\Auth\Models\Permission|null
     */
    private function getPermissionById($id)
    {
        return $this->permissions()->getRelated()->where('id', $id)->first();
    }

    /**
     * Load the permissions.
     *
     * @param  bool  $load
     *
     * @return self
     */
    protected function loadPermissions($load = true)
    {
        return $load ? $this->load('permissions') : $this;
    }
}