Docs For Class mosMenuHandler

Description

Menu handler

Located in /includes/core.classes.php (line 1318)

Variable Summary

array $_byParentOrder

array $_counts

array $_idlinks

array $_menus

Method Summary

mosMenuHandler mosMenuHandler ()

unknown getBestQueryMatch ()

unknown &getByParentOrder (unknown_type $Itemid, unknown_type $menutype, [unknown_type $maxaccess = 0], [unknown_type $noparent = false])

unknown getContentItemid (unknown_type $Itemid, unknown_type $type, unknown_type $id, [unknown_type $catid = 0])

unknown getGlobalBlogSectionCount ()

unknown getIDByTypeCid (unknown_type $type, unknown_type $componentid)

unknown getIDByTypeLink (unknown_type $type, unknown_type $link)

unknown getIDLikeLink (unknown_type $link)

void &getInstance ()

unknown &getMenuByID (unknown_type $id)

unknown getMenuCount (unknown_type $type, unknown_type $published)

unknown &getMenusByType (unknown_type $types)

unknown &getMenuTypes ()

unknown &maxAccessLink (unknown_type $link)

boolean menuCheck (int $Itemid, string $menu_option, int $task, database $gid)

unknown mosGetMenuLink ( &$mitem, [unknown_type $level = 0], &$params, unknown_type $Itemid, unknown_type $mitem, unknown_type $params)

void mosRecurseVIMenu ( $id, $level, &$children, &$open, &$indents, &$params)

void mosShowHFMenu ( &$params, [ $style = 0])

void mosShowVIMenu ( &$params)

void setPathway (unknown_type $Itemid)

Variables

array $_byParentOrder = null (line 1326)

var: Items that may be useful for setting Itemid

array $_counts = null (line 1322)

var: Counts of menu items by type and published status

array $_idlinks = null (line 1324)

var: Access to stored menu objects by ID

array $_menus = null (line 1320)

var: Menu objects currently available

Methods

Constructor mosMenuHandler (line 1331)

Constructor

mosMenuHandler mosMenuHandler ()

getBestQueryMatch (line 1497)

Enter description here...

unknown getBestQueryMatch ()

getByParentOrder (line 1545)

Enter description here...

unknown &getByParentOrder (unknown_type $Itemid, unknown_type $menutype, [unknown_type $maxaccess = 0], [unknown_type $noparent = false])

unknown_type $Itemid
unknown_type $menutype
unknown_type $maxaccess
unknown_type $noparent

getContentItemid (line 1477)

Enter description here...

unknown getContentItemid (unknown_type $Itemid, unknown_type $type, unknown_type $id, [unknown_type $catid = 0])

unknown_type $Itemid
unknown_type $type
unknown_type $id
unknown_type $catid

getGlobalBlogSectionCount (line 1460)

Enter description here...

unknown getGlobalBlogSectionCount ()

getIDByTypeCid (line 1448)

Enter description here...

unknown getIDByTypeCid (unknown_type $type, unknown_type $componentid)

unknown_type $type
unknown_type $componentid

getIDByTypeLink (line 1419)

Enter description here...

unknown getIDByTypeLink (unknown_type $type, unknown_type $link)

unknown_type $type
unknown_type $link

getIDLikeLink (line 1432)

Enter description here...

unknown getIDLikeLink (unknown_type $link)

unknown_type $link

getInstance (line 1350)

Singleton accessor

void &getInstance ()

getMenuByID (line 1362)

Enter description here...

unknown &getMenuByID (unknown_type $id)

unknown_type $id

getMenuCount (line 1378)

Enter description here...

unknown getMenuCount (unknown_type $type, unknown_type $published)

unknown_type $type
unknown_type $published

getMenusByType (line 1389)

Enter description here...

unknown &getMenusByType (unknown_type $types)

unknown_type $types

getMenuTypes (line 1403)

Enter description here...

unknown &getMenuTypes ()

maxAccessLink (line 1524)

Enter description here...

unknown &maxAccessLink (unknown_type $link)

unknown_type $link

menuCheck (line 1587)

Checks whether a menu option is within the users access level

return: True if the visitor's group at least equal to the menu access

boolean menuCheck (int $Itemid, string $menu_option, int $task, database $gid)

int $Itemid: Item id number
string $menu_option: The menu option
int $task: The users group ID number
database $gid: A database connector object

mosGetMenuLink (line 1619)

Enter description here...

unknown mosGetMenuLink ( &$mitem, [unknown_type $level = 0], &$params, unknown_type $Itemid, unknown_type $mitem, unknown_type $params)

unknown_type $mitem
unknown_type $level
unknown_type $params
unknown_type $Itemid
&$mitem
&$params

mosRecurseVIMenu (line 1757)

Utility function to recursively work through a vertically indented

hierarchial menu

void mosRecurseVIMenu ( $id, $level, &$children, &$open, &$indents, &$params)

$id
$level
&$children
&$open
&$indents
&$params

mosShowHFMenu (line 1776)

Draws a horizontal 'flat' style menu (very simple case)

void mosShowHFMenu ( &$params, [ $style = 0])

&$params
$style

mosShowVIMenu (line 1690)

Vertically Indented Menu

void mosShowVIMenu ( &$params)

&$params

setPathway (line 1570)

Enter description here...

void setPathway (unknown_type $Itemid)

unknown_type $Itemid