Docs For Class menu

Description

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

Located in /plugins/PHPDevShell/includes/menu_structure.class.php (line 19)

Method Summary

integer create_menu_id (string $plugin_folder, string $link)

void delete_menu ([mixed $menu_id = false], [string $plugin = false], [boolean $delete_critical_only = false])

boolean get_delete ()

void insert_menu ([ $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])

void write_menu_structure (integer $menu_id)

Methods

create_menu_id (line 374)

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

author: Jason Schoeman
access: public

integer create_menu_id (string $plugin_folder, string $link)

string $plugin_folder: The plugin folder the file is in.
string $link: Actual file link.

delete_menu (line 177)

Completely delete a menu item and all its sub tables.

access: public

void delete_menu ([mixed $menu_id = false], [string $plugin = false], [boolean $delete_critical_only = false])

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

get_delete (line 334)

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

access: public

boolean get_delete ()

insert_menu (line 306)

Insert a new menu item in database.

access: public

void insert_menu ([ $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])

$menu_id
$parent_menu_id
$menu_name
$menu_link
$plugin
$menu_type
$extend
$new_window
$rank
$hide
$template_id

write_menu_structure (line 129)

Write generated structure to database.

access: public

void write_menu_structure (integer $menu_id)

integer $menu_id