Class navigation

Description

This class extracts and organizes the main menus from the database and displayes it to the user. Shows only where permissions apply.

This is the complete menu extraction class.

  • author: Jason Schoeman
  • version: 1.0.2 (greg)
  • deprecated:

Located in /legacy/navigation.class.php (line 20)

PHPDS_dependant
   |
   --navigation
Direct descendents
Class Description
PHPDS_navigation
Method Summary
void call_family ([int $menu_id = false])
integer create_menu_id (string $path)
string determine_menu_name ([string $replacement_name = false], string $menu_link, [int $menu_id = false])
string generic_button ( $name, [string $url = false])
string load_page ([integer $menu_id = false], [string $extend_url = ''], [boolean $strip_trail = ''])
string self_url ([string $extra_get_variables = false])
void show_menu (integer $hide_type, [integer $menu_id = false])
string write_menu ()
Variables
Methods
call_family (line 87)

Assists write_menu in calling menu children.

  • access: public
void call_family ([int $menu_id = false])
  • int $menu_id
create_menu_id (line 199)

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

  • author: Jason Schoeman
  • deprecated: use createMenuId
  • access: public
integer create_menu_id (string $path)
  • string $path: The plugin folder the file is in.
determine_menu_name (line 30)

Determines what the menu item should be named.

  • access: public
string determine_menu_name ([string $replacement_name = false], string $menu_link, [int $menu_id = false])
  • string $replacement_name
  • string $menu_link
  • int $menu_id
generate_history_tree (line 119)

This method compiles the history tree seen, this is the tree that the user sees expand when going deeper into menu levels.

On the default template this is the navigation link string top left above the menus.

  • access: public
string generate_history_tree ()
generic_button (line 272)

Creates a link that looks like all the other submit buttons.

  • deprecated:
  • access: public
string generic_button ( $name, [string $url = false])
  • string $url
  • $name
load_page (line 216)

Returns the correct string for use in href when creating a link for a menu id. Will return sef url if possible.

Will return self url when no menu id is given. No starting & or ? is needed, this gets auto determined! If left empty it will return current active menu.

  • author: Jason Schoeman
  • deprecated:
  • access: public
string load_page ([integer $menu_id = false], [string $extend_url = ''], [boolean $strip_trail = ''])
  • integer $menu_id: The menu id to load.
  • string $extend_url: extend_url
  • boolean $strip_trail: strip_trail Will strip unwanted empty operators at the end.
self_url (line 259)

This method saves the current URL with the option to add more $this->security->get variables like ("&variable1=1&variable2=2") This is mostly used for when additional $this->security->get variables are required! Usefull when using forms.

  • author: Jason Schoeman
  • deprecated: This method is not needed anymore.
  • access: public
string self_url ([string $extra_get_variables = false])
  • string $extra_get_variables: Add more $this->security->get variables like ("&variable1=1&variable2=2")
show_menu (line 186)

Returns true if menu should show.

  • deprecated:
  • access: public
void show_menu (integer $hide_type, [integer $menu_id = false])
  • integer $hide_type
  • integer $menu_id
write_menu (line 41)

Compiles menu items in order.

  • author: Jason Schoeman
  • access: public
string write_menu ()

Inherited Methods

Inherited From PHPDS_dependant

PHPDS_dependant::__construct()
PHPDS_dependant::construct()
PHPDS_dependant::debugInstance()
PHPDS_dependant::factory()
PHPDS_dependant::factoryWith()
PHPDS_dependant::info()
PHPDS_dependant::log()
PHPDS_dependant::PHPDS_dependance()
PHPDS_dependant::_log()
PHPDS_dependant::__call()
PHPDS_dependant::__get()
PHPDS_dependant::__set()

Documentation generated on Tue, 09 Aug 2011 09:05:00 +0200 by phpDocumentor 1.4.3