BookStack/app/Role.php

59 lines
1.2 KiB
PHP
Raw Normal View History

2015-08-29 10:03:42 -04:00
<?php
namespace BookStack;
2015-08-29 10:03:42 -04:00
use Illuminate\Database\Eloquent\Model;
class Role extends Model
{
2015-09-05 12:42:05 -04:00
/**
* Sets the default role name for newly registed users.
* @var string
*/
protected static $default = 'viewer';
2015-08-29 10:03:42 -04:00
/**
* The roles that belong to the role.
*/
public function users()
{
return $this->belongsToMany('BookStack\User');
2015-08-29 10:03:42 -04:00
}
/**
* The permissions that belong to the role.
*/
public function permissions()
{
return $this->belongsToMany('BookStack\Permission');
2015-08-29 10:03:42 -04:00
}
/**
* Add a permission to this role.
* @param Permission $permission
*/
public function attachPermission(Permission $permission)
{
$this->permissions()->attach($permission->id);
}
2015-09-05 12:42:05 -04:00
/**
* Get an instance of the default role.
* @return Role
*/
public static function getDefault()
{
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 12:42:05 -04:00
}
2015-08-29 10:03:42 -04:00
}