menuStructure Class Reference

Inheritance diagram for menuStructure:

Public Member Functions
	writeMenuStructure ()
	deleteMenu ($menu_id=false, $plugin=false, $delete_critical_only=false)
	insertMenu ($menu_id=false, $parent_menu_id, $menu_name, $menu_link, $plugin, $menu_type, $extend=false, $new_window=false, $rank=false, $hide=false, $template_id=false, $alias=false, $layout=false, $params=false)
	getDelete ()
	createMenuId ($plugin_folder, $link)
Protected Attributes
	$rootMenuFamily
	$parentMenuFamily
	$databaseInsert
	$groupedMenuItems

---

Detailed Description

Class contains methods to calculate the structure and other elements of menu items, the methods are dependent of each other.

---

Member Function Documentation

createMenuId	(	$	plugin_folder,
		$	link
	)

Convert file location to unsigned CRC32 value. This is unique and allows one to locate a menu item from location as well.

Parameters:

string	The plugin folder the file is in.
string	Actual file link.

Returns:

integer

Author:

Jason Schoeman

deleteMenu	(	$	menu_id = false,
		$	plugin = false,
		$	delete_critical_only = false
	)

Completely delete a menu item and all its sub tables.

Parameters:

mixed	Menu id, or could be left out.
string	Plugin, or delete menu items by plugin which is always the folder the plugin lies in.
boolean	Checks if only critical menu data needs to be deleted while ignoring data like permissions etc.

getDelete

(

)

Deletes a menu item when the $_GET['dm'] variable is used.

Returns:

boolean

insertMenu	(	$	menu_id = false,
		$	parent_menu_id,
		$	menu_name,
		$	menu_link,
		$	plugin,
		$	menu_type,
		$	extend = false,
		$	new_window = false,
		$	rank = false,
		$	hide = false,
		$	template_id = false,
		$	alias = false,
		$	layout = false,
		$	params = false
	)

Insert a new menu item in database.

writeMenuStructure

(

)

Write generated structure to database.

Parameters:

integer

$menu_id

---

Field Documentation

$databaseInsert [protected]

$groupedMenuItems [protected]

$parentMenuFamily [protected]

$rootMenuFamily [protected]

---

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

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