<?php
/**
 * Created by PhpStorm.
 * User: egytelecoms.com
 * Date: 28.02.19
 * Time: 17:47
 */

namespace Modules\Platform\User\Entities;


use Torzer\Awesome\Landlord\BelongsToTenants;
use Spatie\Permission\Models\Role as SpatieRole;

/**
 * Modules\Platform\User\Entities\Role
 *
 * @property int $id
 * @property string $display_name
 * @property string $name
 * @property string $guard_name
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property int|null $company_id
 * @property-read \Illuminate\Database\Eloquent\Collection|\Spatie\Permission\Models\Permission[] $permissions
 * @property-read \Illuminate\Database\Eloquent\Collection|\Modules\Platform\User\Entities\User[] $users
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\Spatie\Permission\Models\Role permission($permissions)
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role query()
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role whereCompanyId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role whereDisplayName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role whereGuardName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Modules\Platform\User\Entities\Role whereUpdatedAt($value)
 * @mixin \Eloquent
 * @property-read int|null $permissions_count
 * @property-read int|null $users_count
 */
class Role extends SpatieRole
{

    const DEFAULT_COMPANY_ADMIN_ROLE = 'company_manager';

    const ADMIN_ROLE_NAME = 'admin';

    /**
     * Roles that a scoped "user.settings" user (without full settings access)
     * must not see or manage.
     *
     * @return array
     */
    public static function protectedRoleNames()
    {
        return [self::ADMIN_ROLE_NAME, self::DEFAULT_COMPANY_ADMIN_ROLE];
    }

    /**
     * Whether this role is protected from scoped settings users.
     *
     * @return bool
     */
    public function isProtected()
    {
        return in_array($this->name, self::protectedRoleNames(), true);
    }

    /**
     * Exclude protected roles from the query.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeExcludingProtected($query)
    {
        return $query->whereNotIn('name', self::protectedRoleNames());
    }

}