2015-08-29 14:03:42 +00:00
|
|
|
<?php
|
|
|
|
|
2015-09-10 18:31:09 +00:00
|
|
|
namespace BookStack;
|
2015-08-29 14:03:42 +00:00
|
|
|
|
|
|
|
use Illuminate\Database\Eloquent\Model;
|
|
|
|
|
|
|
|
class Role extends Model
|
|
|
|
{
|
2015-09-05 16:42:05 +00:00
|
|
|
/**
|
2016-01-11 22:41:05 +00:00
|
|
|
* Sets the default role name for newly registered users.
|
2015-09-05 16:42:05 +00:00
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
protected static $default = 'viewer';
|
|
|
|
|
2015-08-29 14:03:42 +00:00
|
|
|
/**
|
|
|
|
* The roles that belong to the role.
|
|
|
|
*/
|
|
|
|
public function users()
|
|
|
|
{
|
2015-09-10 18:31:09 +00:00
|
|
|
return $this->belongsToMany('BookStack\User');
|
2015-08-29 14:03:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The permissions that belong to the role.
|
|
|
|
*/
|
|
|
|
public function permissions()
|
|
|
|
{
|
2015-09-10 18:31:09 +00:00
|
|
|
return $this->belongsToMany('BookStack\Permission');
|
2015-08-29 14:03:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a permission to this role.
|
|
|
|
* @param Permission $permission
|
|
|
|
*/
|
|
|
|
public function attachPermission(Permission $permission)
|
|
|
|
{
|
|
|
|
$this->permissions()->attach($permission->id);
|
|
|
|
}
|
|
|
|
|
2015-09-05 16:42:05 +00:00
|
|
|
/**
|
|
|
|
* Get an instance of the default role.
|
|
|
|
* @return Role
|
|
|
|
*/
|
|
|
|
public static function getDefault()
|
|
|
|
{
|
2016-01-02 14:48:35 +00:00
|
|
|
return static::getRole(static::$default);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the role object for the specified role.
|
|
|
|
* @param $roleName
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public static function getRole($roleName)
|
|
|
|
{
|
|
|
|
return static::where('name', '=', $roleName)->first();
|
2015-09-05 16:42:05 +00:00
|
|
|
}
|
2015-08-29 14:03:42 +00:00
|
|
|
}
|