IniAcl Class Info:
- Class Declaration:
class IniAcl extends Object implements AclInterface
- File name:
- Cake/Controller/Component/Acl/IniAcl.php
- Description:
IniAcl implements an access control system using an INI file. An example of the ini file used can be found in /config/acl.ini.php.
- Class Inheritance
- Interfaces Implemented
- AclInterface
- Package
- Cake.Controller.Component
Properties:
-
config array
Array with configuration, parsed from ini file
-
userPath string
The Set::classicExtract() path to the user/aro identifier in the acl.ini file. This path will be used to extract the string representation of a user used in the ini file.
Method Summary:
- allow( $aro, $aco, $action = '*' )
- arrayTrim( $array )
- check( $aro, $aco, $action = NULL )
- __construct( )
- deny( $aro, $aco, $action = '*' )
- dispatchMethod( $method, $params = array ( ) )
- inherit( $aro, $aco, $action = '*' )
- initialize( $component )
- log( $msg, $type = 2 )
- _mergeVars( $properties, $class, $normalize = true )
- readConfigFile( $filename )
- requestAction( $url, $extra = array ( ) )
- _set( $properties = array ( ) )
- _stop( $status = 0 )
- toString( )
allow
topNo op method, allow cannot be done with IniAcl
- 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/IniAcl.php on line 58
- Return
boolean Success
arrayTrim
topRemoves trailing spaces on all array elements (to prepare for searching)
- Parameters:
-
-
array $array required
Array to trim
-
- Method defined in:
- Cake/Controller/Component/Acl/IniAcl.php on line 164
- Return
array Trimmed array
check
topMain ACL check function. Checks to see if the ARO (access request object) has access to the ACO (access control object).Looks at the acl.ini.php file for permissions (see instructions in /config/acl.ini.php).
- Parameters:
-
-
string $aro required
ARO
-
string $aco required
ACO
-
string $action optional NULL
Action
-
- Method defined in:
- Cake/Controller/Component/Acl/IniAcl.php on line 93
- Return
boolean Success
deny
topNo op method, deny cannot be done with IniAcl
- 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/IniAcl.php on line 69
- Return
boolean Success
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
inherit
topNo op method, inherit cannot be done with IniAcl
- 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/IniAcl.php on line 80
- Return
boolean Success
initialize
topInitialize method
- Parameters:
-
-
AclBase $component required
-
- Method defined in:
- Cake/Controller/Component/Acl/IniAcl.php on line 47
- 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
readConfigFile
topParses an INI file and returns an array that reflects the INI file's section structure. Double-quote friendly.
- Parameters:
-
-
string $filename required
File
-
- Method defined in:
- Cake/Controller/Component/Acl/IniAcl.php on line 152
- Return
array INI section structure
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.
_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