groupTree Class Reference

Inheritance diagram for groupTree:

Public Member Functions
	callGroups ($extra_sql=false, $skip_group_id=false)
	callRootGroup ()
	callChildGroup ($user_group_id)
	compileResults ($create_html=true, $create_array=false, $extra_sql=false, $skip_group_id=false)
Data Fields
	$groupArray
	$RESULTS
Protected Attributes
	$groupListingArray
	$groupPListingArray
	$parentGroupListingArray
	$outputGroupArray

---

Detailed Description

Class is used by group listing to create group tree.

---

Member Function Documentation

callChildGroup

(

$

user_group_id

)

Recursive function that loops through all children groups.

Parameters:

int

$user_group_id

callGroups	(	$	extra_sql = false,
		$	skip_group_id = false
	)

Queries group database and starts tree listing.

Parameters:

string	$extra_sql	Allows one to add an additional sql string.
	boolean	Select group to skip in listing.

callRootGroup

(

)

Calls and list all root items and root items with children.

compileResults	(	$	create_html = true,
		$	create_array = false,
		$	extra_sql = false,
		$	skip_group_id = false
	)

Will compile the needed HTML for group tree structure ready for output.

Parameters:

boolean	$create_html	If it should create HTML results.
boolean	$create_array	If it should create short array of menu items in order.
string	$extra_sql	Additional sql data to be processed.
	int	Select group to skip in listing.

---

Field Documentation

$groupArray

$groupListingArray [protected]

$groupPListingArray [protected]

$outputGroupArray [protected]

$parentGroupListingArray [protected]

$RESULTS

---

The documentation for this class was generated from the following file:

• /home/jason/NetBeansProjects/phpdev/plugins/PHPDevShell/includes/groupTree.class.php