<?php namespace BookStack\Auth;
use BookStack\Auth\Permissions\JointPermission;
+use BookStack\Auth\Permissions\RolePermission;
use BookStack\Model;
+/**
+ * Class Role
+ * @property string $display_name
+ * @property string $description
+ * @property string $external_auth_id
+ * @package BookStack\Auth
+ */
class Role extends Model
{
*/
public function users()
{
- return $this->belongsToMany(User::class);
+ return $this->belongsToMany(User::class)->orderBy('name', 'asc');
}
/**
*/
public function permissions()
{
- return $this->belongsToMany(Permissions\RolePermission::class, 'permission_role', 'role_id', 'permission_id');
+ return $this->belongsToMany(RolePermission::class, 'permission_role', 'role_id', 'permission_id');
}
/**
/**
* Add a permission to this role.
- * @param \BookStack\Auth\Permissions\RolePermission $permission
+ * @param RolePermission $permission
*/
- public function attachPermission(Permissions\RolePermission $permission)
+ public function attachPermission(RolePermission $permission)
{
$this->permissions()->attach($permission->id);
}
/**
* Detach a single permission from this role.
- * @param \BookStack\Auth\Permissions\RolePermission $permission
+ * @param RolePermission $permission
*/
- public function detachPermission(Permissions\RolePermission $permission)
+ public function detachPermission(RolePermission $permission)
{
- $this->permissions()->detach($permission->id);
+ $this->permissions()->detach([$permission->id]);
}
/**
*/
public static function getRole($roleName)
{
- return static::where('name', '=', $roleName)->first();
+ return static::query()->where('name', '=', $roleName)->first();
}
/**
*/
public static function getSystemRole($roleName)
{
- return static::where('system_name', '=', $roleName)->first();
+ return static::query()->where('system_name', '=', $roleName)->first();
}
/**
*/
public static function visible()
{
- return static::where('hidden', '=', false)->orderBy('name')->get();
+ return static::query()->where('hidden', '=', false)->orderBy('name')->get();
+ }
+
+ /**
+ * Get the roles that can be restricted.
+ * @return \Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection
+ */
+ public static function restrictable()
+ {
+ return static::query()->where('system_name', '!=', 'admin')->get();
}
}