Property | Type | Description | |
---|---|---|---|
$noArgumentsDefaultAction | integer | Default action for no arguments is allow | |
$redis | |||
$setNXAccess | boolean |
Method | Description | |
---|---|---|
__construct ( $redis = null ) | ||
addInherit ( string $roleName, Phalcon\Acl\Role | string $roleToInherit ) | ||
addResource ( Phalcon\Acl\Resource | string $resource, array | string $accessList = null ) : boolean |
{@inheritdoc}
Example:
Add a resource to the the list allowing access to an action
$acl->addResource(new Phalcon\Acl\Resource('customers'), 'search');
$acl->addResource('customers', 'search');
Add a resource with an access list
$acl->addResource(new Phalcon\Acl\Resource('customers'), ['create', 'search']);
$acl->addResource('customers', ['create', 'search']);
|
|
addResourceAccess ( string $resourceName, array | string $accessList ) : boolean | ||
addRole ( Phalcon\Acl\Role | string $role, string $accessInherits = null ) : boolean | ||
allow ( string $role, string $resource, array | string $access, mixed $func = null ) |
{@inheritdoc}
You can use '*' as wildcard
Example:
Allow access to guests to search on customers
$acl->allow('guests', 'customers', 'search');
Allow access to guests to search or create on customers
$acl->allow('guests', 'customers', ['search', 'create']);
Allow access to any role to browse on products
$acl->allow('*', 'products', 'browse');
Allow access to any role to browse on any resource
$acl->allow('*', '*', 'browse');
|
|
deny ( $role, $resource, array | string $access, mixed $func = null ) |
{@inheritdoc}
You can use '*' as wildcard
Example:
Deny access to guests to search on customers
$acl->deny('guests', 'customers', 'search');
Deny access to guests to search or create on customers
$acl->deny('guests', 'customers', ['search', 'create']);
Deny access to any role to browse on products
$acl->deny('*', 'products', 'browse');
Deny access to any role to browse on any resource
$acl->deny('*', '*', 'browse');
|
|
dropResourceAccess ( string $resource, array | string $accessList ) | ||
getNoArgumentsDefaultAction ( ) : integer | Returns the default ACL access level for no arguments provided in isAllowed action if there exists func for accessKey | |
getRedis ( ) | ||
getResourceAccess ( $resource ) | ||
getResources ( ) : Phalcon\Acl\Resource[] | ||
getRoleInherits ( $role ) : array | ||
getRoles ( ) : Phalcon\Acl\RoleInterface[] | ||
isAllowed ( string $role, string $resource, string $access, array $parameters = null ) : boolean |
{@inheritdoc}
Example:
Does Andres have access to the customers resource to create?
$acl->isAllowed('Andres', 'Products', 'create');
Do guests have access to any resource to edit?
$acl->isAllowed('guests', '*', 'edit');
|
|
isResource ( string $resourceName ) : boolean | ||
isResourceAccess ( $resource, $access ) | ||
isRole ( string $roleName ) : boolean | ||
setNoArgumentsDefaultAction ( integer $defaultAccess ) | Sets the default access level for no arguments provided in isAllowed action if there exists func for accessKey | |
setRedis ( $redis, $chainRedis = false ) |
Method | Description | |
---|---|---|
allowOrDeny ( string $roleName, string $resourceName, array | string $access, integer $action ) | Inserts/Updates a permission in the access list | |
resourcePermission ( $role, $access, $allowOrDeny ) | ||
rolePermission ( $resource, $access, $allowOrDeny ) | ||
setAccess ( $roleName, $resourceName, $accessName, $action ) : boolean |
public addInherit ( string $roleName, Phalcon\Acl\Role | string $roleToInherit ) | ||
$roleName | string | |
$roleToInherit | Phalcon\Acl\Role | string |
Add a resource to the the list allowing access to an action
$acl->addResource(new Phalcon\Acl\Resource('customers'), 'search');
$acl->addResource('customers', 'search');
Add a resource with an access list
$acl->addResource(new Phalcon\Acl\Resource('customers'), ['create', 'search']);
$acl->addResource('customers', ['create', 'search']);
$acl->addRole(new Phalcon\Acl\Role('administrator'), 'consultor');
$acl->addRole('administrator', 'consultor');
Allow access to guests to search on customers
$acl->allow('guests', 'customers', 'search');
Allow access to guests to search or create on customers
$acl->allow('guests', 'customers', ['search', 'create']);
Allow access to any role to browse on products
$acl->allow('*', 'products', 'browse');
Allow access to any role to browse on any resource
$acl->allow('*', '*', 'browse');
Deny access to guests to search on customers
$acl->deny('guests', 'customers', 'search');
Deny access to guests to search or create on customers
$acl->deny('guests', 'customers', ['search', 'create']);
Deny access to any role to browse on products
$acl->deny('*', 'products', 'browse');
Deny access to any role to browse on any resource
$acl->deny('*', '*', 'browse');
public getNoArgumentsDefaultAction ( ) : integer | ||
return | integer |
public getResources ( ) : Phalcon\Acl\Resource[] | ||
return | Phalcon\Acl\Resource[] |
public getRoles ( ) : Phalcon\Acl\RoleInterface[] | ||
return | Phalcon\Acl\RoleInterface[] |
Does Andres have access to the customers resource to create?
$acl->isAllowed('Andres', 'Products', 'create');
Do guests have access to any resource to edit?
$acl->isAllowed('guests', '*', 'edit');
public isResource ( string $resourceName ) : boolean | ||
$resourceName | string | |
return | boolean |
protected resourcePermission ( $role, $access, $allowOrDeny ) | ||
$role | ||
$access | ||
$allowOrDeny |
protected rolePermission ( $resource, $access, $allowOrDeny ) | ||
$resource | ||
$access | ||
$allowOrDeny |
public setNoArgumentsDefaultAction ( integer $defaultAccess ) | ||
$defaultAccess | integer | Phalcon\Acl::ALLOW or Phalcon\Acl::DENY |
protected int $noArgumentsDefaultAction | ||
return | integer |