PHP Trait Zizaco\Entrust\Traits\EntrustRoleTrait

Public Methods

Method	Description
attachPermission ( object \| array $permission ) : void	Attach permission to current role.
attachPermissions ( mixed $permissions ) : void	Attach multiple permissions to current role.
boot ( ) : 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 ( )	Big block of caching functionality.
delete ( array $options = [] )
detachPermission ( object \| array $permission ) : void	Detach permission from current role.
detachPermissions ( mixed $permissions = null ) : void	Detach multiple permissions from current role
hasPermission ( string \| array $name, boolean $requireAll = false ) : boolean	Checks if the role has a permission by its name.
perms ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany	Many-to-Many relations with the permission model.
restore ( )
save ( array $options = [] )
savePermissions ( mixed $inputPermissions ) : void	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

boot() 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 boot ( ) : void \| boolean
return	void \| boolean

cachedPermissions() public method

Big block of caching functionality.

public cachedPermissions ( )

delete() public method

public delete ( array $options = [] )
$options	array

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 = null ) : void
$permissions	mixed
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

perms() public method

Named "perms" for backwards compatibility. Also because "perms" is short and sweet.

public perms ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
return	Illuminate\Database\Eloquent\Relations\BelongsToMany

restore() public method

public restore ( )

save() public method

public save ( array $options = [] )
$options	array

savePermissions() public method

Save the inputted permissions.

public savePermissions ( mixed $inputPermissions ) : void
$inputPermissions	mixed
return	void

users() public method

Many-to-Many relations with the user model.

public users ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
return	Illuminate\Database\Eloquent\Relations\BelongsToMany