DbAcl Class Info:
- Class Declaration:
class DbAcl extends AclBase
- File name:
- cake/libs/controller/components/acl.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
- Package
- cake
- Subpackage
- cake.cake.libs.model
Properties:
Method Summary:
- allow( $aro, $aco, $actions = '*', $value = 1 )
- cakeError( $method, $messages = array ( ) )
- 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 )
- Object( )
- __openPersistent( $name, $type = NULL )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- revoke( $aro, $aco, $action = '*' )
- _savePersistent( $name, $object )
- _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/libs/controller/components/acl.php on line 355
- Return
boolean Success
- Access
public
- Link
- http://book.cakephp.org/view/1248/Assigning-Permissions
cakeError
topUsed to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
- Parameters:
-
-
string $method required
Method to be called in the error class (AppError or ErrorHandler classes)
-
array $messages optional array ( )
Message that is to be displayed by the error class
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
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/libs/controller/components/acl.php on line 263
- Return
boolean Success (true if ARO has access to action in ACO, false otherwise)
- Access
public
- Link
- http://book.cakephp.org/view/1249/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.
-
$action optional '*'
-
- Method defined in:
- cake/libs/controller/components/acl.php on line 407
- Return
boolean Success
- Access
public
- Link
- http://book.cakephp.org/view/1248/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/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
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/libs/controller/components/acl.php on line 460
- Return
array Indexed array with: 'aro', 'aco' and 'link'
- Access
public
_getAcoKeys
topGet the keys used in an ACO
- Parameters:
-
-
array $keys required
Permission model info
-
- Method defined in:
- cake/libs/controller/components/acl.php on line 486
- Return
array ACO keys
- Access
protected
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.
-
$action optional '*'
-
- Method defined in:
- cake/libs/controller/components/acl.php on line 434
- Return
boolean Success
- See
allow()
- Access
public
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.
-
$action optional '*'
-
- Method defined in:
- cake/libs/controller/components/acl.php on line 420
- Return
boolean Success
- Access
public
initialize
topInitializes the containing component and sets the Aro/Aco objects to it.
- Parameters:
-
-
AclComponent $component required
-
- Method defined in:
- cake/libs/controller/components/acl.php on line 248
- Return
void
- Access
public
log
topConvience 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/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
__openPersistent
topOpen the persistent class file for reading Used by Object::_persist()
- Parameters:
-
-
string $name required
Name of persisted class
-
string $type optional NULL
Type of persistance (e.g: registry)
-
- Method defined in:
- cake/libs/object.php on line 268
- Return
void
- Access
private
_persist
topChecks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
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.
- Parameters:
-
-
mixed $url required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
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.
-
$action optional '*'
-
- Method defined in:
- cake/libs/controller/components/acl.php on line 448
- Return
boolean Success
- See
deny()
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_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/libs/object.php on line 166
- Return
void
- Access
protected
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
