Longman\Platfourm\User\Models\Eloquent\UserTrait

Complexity

Total Complexity

51

Size/Duplication

Total Lines	240
Duplicated Lines	38.33 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	cachedRole()	0	7	1
A	bootEntrustUserTrait()	17	17	2
A	role()	0	4	1
C	hasRole()	23	23	7
D	can()	28	28	9
D	ability()	0	59	20
A	attachRole()	12	12	3
A	detachRole()	12	12	3
A	attachRoles()	0	6	2
A	detachRoles()	0	10	3

<?php
/*
 * This file is part of the Laravel Platfourm package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Longman\Platfourm\User\Models\Eloquent;

use Cache;
use Config;
use InvalidArgumentException;

trait UserTrait
{

    //in EntrustUserTrait.php
    public function cachedRole()
    {
        $cacheKey = 'entrust_role_for_user_' . $this->getKey();

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

        return Cache::remember($cacheKey, Config::get('cache.ttl'), function () {
            return $this->role;

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

        });
    }

    public static function bootEntrustUserTrait()

This method seems to be duplicated in your project.

    {
        static::saved(function ($item) {
            //Cache::tags(Config::get('entrust.role_user_table'))->flush();

69% of this comment could be valid code. Did you maybe forget this after debugging?

            Cache::forget('entrust_role_for_user_' . $item->getKey());
        });
        static::deleted(function ($item) {
            //Cache::tags(Config::get('entrust.role_user_table'))->flush();

69% of this comment could be valid code. Did you maybe forget this after debugging?

            Cache::forget('entrust_role_for_user_' . $item->getKey());
        });
        if (method_exists(static::class, 'restored')) {
            static::restored(function ($item) {
                //Cache::tags(Config::get('entrust.role_user_table'))->flush();

69% of this comment could be valid code. Did you maybe forget this after debugging?

                Cache::forget('entrust_role_for_user_' . $item->getKey());
            });
        }
    }

    /**
     * Many-to-Many relations with Role.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function role()
    {
        return $this->belongsTo(Config::get('entrust.role'));

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

    }

    /**
     * Checks if the user has a role by its name.
     *
     * @param  string|array $name       Role name or array of role names.
     * @param  bool         $requireAll All roles in the array are required.
     * @return bool
     */
    public function hasRole($name, $requireAll = false)

This method seems to be duplicated in your project.

    {
        if (is_array($name)) {
            foreach ($name as $roleName) {
                $hasRole = $this->hasRole($roleName);

                if ($hasRole && !$requireAll) {
                    return true;
                } elseif (!$hasRole && $requireAll) {
                    return false;
                }
            }

            // If we've made it this far and $requireAll is FALSE, then NONE of the roles were found
            // If we've made it this far and $requireAll is TRUE, then ALL of the roles were found.
            // Return the value of $requireAll;
            return $requireAll;
        } else {
            return $this->role->name == $name;
        }

        return false;

return false; does not seem to be reachable.

    }

    /**
     * Check if user has a permission by its name.
     *
     * @param  string|array $permission Permission string or array of permissions.
     * @param  bool         $requireAll All permissions in the array are required.
     * @return bool
     */
    public function can($permission, $requireAll = false)

This method seems to be duplicated in your project.

    {
        if (is_array($permission)) {
            foreach ($permission as $permName) {
                $hasPerm = $this->can($permName);

                if ($hasPerm && !$requireAll) {
                    return true;
                } elseif (!$hasPerm && $requireAll) {
                    return false;
                }
            }

            // If we've made it this far and $requireAll is FALSE, then NONE of the perms were found
            // If we've made it this far and $requireAll is TRUE, then ALL of the perms were found.
            // Return the value of $requireAll;
            return $requireAll;
        } else {
            // Validate against the Permission table
            foreach ($this->role->cachedPermissions() as $perm) {
                if (str_is($permission, $perm->name)) {
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * Checks role(s) and permission(s).
     *
     * @param  string|array                $roles       Array of roles or comma separated string
     * @param  string|array                $permissions Array of permissions or comma separated string.
     * @param  array                       $options     validate_all (true|false) or return_type (boolean|array|both)
     * @throws \InvalidArgumentException
     * @return array|bool
     */
    public function ability($roles, $permissions, $options = [])
    {
        // Convert string to array if that's what is passed in.
        if (!is_array($roles)) {
            $roles = explode(',', $roles);
        }
        if (!is_array($permissions)) {
            $permissions = explode(',', $permissions);
        }

        // Set up default values and validate options.
        if (!isset($options['validate_all'])) {
            $options['validate_all'] = false;
        } else {
            if ($options['validate_all'] !== true && $options['validate_all'] !== false) {
                throw new InvalidArgumentException();
            }
        }
        if (!isset($options['return_type'])) {
            $options['return_type'] = 'boolean';
        } else {
            if ($options['return_type'] != 'boolean'
                && $options['return_type'] != 'array'
                && $options['return_type'] != 'both'
            ) {
                throw new InvalidArgumentException();
            }
        }

        // Loop through roles and permissions and check each.
        $checkedRoles       = [];
        $checkedPermissions = [];
        foreach ($roles as $role) {
            $checkedRoles[$role] = $this->hasRole($role);
        }
        foreach ($permissions as $permission) {
            $checkedPermissions[$permission] = $this->can($permission);
        }

        // If validate all and there is a false in either
        // Check that if validate all, then there should not be any false.
        // Check that if not validate all, there must be at least one true.
        if (($options['validate_all'] && !(in_array(false, $checkedRoles) || in_array(false, $checkedPermissions)))
            || (!$options['validate_all'] && (in_array(true, $checkedRoles) || in_array(true, $checkedPermissions)))
        ) {
            $validateAll = true;
        } else {
            $validateAll = false;
        }

        // Return based on option
        if ($options['return_type'] == 'boolean') {
            return $validateAll;
        } elseif ($options['return_type'] == 'array') {
            return ['roles' => $checkedRoles, 'permissions' => $checkedPermissions];
        } else {
            return [$validateAll, ['roles' => $checkedRoles, 'permissions' => $checkedPermissions]];
        }
    }

    /**
     * Alias to eloquent many-to-many relation's attach() method.
     *
     * @param mixed $role
     */
    public function attachRole($role)

This method seems to be duplicated in your project.

    {
        if (is_object($role)) {
            $role = $role->getKey();
        }

        if (is_array($role)) {
            $role = $role['id'];
        }

        $this->role->attach($role);
    }

    /**
     * Alias to eloquent many-to-many relation's detach() method.
     *
     * @param mixed $role
     */
    public function detachRole($role)

This method seems to be duplicated in your project.

    {
        if (is_object($role)) {
            $role = $role->getKey();
        }

        if (is_array($role)) {
            $role = $role['id'];
        }

        $this->role->detach($role);
    }

    /**
     * Attach multiple roles to a user
     *
     * @param mixed $roles
     */
    public function attachRoles($roles)
    {
        foreach ($roles as $role) {
            $this->attachRole($role);
        }
    }

    /**
     * Detach multiple roles from a user
     *
     * @param mixed $roles
     */
    public function detachRoles($roles = null)
    {
        if (!$roles) {
            $roles = $this->role;
        }

        foreach ($roles as $role) {
            $this->detachRole($role);
        }
    }
}