PHP Trait Laratrust\Traits\LaratrustRoleTrait

Show file Open project: santigarcor/laratrust

Public Methods

Method Description
attachPermission ( object | array $permission ) : void Attach permission to current role.
attachPermissions ( mixed $permissions ) : void Attach multiple permissions to current role.
bootLaratrustRoleTrait ( ) : void | boolean Boot the role model Attach event listener to remove the many-to-many records when trying to delete Will NOT delete any records if the role model uses soft deletes.
cachedPermissions ( ) : Illuminate\Database\Eloquent\Collection Big block of caching functionality
detachPermission ( object | array $permission ) : void Detach permission from current role.
detachPermissions ( mixed $permissions ) : void Detach multiple permissions from current role
flushCache ( ) : void Flush the role's cache
hasPermission ( string | array $name, boolean $requireAll = false ) : boolean Checks if the role has a permission by its name.
permissions ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany Many-to-Many relations with the permission model.
savePermissions ( mixed $inputPermissions ) : array Save the inputted permissions.
users ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany Many-to-Many relations with the user model.

Method Details

attachPermission() public method

Attach permission to current role.
public attachPermission ( object | array $permission ) : void
$permission object | array
return void

attachPermissions() public method

Attach multiple permissions to current role.
public attachPermissions ( mixed $permissions ) : void
$permissions mixed
return void

bootLaratrustRoleTrait() public static method

Boot the role model Attach event listener to remove the many-to-many records when trying to delete Will NOT delete any records if the role model uses soft deletes.
public static bootLaratrustRoleTrait ( ) : void | boolean
return void | boolean

cachedPermissions() public method

Big block of caching functionality
public cachedPermissions ( ) : Illuminate\Database\Eloquent\Collection
return Illuminate\Database\Eloquent\Collection

detachPermission() public method

Detach permission from current role.
public detachPermission ( object | array $permission ) : void
$permission object | array
return void

detachPermissions() public method

Detach multiple permissions from current role
public detachPermissions ( mixed $permissions ) : void
$permissions mixed
return void

flushCache() public method

Flush the role's cache
public flushCache ( ) : void
return void

hasPermission() public method

Checks if the role has a permission by its name.
public hasPermission ( string | array $name, boolean $requireAll = false ) : boolean
$name string | array Permission name or array of permission names.
$requireAll boolean All permissions in the array are required.
return boolean

permissions() public method

Many-to-Many relations with the permission model.
public permissions ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
return Illuminate\Database\Eloquent\Relations\BelongsToMany

savePermissions() public method

Save the inputted permissions.
public savePermissions ( mixed $inputPermissions ) : array
$inputPermissions mixed
return array

users() public method

Many-to-Many relations with the user model.
public users ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
return Illuminate\Database\Eloquent\Relations\BelongsToMany