RMBreadCrumb Class Reference

Public Member Functions
	add_crumb ($caption, $link='', $icon='', $menu=array())
	add_menu ($id, $caption, $link, $icon='')
	clear ()
	construct ()
	get ()
	render ()

Private Attributes
	$crumbs = array()

Detailed Description

This class allow to manage a breadcrumb navigation for modules and other components

Definition at line 16 of file breadcrumb.php.

Member Function Documentation

RMBreadCrumb::add_crumb	(		$caption,
			$link = '',
			$icon = '',
			$menu = array()
	)

Add a new crumb to the crumbs

You can add new items to the crumbs array. A crumb must contain a caption text, the link that this item will follow and, optionally, an icon and a submenu.

Parameters

string	Caption text
string	Link address
string	Icon url for this item
array	Submenu for this item. This paramter must be passed as array containing caption, link and [icon]

Returns

int Id for item

Definition at line 50 of file breadcrumb.php.

RMBreadCrumb::add_menu	(		$id,
			$caption,
			$link,
			$icon = ''
	)

Add a submenu to an existing crumb

Parameters

string	Caption text
string	Link address
string	Icon url for this item

Definition at line 73 of file breadcrumb.php.

References $id.

RMBreadCrumb::clear

(

)

Clear the crumbs array

Definition at line 90 of file breadcrumb.php.

RMBreadCrumb::construct

(

)

Definition at line 20 of file breadcrumb.php.

RMBreadCrumb::get

(

)

Singleton

Definition at line 27 of file breadcrumb.php.

Referenced by smarty_function_breadcrumb().

Here is the caller graph for this function:

RMBreadCrumb::render

(

)

Render the current crumbs array

Returns

string

Definition at line 99 of file breadcrumb.php.

References $ret, and RMTemplate\get().

Here is the call graph for this function:

Member Data Documentation

RMBreadCrumb::$crumbs = array()

private

Definition at line 18 of file breadcrumb.php.

---

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

• L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/breadcrumb.php