Docs For Class JAuthorization

Description

Class that handles all access authorization

since: 1.1

Located in /application/user/authorization.php (line 31)

gacl_api
   |
   --JAuthorization

Variable Summary

mixed $acl

mixed $acl_count

Method Summary

JAuthorization JAuthorization ([array $options = NULL])

mixed acl_check (string $aco_section_value, string $aco_value, string $aro_section_value, string $aro_value, [string $axo_section_value = NULL], [string $axo_value = NULL], integer 6, integer 7)

object The getAroGroup (string $value)

string|array get_group_children_tree ([int $root_id = null], [string $root_name = null], [boolean $inclusive = true], [boolean $html = true])

string get_group_name ([int $group_id = null], [string $group_type = 'ARO'])

void get_group_parents (mixed $group_id, [mixed $group_type = 'ARO'], [mixed $recurse = 'NO_RECURSE'])

void is_group_child_of (mixed $grp_src, mixed $grp_tgt, [mixed $group_type = 'ARO'])

void _getBelow (mixed $table, mixed $fields, [mixed $groupby = null], [mixed $root_id = null], [mixed $root_name = null], [mixed $inclusive = true])

void _getGroup (mixed $type, mixed $value)

void _mos_add_acl (mixed $aco_section_value, mixed $aco_value, mixed $aro_section_value, mixed $aro_value, [mixed $axo_section_value = NULL], [mixed $axo_value = NULL])

Variables

mixed $acl = null (line 33)

mixed $acl_count (line 34)

Methods

Constructor JAuthorization (line 40)

Constructor

JAuthorization JAuthorization ([array $options = NULL])

array $options: An arry of options to oeverride the class defaults

acl_check (line 215)

Wraps the actual acl_query() function.

It is simply here to return TRUE/FALSE accordingly.

return: Generally a zero (0) or (1) or the extended return value of the ACL

mixed acl_check (string $aco_section_value, string $aco_value, string $aro_section_value, string $aro_value, [string $axo_section_value = NULL], [string $axo_value = NULL], integer 6, integer 7)

integer 6: The group id of the ARO ??Mike?? (optional)
integer 7: The group id of the AXO ??Mike?? (optional)
string $aco_section_value: The ACO section value
string $aco_value: The ACO value
string $aro_section_value: The ARO section value
string $aro_value: The ARO section
string $axo_section_value: The AXO section value (optional)
string $axo_value: The AXO section value (optional)

getAroGroup (line 260)

return: row from the group table

object The getAroGroup (string $value)

string $value: The value for the group

get_group_children_tree (line 319)

return: String if html, otherwise an array

string|array get_group_children_tree ([int $root_id = null], [string $root_name = null], [boolean $inclusive = true], [boolean $html = true])

int $root_id
string $root_name
boolean $inclusive
boolean $html: Returns the complete html if true

get_group_name (line 251)

Gets the 'name' of a group

string get_group_name ([int $group_id = null], [string $group_type = 'ARO'])

int $group_id: The group id
string $group_type: The type: [ARO]|AXO

get_group_parents (line 421)

void get_group_parents (mixed $group_id, [mixed $group_type = 'ARO'], [mixed $recurse = 'NO_RECURSE'])

is_group_child_of (line 375)

void is_group_child_of (mixed $grp_src, mixed $grp_tgt, [mixed $group_type = 'ARO'])

_getBelow (line 278)

void _getBelow (mixed $table, mixed $fields, [mixed $groupby = null], [mixed $root_id = null], [mixed $root_name = null], [mixed $inclusive = true])

_getGroup (line 264)

void _getGroup (mixed $type, mixed $value)

_mos_add_acl (line 194)

This is a temporary function to allow 3PD's to add basic ACL checks for their

modules and components. NOTE: this information will be compiled in the db in future versions

void _mos_add_acl (mixed $aco_section_value, mixed $aco_value, mixed $aro_section_value, mixed $aro_value, [mixed $axo_section_value = NULL], [mixed $axo_value = NULL])