| [ Index ] |
PHP Cross Reference of Joomla 1.5.26 DE |
[Source view] [Print] [Project Stats]
phpGACL - Generic Access Control List Copyright (C) 2002,2003 Mike Benoit This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
| File Size: | 626 lines (20 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
gacl:: (10 methods):
gacl()
debug_text()
debug_db()
acl_check()
acl_return_value()
acl_check_array()
acl_query()
acl_get_groups()
get_cache()
put_cache()
| gacl($options = NULL) X-Ref |
| Constructor param: array An arry of options to oeverride the class defaults |
| debug_text($text) X-Ref |
| Prints debug text if debug is enabled. param: string THe text to output return: boolean Always returns true |
| debug_db($function_name = '') X-Ref |
| Prints database debug text if debug is enabled. param: string The name of the function calling this method return: string Returns an error message |
| acl_check($aco_section_value, $aco_value, $aro_section_value, $aro_value, $axo_section_value=NULL, $axo_value=NULL, $root_aro_group=NULL, $root_axo_group=NULL) X-Ref |
| Wraps the actual acl_query() function. It is simply here to return TRUE/FALSE accordingly. param: string The ACO section value param: string The ACO value param: string The ARO section value param: string The ARO section param: string The AXO section value (optional) param: string The AXO section value (optional) param: integer The group id of the ARO ??Mike?? (optional) param: integer The group id of the AXO ??Mike?? (optional) return: boolean TRUE if the check succeeds, false if not. |
| acl_return_value($aco_section_value, $aco_value, $aro_section_value, $aro_value, $axo_section_value=NULL, $axo_value=NULL, $root_aro_group=NULL, $root_axo_group=NULL) X-Ref |
| Wraps the actual acl_query() function. Quick access to the return value of an ACL. param: string The ACO section value param: string The ACO value param: string The ARO section value param: string The ARO section param: string The AXO section value (optional) param: string The AXO section value (optional) param: integer The group id of the ARO (optional) param: integer The group id of the AXO (optional) return: string The return value of the ACL |
| acl_check_array($aco_section_value, $aco_value, $aro_array) X-Ref |
| Handles ACL lookups over arrays of AROs param: string The ACO section value param: string The ACO value param: array An named array of arrays, each element in the format aro_section_value=>array(aro_value1,aro_value1,...) return: mixed The same data format as inputted. |
| acl_query($aco_section_value, $aco_value, $aro_section_value, $aro_value, $axo_section_value=NULL, $axo_value=NULL, $root_aro_group=NULL, $root_axo_group=NULL, $debug=NULL) X-Ref |
| The Main function that does the actual ACL lookup. param: string The ACO section value param: string The ACO value param: string The ARO section value param: string The ARO section param: string The AXO section value (optional) param: string The AXO section value (optional) param: string The value of the ARO group (optional) param: string The value of the AXO group (optional) param: boolean Debug the operation if true (optional) return: array Returns as much information as possible about the ACL so other functions can trim it down and omit unwanted data. |
| acl_get_groups($section_value, $value, $root_group=NULL, $group_type='ARO') X-Ref |
| Grabs all groups mapped to an ARO. You can also specify a root_group for subtree'ing. param: string The section value or the ARO or ACO param: string The value of the ARO or ACO param: integer The group id of the group to start at (optional) param: string The type of group, either ARO or AXO (optional) |
| get_cache($cache_id) X-Ref |
| Uses PEAR's Cache_Lite package to grab cached arrays, objects, variables etc... using unserialize() so it can handle more then just text string. param: string The id of the cached object return: mixed The cached object, otherwise FALSE if the object identifier was not found |
| put_cache($data, $cache_id) X-Ref |
| Uses PEAR's Cache_Lite package to write cached arrays, objects, variables etc... using serialize() so it can handle more then just text string. param: mixed A variable to cache param: string The id of the cached variable |
| Generated: Wed Mar 28 15:54:07 2012 | Cross-referenced by PHPXref 0.7.1 |