Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

 Class JAuthorization

Description

Class that handles all access authorization

Located in /joomla/user/authorization.php (line 28)

Class gacl   (Package phpGACL)

Class gacl_api   (Package phpGACL)
   
   Class JAuthorization   (Subpackage User)
Variable Summary
Variable mixed $acl
Variable mixed $acl_count
Method Summary
Constructor JAuthorization JAuthorization ([array $options = NULL])
Method 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)
Method object The getAroGroup (string $value)
Method string|array get_group_children_tree ([int $root_id = null], [string $root_name = null], [boolean $inclusive = true], [boolean $html = true])
Method string get_group_name ([int $group_id = null], [string $group_type = 'ARO'])
Method void get_group_parents ( $group_id, [ $group_type = 'ARO'], [ $recurse = 'NO_RECURSE'])
Method void is_group_child_of ( $grp_src,  $grp_tgt, [ $group_type = 'ARO'])
Method void _getBelow ( $table,  $fields, [ $groupby = null], [ $root_id = null], [ $root_name = null], [ $inclusive = true])
Method void _getGroup ( $type,  $value)
Method void _mos_add_acl ( $aco_section_value,  $aco_value,  $aro_section_value,  $aro_value, [ $axo_section_value = NULL], [ $axo_value = NULL])
Methods
Constructor JAuthorization (line 37)

Constructor

JAuthorization JAuthorization ([array $options = NULL])
  • array $options: An arry of options to oeverride the class defaults
acl_check (line 235)

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)

Redefinition of:
gacl::acl_check()
Wraps the actual acl_query() function.
getAroGroup (line 280)
  • return: row from the group table
object The getAroGroup (string $value)
  • string $value: The value for the group
get_group_children_tree (line 340)
  • 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 271)

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 444)
void get_group_parents ( $group_id, [ $group_type = 'ARO'], [ $recurse = 'NO_RECURSE'])
  • $group_id
  • $group_type
  • $recurse
is_group_child_of (line 397)
void is_group_child_of ( $grp_src,  $grp_tgt, [ $group_type = 'ARO'])
  • $grp_src
  • $grp_tgt
  • $group_type
_getBelow (line 298)
void _getBelow ( $table,  $fields, [ $groupby = null], [ $root_id = null], [ $root_name = null], [ $inclusive = true])
  • $table
  • $fields
  • $groupby
  • $root_id
  • $root_name
  • $inclusive
_getGroup (line 284)
void _getGroup ( $type,  $value)
  • $type
  • $value
_mos_add_acl (line 214)

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 ( $aco_section_value,  $aco_value,  $aro_section_value,  $aro_value, [ $axo_section_value = NULL], [ $axo_value = NULL])
  • $aco_section_value
  • $aco_value
  • $aro_section_value
  • $aro_value
  • $axo_section_value
  • $axo_value

Inherited Methods

Inherited From gacl_api

 gacl_api::add_acl()
 gacl_api::add_group()
 gacl_api::add_group_object()
 gacl_api::add_object()
 gacl_api::add_object_section()
 gacl_api::append_acl()
 gacl_api::clear_database()
 gacl_api::consolidated_edit_acl()
 gacl_api::count_all()
 gacl_api::del_acl()
 gacl_api::del_group()
 gacl_api::del_group_object()
 gacl_api::del_object()
 gacl_api::del_object_section()
 gacl_api::edit_acl()
 gacl_api::edit_group()
 gacl_api::edit_object()
 gacl_api::edit_object_section()
 gacl_api::format_groups()
 gacl_api::get_acl()
 gacl_api::get_group_children()
 gacl_api::get_group_data()
 gacl_api::get_group_id()
 gacl_api::get_group_objects()
 gacl_api::get_group_parent_id()
 gacl_api::get_object()
 gacl_api::get_objects()
 gacl_api::get_object_data()
 gacl_api::get_object_groups()
 gacl_api::get_object_id()
 gacl_api::get_object_section_section_id()
 gacl_api::get_object_section_value()
 gacl_api::get_root_group_id()
 gacl_api::get_schema_version()
 gacl_api::get_ungrouped_objects()
 gacl_api::get_version()
 gacl_api::is_conflicting_acl()
 gacl_api::rebuild_tree()
 gacl_api::search_acl()
 gacl_api::shift_acl()
 gacl_api::showarray()
 gacl_api::sort_groups()
 gacl_api::_defaultGenID()
 gacl_api::_rebuild_tree()

Inherited From gacl

 gacl::gacl()
 gacl::acl_check()
 gacl::acl_check_array()
 gacl::acl_get_groups()
 gacl::acl_query()
 gacl::acl_return_value()
 gacl::debug_db()
 gacl::debug_text()
 gacl::get_cache()
 gacl::put_cache()

Documentation generated on Mon, 05 Mar 2007 20:52:53 +0000 by phpDocumentor 1.3.1