PHP Class Phalcon\Acl\Adapter\Mongo

Inheritance: extends Phalcon\Acl\Adapter

Datei anzeigen Open project: phalcon/incubator

Protected Properties

Property	Type	Description
$noArgumentsDefaultAction	integer	Default action for no arguments is allow
$options	array

Public Methods

Method	Description
__construct ( array $options )	Class constructor.
addInherit ( string $roleName, string $roleToInherit )
addResource ( Phalcon\Acl\Resource $resource, array \| string $accessList = null ) : boolean
addResourceAccess ( string $resourceName, array \| string $accessList ) : boolean
addRole ( string $role, array $accessInherits = null ) : boolean
allow ( string $roleName, string $resourceName, mixed $access, mixed $func = null )
deny ( string $roleName, string $resourceName, mixed $access, mixed $func = null ) : boolean
dropResourceAccess ( string $resourceName, array \| string $accessList )
getNoArgumentsDefaultAction ( ) : integer	Returns the default ACL access level for no arguments provided in isAllowed action if there exists func for accessKey
getResources ( ) : Phalcon\Acl\Resource[]
getRoles ( ) : Phalcon\Acl\RoleInterface[]
isAllowed ( string $role, string $resource, string $access, array $parameters = null ) : boolean
isResource ( string $resourceName ) : boolean
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

Protected Methods

Method	Description
allowOrDeny ( string $roleName, string $resourceName, string $access, integer $action )	Inserts/Updates a permission in the access list
getCollection ( string $name ) : MongoCollection	Returns a mongo collection
insertOrUpdateAccess ( string $roleName, string $resourceName, string $accessName, integer $action ) : boolean	Inserts/Updates a permission in the access list

Method Details

__construct() public method

Class constructor.

public __construct ( array $options )
$options	array

addInherit() public method

public addInherit ( string $roleName, string $roleToInherit )
$roleName	string
$roleToInherit	string

addResource() public method

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']);

public addResource ( Phalcon\Acl\Resource $resource, array \| string $accessList = null ) : boolean
$resource	Phalcon\Acl\Resource
$accessList	array \| string
return	boolean

addResourceAccess() public method

public addResourceAccess ( string $resourceName, array \| string $accessList ) : boolean
$resourceName	string
$accessList	array \| string
return	boolean

addRole() public method

Example: $acl->addRole(new Phalcon\Acl\Role('administrator'), 'consultor'); $acl->addRole('administrator', 'consultor');

public addRole ( string $role, array $accessInherits = null ) : boolean
$role	string
$accessInherits	array
return	boolean

allow() public method

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');

public allow ( string $roleName, string $resourceName, mixed $access, mixed $func = null )
$roleName	string
$resourceName	string
$access	mixed
$func	mixed

allowOrDeny() protected method

Inserts/Updates a permission in the access list

protected allowOrDeny ( string $roleName, string $resourceName, string $access, integer $action )
$roleName	string
$resourceName	string
$access	string
$action	integer

deny() public method

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');

public deny ( string $roleName, string $resourceName, mixed $access, mixed $func = null ) : boolean
$roleName	string
$resourceName	string
$access	mixed
$func	mixed
return	boolean

dropResourceAccess() public method

public dropResourceAccess ( string $resourceName, array \| string $accessList )
$resourceName	string
$accessList	array \| string

getCollection() protected method

Returns a mongo collection

protected getCollection ( string $name ) : MongoCollection
$name	string
return	MongoCollection

getNoArgumentsDefaultAction() public method

Returns the default ACL access level for no arguments provided in isAllowed action if there exists func for accessKey

public getNoArgumentsDefaultAction ( ) : integer
return	integer

getResources() public method

public getResources ( ) : Phalcon\Acl\Resource[]
return	Phalcon\Acl\Resource[]

getRoles() public method

public getRoles ( ) : Phalcon\Acl\RoleInterface[]
return	Phalcon\Acl\RoleInterface[]

insertOrUpdateAccess() protected method

Inserts/Updates a permission in the access list

protected insertOrUpdateAccess ( string $roleName, string $resourceName, string $accessName, integer $action ) : boolean
$roleName	string
$resourceName	string
$accessName	string
$action	integer
return	boolean

isAllowed() public method

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');

public isAllowed ( string $role, string $resource, string $access, array $parameters = null ) : boolean
$role	string
$resource	string
$access	string
$parameters	array
return	boolean

isResource() public method

public isResource ( string $resourceName ) : boolean
$resourceName	string
return	boolean

isRole() public method

public isRole ( string $roleName ) : boolean
$roleName	string
return	boolean

setNoArgumentsDefaultAction() public method

Sets the default access level for no arguments provided in isAllowed action if there exists func for accessKey

public setNoArgumentsDefaultAction ( integer $defaultAccess )
$defaultAccess	integer	Phalcon\Acl::ALLOW or Phalcon\Acl::DENY

Property Details

$noArgumentsDefaultAction protected_oe property

Default action for no arguments is allow

protected int $noArgumentsDefaultAction
return	integer

$options protected_oe property

protected array $options
return	array