DbAcl Class Info:
- Class Declaration:
class DbAcl extends Object implements AclInterface
- File name:
- Cake/Controller/Component/Acl/DbAcl.php
- Description:
DbAcl implements an ACL control system in the database. ARO's and ACO's are structured into trees and a linking table is used to define permissions. You can install the schema for DbAcl with the Schema Shell.
$acoand$aroparameters can be slash delimited paths to tree nodes.eg.
controllers/Users/editWould point to a tree structure like
controllers Users edit- Class Inheritance
- Interfaces Implemented
- AclInterface
- Package
- Cake.Controller.Component
Method Summary:
- allow( $aro, $aco, $actions = '*', $value = 1 )
- check( $aro, $aco, $action = '*' )
- __construct( )
- deny( $aro, $aco, $action = '*' )
- dispatchMethod( $method, $params = array ( ) )
- getAclLink( $aro, $aco )
- _getAcoKeys( $keys )
- grant( $aro, $aco, $action = '*' )
- inherit( $aro, $aco, $action = '*' )
- initialize( $component )
- log( $msg, $type = 2 )
- _mergeVars( $properties, $class, $normalize = true )
- requestAction( $url, $extra = array ( ) )
- revoke( $aro, $aco, $action = '*' )
- _set( $properties = array ( ) )
- _stop( $status = 0 )
- toString( )
allow
topAllow $aro to have access to action $actions in $aco
- Parameters:
-
-
string $aro required
ARO The requesting object identifier.
-
string $aco required
ACO The controlled object identifier.
-
string $actions optional '*'
Action (defaults to *)
-
integer $value optional 1
Value to indicate access type (1 to give access, -1 to deny, 0 to inherit)
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 157
- Return
boolean Success
- Link
- http://book.cakephp.org/2.0/en/core-libraries/components/access-control-lists.html#assigning-permissions
check
topChecks if the given $aro has access to action $action in $aco
- Parameters:
-
-
string $aro required
ARO The requesting object identifier.
-
string $aco required
ACO The controlled object identifier.
-
string $action optional '*'
Action (defaults to *)
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 69
- Return
boolean Success (true if ARO has access to action in ACO, false otherwise)
- Link
- http://book.cakephp.org/2.0/en/core-libraries/components/access-control-lists.html#checking-permissions-the-acl-component
deny
topDeny access for $aro to action $action in $aco
- Parameters:
-
-
string $aro required
ARO The requesting object identifier.
-
string $aco required
ACO The controlled object identifier.
-
string $action optional '*'
Action (defaults to *)
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 208
- Return
boolean Success
- Link
- http://book.cakephp.org/2.0/en/core-libraries/components/access-control-lists.html#assigning-permissions
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- Cake/Core/Object.php on line 110
- Return
mixed Returns the result of the method call
getAclLink
topGet an array of access-control links between the given Aro and Aco
- Parameters:
-
-
string $aro required
ARO The requesting object identifier.
-
string $aco required
ACO The controlled object identifier.
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 257
- Return
array Indexed array with: 'aro', 'aco' and 'link'
_getAcoKeys
topGet the keys used in an ACO
- Parameters:
-
-
array $keys required
Permission model info
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 282
- Return
array ACO keys
grant
topAllow $aro to have access to action $actions in $aco
- Parameters:
-
-
string $aro required
ARO The requesting object identifier.
-
string $aco required
ACO The controlled object identifier.
-
string $action optional '*'
Action (defaults to *)
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 233
- Return
boolean Success
- See
allow()
inherit
topLet access for $aro to action $action in $aco be inherited
- Parameters:
-
-
string $aro required
ARO The requesting object identifier.
-
string $aco required
ACO The controlled object identifier.
-
string $action optional '*'
Action (defaults to *)
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 220
- Return
boolean Success
initialize
topInitializes the containing component and sets the Aro/Aco objects to it.
- Parameters:
-
-
AclComponent $component required
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 55
- Return
void
log
topConvenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/Config/core.php.
-
- Method defined in:
- Cake/Core/Object.php on line 149
- Return
boolean Success of log write
_mergeVars
topMerges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'
This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.
- Parameters:
-
-
array $properties required
The name of the properties to merge.
-
string $class required
The class to merge the property with.
-
boolean $normalize optional true
Set to true to run the properties through Set::normalize() before merging.
-
- Method defined in:
- Cake/Core/Object.php on line 187
- Return
void
requestAction
topCalls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()
Passing POST and GET data
POST and GET data can be simulated in requestAction. Use $extra['url'] for
GET data. The $extra['data'] parameter allows POST data simulation.
- Parameters:
-
-
mixed $url required
String or array-based url. Unlike other url arrays in CakePHP, this url will not automatically handle passed and named arguments in the $url parameter.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.
-
- Method defined in:
- Cake/Core/Object.php on line 66
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
revoke
topDeny access for $aro to action $action in $aco
- Parameters:
-
-
string $aro required
ARO The requesting object identifier.
-
string $aco required
ACO The controlled object identifier.
-
string $action optional '*'
Action (defaults to *)
-
- Method defined in:
- Cake/Controller/Component/Acl/DbAcl.php on line 246
- Return
boolean Success
- See
deny()
_set
topAllows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
- Parameters:
-
-
array $properties optional array ( )
An associative array containing properties and corresponding values.
-
- Method defined in:
- Cake/Core/Object.php on line 164
- Return
void
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
integer|string $status optional 0
see http://php.net/exit for values
-
- Method defined in:
- Cake/Core/Object.php on line 137
- Return
void
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- Cake/Core/Object.php on line 41
- Return
string The name of this class