Arcanedev\LaravelAuth\Models\Traits\Roleable

Complexity

Total Complexity

9

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getActiveRolesAttribute()	0	6	1
A	hasRole()	0	6	2
A	isAll()	0	6	1
A	isOne()	0	10	2
A	hasRoleSlug()	0	8	1
A	loadRoles()	0	4	2

<?php namespace Arcanedev\LaravelAuth\Models\Traits;

use Arcanesoft\Contracts\Auth\Models\Role;

/**
 * Trait     Roleable
 *
 * @package  Arcanedev\LaravelAuth\Traits
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @property  \Illuminate\Database\Eloquent\Collection  roles
 * @property  \Illuminate\Database\Eloquent\Collection  active_roles
 *
 * @method    \Illuminate\Database\Eloquent\Relations\BelongsToMany  roles()
 * @method    \Arcanedev\LaravelAuth\Models\Traits\Roleable          load(mixed $relations)
 */
trait Roleable
{
    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the active roles collection.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function getActiveRolesAttribute()
    {
        return $this->roles->filter(function (Role $role) {
            return $role->isActive();
        });
    }

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

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

        return $this->active_roles->contains('id', $id);
    }

    /**
     * Check if has all roles.
     *
     * @param  \Illuminate\Support\Collection|array  $roles
     * @param  \Illuminate\Support\Collection        &$failed
     *
     * @return bool
     */
    public function isAll($roles, &$failed = null)
    {
        $this->isOne($roles, $failed);

        return $failed->isEmpty();
    }

    /**
     * Check if has at least one role.
     *
     * @param  \Illuminate\Support\Collection|array  $roles
     * @param  \Illuminate\Support\Collection        &$failed
     *
     * @return bool
     */
    public function isOne($roles, &$failed = null)
    {
        $roles = is_array($roles) ? collect($roles) : $roles;

        $failed = $roles->reject(function ($role) {
            return $this->hasRoleSlug($role);
        })->values();

        return $roles->count() !== $failed->count();
    }

    /**
     * Check if has a role by its slug.
     *
     * @param  string  $slug
     *
     * @return bool
     */
    public function hasRoleSlug($slug)
    {
        $roles = $this->active_roles->filter(function (Role $role) use ($slug) {
            return $role->hasSlug($slug);
        });

        return ! $roles->isEmpty();
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */
    /**
     * Load all roles.
     *
     * @param  bool  $load
     *
     * @return self
     */
    protected function loadRoles($load = true)
    {
        return $load ? $this->load('roles') : $this;
    }
}