AclComponent Class Info:

Class Declaration:
class AclComponent extends Object
File name:
cake/libs/controller/components/acl.php
Summary:
Access Control List factory class. Looks for ACL implementation class in core config, and returns an instance of that class.
Class Inheritance

Object

package
cake
subpackage
cake.cake.libs.controller.components

Properties:

Show/Hide parent properties
protected _Instance Instance of an ACL class
protected _log Log object

Method Summary:

Show/Hide parent methods
public allow( $aro, $aco, $action = '*' )
public cakeError( $method, $messages = array ( ) )
public check( $aro, $aco, $action = '*' )
public __construct( )
public deny( $aro, $aco, $action = '*' )
public dispatchMethod( $method, $params = array ( ) )
public grant( $aro, $aco, $action = '*' )
public inherit( $aro, $aco, $action = '*' )
protected _initACL( )
public log( $msg, $type = 2 )
public Object( )
protected _persist( $name, $return, $object, $type = NULL )
public requestAction( $url, $extra = array ( ) )
public revoke( $aro, $aco, $action = '*' )
protected _savePersistent( $name, $object )
protected _set( $properties = array ( ) )
public startup( $controller )
public _stop( $status = 0 )
public toString( )

allow

top
Pass-thru function for ACL allow instance.
Parameters:
$aro string ARO required (no default)
$aco string ACO required (no default)
$action string Action (defaults to *) optional '*'
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 100
return
boolean Success
access
public

cakeError

top
Used 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:
$method string Method to be called in the error class (AppError or ErrorHandler classes) required (no default)
$messages array Message that is to be displayed by the error class optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 189
return
error message
access
public

check

top
Pass-thru function for ACL check instance.
Parameters:
$aro string ARO required (no default)
$aco string ACO required (no default)
$action string Action (defaults to *) optional '*'
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 88
return
boolean Success
access
public

__construct

top
Constructor. Will return an instance of the correct ACL class.
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 47

deny

top
Pass-thru function for ACL deny instance.
Parameters:
$aro string ARO required (no default)
$aco string ACO required (no default)
$action string Action (defaults to *) optional '*'
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 112
return
boolean Success
access
public

dispatchMethod

top
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.
Parameters:
$method string Name of the method to call required (no default)
$params array Parameter list to use when calling $method optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 113
return
mixed Returns the result of the method call
access
public

grant

top
Pass-thru function for ACL grant instance.
Parameters:
$aro string ARO required (no default)
$aco string ACO required (no default)
$action string Action (defaults to *) optional '*'
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 136
return
boolean Success
access
public

inherit

top
Pass-thru function for ACL inherit instance.
Parameters:
$aro string ARO required (no default)
$aco string ACO required (no default)
$action string Action (defaults to *) optional '*'
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 124
return
boolean Success
access
public

_initACL

top
Empty class defintion, to be overridden in subclasses.
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 77
access
protected

log

top
API for logging events.
Parameters:
$msg string Log message required (no default)
$type integer Error type constant. Defined in app/config/core.php. optional 2
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 150
return
boolean Success of log write
access
public

Object

top
A 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 class:
Object
Method defined in file:
cake/libs/object.php on line 53
return
Object

_persist

top
Checks 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:
$name string name of the class to persist required (no default)
$return required (no default)
$object string the object to persist required (no default)
$type optional NULL
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 219
return
boolean Success
access
protected
todo
add examples to manual

requestAction

top
Calls a controller's method from any location.
Parameters:
$url mixed String or array-based url. required (no default)
$extra array if array includes the key "return" it sets the AutoRender to true. optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 86
return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
access
public

revoke

top
Pass-thru function for ACL grant instance.
Parameters:
$aro string ARO required (no default)
$aco string ACO required (no default)
$action string Action (defaults to *) optional '*'
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 148
return
boolean Success
access
public

_savePersistent

top
You should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters:
$name string name used for object to cache required (no default)
$object object the object to persist required (no default)
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 247
return
boolean true on save, throws error if file can not be created
access
protected

_set

top
Allows setting of multiple properties of the object in a single line of code.
Parameters:
$properties array An associative array containing properties and corresponding values. optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 169
return
void
access
protected

startup

top
Startup is not used
Parameters:
$controller object Controller using this component required (no default)
Method defined in class:
AclComponent
Method defined in file:
cake/libs/controller/components/acl.php on line 69
return
boolean Proceed with component usage (true), or fail (false)
access
public

_stop

top
Stop execution of the current script
Parameters:
$status optional 0
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 139
return
void
access
public

toString

top
Object-to-string conversion. Each class can override this method as necessary.
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 73
return
string The name of this class
access
public