Arcanedev\LaravelAuth\Models\Traits\AuthUserTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getPermissionsAttribute()	0	11	2
A	may()	0	8	1
A	mayOne()	0	9	3
A	mayAll()	0	6	1

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

use Arcanedev\LaravelAuth\Models\Permission;
use Arcanedev\LaravelAuth\Models\Relationships\UserRelationships;
use Arcanedev\LaravelAuth\Models\Role;
use Arcanedev\LaravelAuth\Models\Traits\AuthRoleTrait;
use Illuminate\Database\Eloquent\Collection;

/**
 * Trait     AuthUserTrait
 *
 * @package  Arcanedev\LaravelAuth\Traits
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @property  \Illuminate\Database\Eloquent\Collection  permissions
 */
trait AuthUserTrait
{
    /* ------------------------------------------------------------------------------------------------
     |  Traits
     | ------------------------------------------------------------------------------------------------
     */
    use AuthRoleTrait, UserRelationships;

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get all user permissions.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function getPermissionsAttribute()
    {
        $permissions = new Collection;

        foreach ($this->roles as $role) {
            /** @var Role $role */
            $permissions = $permissions->merge($role->permissions);
        }

        return $permissions;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Permission Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check if the user has a permission.
     *
     * @param  string  $slug
     *
     * @return bool
     */
    public function may($slug)
    {
        $permissions = $this->permissions->filter(function(Permission $permission) use ($slug) {
            return $permission->slug === str_slug($slug, config('laravel-auth.slug-separator', '.'));
        });

        return ! $permissions->isEmpty();
    }

    /**
     * Check if the user has at least one permission.
     *
     * @param  array  $permissions
     * @param  array  $failedPermissions
     *
     * @return bool
     */
    public function mayOne(array $permissions, array &$failedPermissions = [])
    {
        foreach ($permissions as $permission) {
            if ( ! $this->may($permission))
                $failedPermissions[] = $permission;
        }

        return count($permissions) !== count($failedPermissions);
    }

    /**
     * Check if the user has all permissions.
     *
     * @param  array  $permissions
     * @param  array  $failedPermissions
     *
     * @return bool
     */
    public function mayAll(array $permissions, array &$failedPermissions = [])
    {
        $this->mayOne($permissions, $failedPermissions);

        return count($failedPermissions) === 0;
    }
}