thinkstudeo / laravel-rakshak

src/Traits/HasRoles.php

<?php

namespace Thinkstudeo\Rakshak\Traits;

use Thinkstudeo\Rakshak\Ability;
use Thinkstudeo\Rakshak\Role;

trait HasRoles
{
    /**
     * Get all the roles assigned to the user.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function roles()
    {
        return $this->belongsToMany(Role::class);

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

    }

    /**
     * Assign a Role to the current User.
     *
     * @param $role
     * @return $this
     */
    public function assignRole($role)
    {
        $model = $role instanceof \Thinkstudeo\Rakshak\Role ? $role : Role::whereName($role)->firstOrFail();

        $this->roles()->save($model);

        return $this;
    }

    /**
     * Retract a Role to the current User.
     *
     * @param $role
     * @return $this
     */
    public function retractRole($role)
    {
        $model = $role instanceof \Thinkstudeo\Rakshak\Role ? $role : Role::whereName($role)->firstOrFail();

        $this->roles()->detach($model->id);

        return $this;
    }

    /**
     * Determine if the user has the given role.
     *
     * @param $role
     * @return bool
     */
    public function hasRole($role)
    {
        return is_string($role)
            ? (bool) $this->roles->contains('name', $role)
            : (bool) $this->roles->intersect([$role])->count();
    }

    /**
     * Determine if the user has any of the given roles.
     *
     * @param array $roles
     * @return bool
     */
    public function hasAnyRole(array $roles)
    {
        return is_string($roles[0])
            ? (bool) $this->roles->intersect(Role::whereIn('name', $roles)->get())->count()
            : (bool) $this->roles->intersect($roles)->count();
    }

    /**
     * Determine if the user has any of the given abilities.
     *
     * @param $task
     * @return bool
     */
    public function hasAbility($task)
    {
        $ability = is_string($task) ? Ability::whereName($task)->first() : $task;

        return $ability ? (bool) $ability->roles->intersect($this->roles)->count() : false;
    }

    /**
     * Determine if the user has any of the given abilities.
     *
     * @param array $abilities
     * @return bool
     */
    public function hasAnyAbility(array $tasks)
    {
        $count = 0;
        foreach ($tasks as $task) {
            $ability = is_string($task) ? Ability::whereName($task)->first() : $task;

            $count += $ability ? $ability->roles->intersect($this->roles)->count() : 0;
        }

        return (bool) $count;
    }

    /**
     * Determine if the user is the super user.
     *
     * @return bool
     */
    public function isSuperUser()
    {
        return (bool) $this->hasRole('super');
    }
}