PHP Trait Artesaos\Defender\Traits\Permissions\InteractsWithPermissions

Mostra file Open project: artesaos/defender

Public Methods

Method Description
attachPermission ( array | Artesaos\Defender\Permission $permission, array $options = [] ) Attach the given permission.
detachPermission ( Artesaos\Defender\Permission $permission ) : integer Detach the given permission from the model.
existPermission ( string $permissionName ) : boolean Get the a permission using the permission name.
extendPermission ( string $permission, array $options ) : boolean | null Extend an existing temporary permission.
revokeExpiredPermissions ( ) : integer | null Revoke expired user permissions.
revokePermission ( Artesaos\Defender\Permission $permission ) : integer Alias to the detachPermission method.
revokePermissions ( ) : integer Revoke all user permissions.
syncPermissions ( array $permissions ) : array Sync the given permissions.

Method Details

attachPermission() public method

Attach the given permission.
public attachPermission ( array | Artesaos\Defender\Permission $permission, array $options = [] )
$permission array | Artesaos\Defender\Permission
$options array

detachPermission() public method

Detach the given permission from the model.
public detachPermission ( Artesaos\Defender\Permission $permission ) : integer
$permission Artesaos\Defender\Permission
return integer

existPermission() public method

Get the a permission using the permission name.
public existPermission ( string $permissionName ) : boolean
$permissionName string
return boolean

extendPermission() public method

Extend an existing temporary permission.
public extendPermission ( string $permission, array $options ) : boolean | null
$permission string
$options array
return boolean | null

revokeExpiredPermissions() public method

Revoke expired user permissions.
public revokeExpiredPermissions ( ) : integer | null
return integer | null

revokePermission() public method

Alias to the detachPermission method.
public revokePermission ( Artesaos\Defender\Permission $permission ) : integer
$permission Artesaos\Defender\Permission
return integer

revokePermissions() public method

Revoke all user permissions.
public revokePermissions ( ) : integer
return integer

syncPermissions() public method

Sync the given permissions.
public syncPermissions ( array $permissions ) : array
$permissions array
return array