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.
$config
public array
$userPath
public string
The Hash::extract() 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.
Main 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).
Parses an INI file and returns an array that reflects the INI file's section structure. Double-quote friendly.
allow( string $aro , string $aco , string $action "*" )
No op method, allow cannot be done with IniAcl
$aro
$aco
$action
optional "*" AclInterface::allow()
arrayTrim( array $array )
Removes trailing spaces on all array elements (to prepare for searching)
$array
check( string $aro , string $aco , string $action null )
Main 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).
$aro
$aco
$action
optional null AclInterface::check()
deny( string $aro , string $aco , string $action "*" )
No op method, deny cannot be done with IniAcl
$aro
$aco
$action
optional "*" AclInterface::deny()
inherit( string $aro , string $aco , string $action "*" )
No op method, inherit cannot be done with IniAcl
$aro
$aco
$action
optional "*" AclInterface::inherit()
initialize( Component $component )
Initialize method
Component
$component
AclInterface::initialize()
readConfigFile( string $filename )
Parses an INI file and returns an array that reflects the INI file's section structure. Double-quote friendly.
$filename
_mergeVars( array $properties , string $class , boolean $normalize true )
Merges 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.
$properties
$class
$normalize
optional true _set( array $properties array() )
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 dispatchMethod( string $method , array $params array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array
$method
$params
optional array() log( string $msg , integer $type LOG_ERR , null|string|array $scope null )
Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
requestAction( string|array $url , array $extra array() )
Calls 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()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$url
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.
$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.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
CakeObject-to-string conversion. Each class can override this method as necessary.
public string
The Hash::extract() 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.
'User.username'
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.9/class-IniAcl.html