Arcanesoft\Auth\Models\Role

Complexity

Total Complexity

6

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	users()	0	4	1
A	scopeAdmin()	0	4	1
A	scopeModerator()	0	4	1
A	scopeMember()	0	4	1
A	firstHashedOrFail()	0	4	1
A	makeSlugName()	0	4	1

<?php namespace Arcanesoft\Auth\Models;

use Arcanedev\LaravelAuth\Models\Role as BaseRole;
use Illuminate\Database\Eloquent\Builder;

/**
 * Class     Role
 *
 * @package  Arcanesoft\Auth\Models
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @property  int|null  users_count
 * @property  int|null  $permissions_count
 *
 * @method static \Illuminate\Database\Eloquent\Builder  admin()
 * @method static \Illuminate\Database\Eloquent\Builder  moderator()
 * @method static \Illuminate\Database\Eloquent\Builder  member()
 *
 * @mixin  \Illuminate\Database\Eloquent\Builder
 */
class Role extends BaseRole
{
    /* -----------------------------------------------------------------
     |  Constants
     | -----------------------------------------------------------------
     */

    const ADMINISTRATOR = 'administrator';
    const MODERATOR     = 'moderator';
    const MEMBER        = 'member';

    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use Presenters\RolePresenter;

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

    /**
     * Role belongs to many users.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function users()
    {
        return parent::users()->protectAdmins();
    }

    /* -----------------------------------------------------------------
     |  Scopes
     | -----------------------------------------------------------------
     */

    /**
     * Scope only with administrator role.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeAdmin(Builder $query)
    {
        return $query->where('slug', Role::ADMINISTRATOR);
    }

    /**
     * Scope only with moderator role.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeModerator(Builder $query)
    {
        return $query->where('slug', Role::MODERATOR);
    }

    /**
     * Scope only with member role.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeMember(Builder $query)
    {
        return $query->where('slug', Role::MEMBER);
    }

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

    /**
     * Get a role from a hashed id or fail if not found.
     *
     * @param  string  $hashedId
     *
     * @return self
     *
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     */
    public static function firstHashedOrFail($hashedId)
    {
        return self::withHashedId($hashedId)->firstOrFail();
    }

    /**
     * Make the slug.
     *
     * @param  string  $value
     *
     * @return string
     */
    public function makeSlugName($value)
    {
        return $this->slugify($value);
    }
}