AclComponent Class Info:
- Class Declaration:
class AclComponent extends Object
- File name:
- cake/libs/controller/components/acl.php
- Description:
Access Control List factory class.
Uses a strategy pattern to allow custom ACL implementations to be used with the same component interface. You can define by changing
Configure::write('Acl.classname', 'DbAcl');in your core.php. Concrete ACL implementations should extendAclBaseand implement the methods it defines.- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs.controller.components
- Link
- http://book.cakephp.org/view/1242/Access-Control-Lists
Properties:
-
_Instance object
Instance of an ACL class
Method Summary:
- allow( $aro, $aco, $action = '*' )
- cakeError( $method, $messages = array ( ) )
- check( $aro, $aco, $action = '*' )
- __construct( )
- deny( $aro, $aco, $action = '*' )
- dispatchMethod( $method, $params = array ( ) )
- grant( $aro, $aco, $action = '*' )
- inherit( $aro, $aco, $action = '*' )
- _initACL( )
- log( $msg, $type = 2 )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- revoke( $aro, $aco, $action = '*' )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- startup( $controller )
- _stop( $status = 0 )
- toString( )
allow
topPass-thru function for ACL allow instance. Allow methods are used to grant an ARO access to an 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 105
- Return
boolean Success
- Access
public
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
topPass-thru function for ACL check instance. Check methods are used to check whether or not an ARO can access an 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 91
- Return
boolean Success
- Access
public
__construct
topConstructor. Will return an instance of the correct ACL class as defined in Configure::read('Acl.classname')
- Method defined in:
- cake/libs/controller/components/acl.php on line 48
deny
topPass-thru function for ACL deny instance. Deny methods are used to remove permission from an ARO to access an 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 119
- Return
boolean Success
- Access
public
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
grant
topPass-thru function for ACL grant instance. An alias for AclComponent::allow()
- 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 146
- Return
boolean Success
- Access
public
inherit
topPass-thru function for ACL inherit instance. Inherit methods modify the permission for an ARO to be that of its parent object.
- 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 133
- Return
boolean Success
- Access
public
_initACL
topEmpty class defintion, to be overridden in subclasses.
- Method defined in:
- cake/libs/controller/components/acl.php on line 78
- Access
protected
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
_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
topPass-thru function for ACL grant instance. An alias for AclComponent::deny()
- 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 159
- Return
boolean Success
- 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
startup
topStartup is not used
- Parameters:
-
-
object $controller required
Controller using this component
-
- Method defined in:
- cake/libs/controller/components/acl.php on line 69
- Return
boolean Proceed with component usage (true), or fail (false)
- Access
public
_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
