Référence de la classe gacl

Graphe d'héritage de gacl:

Liste de tous les membres

Fonctions membres publiques

• gacl ($options=NULL)
• debug_text ($text)
• debug_db ($function_name= '')
• 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)
• 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)
• acl_check_array ($aco_section_value, $aco_value, $aro_array)
• 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)
• acl_get_groups ($section_value, $value, $root_group=NULL, $group_type='ARO')
• get_cache ($cache_id)
• put_cache ($data, $cache_id)

Attributs publics

• $_debug = FALSE
• $_debugLog = null
• $_db_table_prefix = ''
• $_db_type = 'mysql'
• $_db_host = 'localhost'
• $_db_user = 'root'
• $_db_password = ''
• $_db_name = 'gacl'
• $_db = ''
• $_caching = FALSE
• $_force_cache_expire = TRUE
• $_cache_dir = '/tmp/phpgacl_cache'
• $_cache_expire_time = 600
• $_group_switch = '_group_'

---

Documentation des fonctions membres

gacl::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
	)

Wraps the actual acl_query() function.

It is simply here to return TRUE/FALSE accordingly.

Paramètres:

string	The ACO section value
string	The ACO value
string	The ARO section value
string	The ARO section
string	The AXO section value (optional)
string	The AXO section value (optional)
integer	The group id of the ARO ??Mike?? (optional)
integer	The group id of the AXO ??Mike?? (optional)

Renvoie:

boolean TRUE if the check succeeds, false if not.

Réimplémentée dans JAuthorization.

Références acl_query().

Référencé par acl_check_array().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

gacl::acl_check_array	(	$	aco_section_value,
		$	aco_value,
		$	aro_array
	)

Handles ACL lookups over arrays of AROs

Paramètres:

string	The ACO section value
string	The ACO value
array	An named array of arrays, each element in the format aro_section_value=>array(aro_value1,aro_value1,...)

Renvoie:

mixed The same data format as inputted.

Références acl_check(), et debug_text().

Voici le graphe d'appel pour cette fonction :

gacl::acl_get_groups	(	$	section_value,
		$	value,
		$	root_group = NULL,
		$	group_type = 'ARO'
	)

Grabs all groups mapped to an ARO. You can also specify a root_group for subtree'ing.

Paramètres:

string	The section value or the ARO or ACO
string	The value of the ARO or ACO
integer	The group id of the group to start at (optional)
string	The type of group, either ARO or AXO (optional)

Références $i, $query, $where, debug_db(), get_cache(), et put_cache().

Référencé par acl_query().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

gacl::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
	)

The Main function that does the actual ACL lookup.

Paramètres:

string	The ACO section value
string	The ACO value
string	The ARO section value
string	The ARO section
string	The AXO section value (optional)
string	The AXO section value (optional)
string	The value of the ARO group (optional)
string	The value of the AXO group (optional)
boolean	Debug the operation if true (optional)

Renvoie:

array Returns as much information as possible about the ACL so other functions can trim it down and omit unwanted data.

Références $debug, $query, acl_get_groups(), debug_db(), debug_text(), get_cache(), et put_cache().

Référencé par acl_check(), et acl_return_value().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

gacl::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
	)

Wraps the actual acl_query() function.

Quick access to the return value of an ACL.

Paramètres:

string	The ACO section value
string	The ACO value
string	The ARO section value
string	The ARO section
string	The AXO section value (optional)
string	The AXO section value (optional)
integer	The group id of the ARO (optional)
integer	The group id of the AXO (optional)

Renvoie:

string The return value of the ACL

Références acl_query().

Voici le graphe d'appel pour cette fonction :

gacl::debug_db

(

$

function_name = ''

)

Prints database debug text if debug is enabled.

Paramètres:

string

The name of the function calling this method

Renvoie:

string Returns an error message

Références debug_text().

Référencé par acl_get_groups(), et acl_query().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

gacl::debug_text

(

$

text

)

Prints debug text if debug is enabled.

Paramètres:

string

THe text to output

Renvoie:

boolean Always returns true

Références $text.

Référencé par acl_check_array(), acl_query(), debug_db(), gacl(), get_cache(), et put_cache().

Voici le graphe d'appel pour cette fonction :

gacl::gacl

(

$

options = NULL

)

Constructor

Paramètres:

array

An arry of options to oeverride the class defaults

Références debug_text().

Voici le graphe d'appel pour cette fonction :

gacl::get_cache

(

$

cache_id

)

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ètres:

string

The id of the cached object

Renvoie:

mixed The cached object, otherwise FALSE if the object identifier was not found

Références debug_text().

Référencé par acl_get_groups(), et acl_query().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

gacl::put_cache	(	$	data,
		$	cache_id
	)

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ètres:

mixed	A variable to cache
string	The id of the cached variable

Références $data, et debug_text().

Référencé par acl_get_groups(), et acl_query().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

gacl::$_cache_dir = '/tmp/phpgacl_cache'

gacl::$_cache_expire_time = 600

gacl::$_caching = FALSE

gacl::$_db = ''

gacl::$_db_host = 'localhost'

gacl::$_db_name = 'gacl'

gacl::$_db_password = ''

gacl::$_db_table_prefix = ''

gacl::$_db_type = 'mysql'

gacl::$_db_user = 'root'

gacl::$_debug = FALSE

gacl::$_debugLog = null

Joomla usage

gacl::$_force_cache_expire = TRUE

gacl::$_group_switch = '_group_'

---

La documentation de cette classe a été générée à partir du fichier suivant :

• gacl.php