PHP Class BookStack\Role

Inheritance: extends Illuminate\Database\Eloquent\Model

Protected Properties

Property	Type	Description
$fillable

Method	Description
attachPermission ( RolePermission $permission )	Add a permission to this role.
detachPermission ( RolePermission $permission )	Detach a single permission from this role.
getRole ( $roleName ) : Role	Get the role object for the specified role.
getSystemRole ( $roleName ) : Role	Get the role object for the specified system role.
hasPermission ( $permissionName ) : boolean	Check if this role has a permission.
jointPermissions ( ) : Illuminate\Database\Eloquent\Relations\HasMany	Get all related JointPermissions.
permissions ( )	The RolePermissions that belong to the role.
users ( )	The roles that belong to the role.
visible ( ) : mixed	Get all visible roles

Add a permission to this role.

public attachPermission ( RolePermission $permission )
$permission	RolePermission

Detach a single permission from this role.

public detachPermission ( RolePermission $permission )
$permission	RolePermission

Get the role object for the specified role.

public static getRole ( $roleName ) : Role
$roleName
return	Role

Get the role object for the specified system role.

public static getSystemRole ( $roleName ) : Role
$roleName
return	Role

Check if this role has a permission.

public hasPermission ( $permissionName ) : boolean
$permissionName
return	boolean

Get all related JointPermissions.

public jointPermissions ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return	Illuminate\Database\Eloquent\Relations\HasMany

The RolePermissions that belong to the role.

public permissions ( )

The roles that belong to the role.

public users ( )

Get all visible roles

public static visible ( ) : mixed
return	mixed

protected $fillable