class PermissionManager

Traits

Singleton trait.

Properties

static protected $instance from  Singleton
protected $permissions
protected array $permissionCache
protected array $callbacks
static protected $permissionDefaults

Methods

static 
instance()

Create a new instance of this singleton.

static 
forgetInstance()

Forget this singleton's instance if it exists

__construct()

Constructor.

initialize()

Initialize the singleton free from constructor parameters.

__clone()

No description

__wakeup()

No description

array
listPermissions()

Returns a list of the registered permissions.

listGroupedPermissions()

No description

checkPermission($permissions, $checkPermissions, $checkAll)

No description

checkPermissionStartsWith($permission, $permissions)

No description

checkPermissionEndsWith($permission, $permissions)

No description

checkPermissionMatches($permission, $permissions)

No description

registerPermissions($owner, array $definitions)

No description

registerCallback(callable $callback)

Registers a callback function that defines permissions.

Details

in Singleton at line 18
final static instance()

Create a new instance of this singleton.

in Singleton at line 28
final static forgetInstance()

Forget this singleton's instance if it exists

in Singleton at line 36
final protected __construct()

Constructor.

in Singleton at line 44
protected initialize()

Initialize the singleton free from constructor parameters.

in Singleton at line 48
__clone()

No description

in Singleton at line 53
__wakeup()

No description

at line 35
array listPermissions()

Returns a list of the registered permissions.

Return Value

array

at line 64
listGroupedPermissions()

No description

at line 83
checkPermission($permissions, $checkPermissions, $checkAll)

No description

Parameters

$permissions
$checkPermissions
$checkAll

at line 102
protected checkPermissionStartsWith($permission, $permissions)

No description

Parameters

$permission
$permissions

at line 117
protected checkPermissionEndsWith($permission, $permissions)

No description

Parameters

$permission
$permissions

at line 132
protected checkPermissionMatches($permission, $permissions)

No description

Parameters

$permission
$permissions

at line 155
registerPermissions($owner, array $definitions)

No description

Parameters

$owner
array $definitions

at line 189
registerCallback(callable $callback)

Registers a callback function that defines permissions.

The callback function should register permissions by calling the manager's registerPermissions() function. This instance is passed to the callback function as an argument. Usage:

  AdminAuth::registerCallback(function($manager){
      $manager->registerPermissions([...]);
  });

Parameters

callable $callback

A callable function.