Class menuitem

Description

Standard menu item. Takes a link object as the item in the menu.

Located in /menu-defs.php (line 139)

RenderableObject
   |
   --menuitem
Variable Summary
 mixed $highlighted
 mixed $label
 mixed $link
 mixed $menu_level
 mixed $parent_id
Method Summary
 menuitem menuitem (object $link, [boolean $highlighted = false], integer $parent_id, integer $menu_level)
 string html ()
 void set_font (string $font)
 string wml ()
Variables
mixed $highlighted = false (line 149)

True if menu item is highlighted

mixed $label = "" (line 144)

Label for this menu item

mixed $link (line 142)

Link object to associate with menu item

mixed $menu_level = 0 (line 155)

Menu level of this item

mixed $parent_id = 0 (line 152)

ID of parent menuitem of this menuitem

Methods
Constructor menuitem (line 165)

Constructor Creates the menu item object.

menuitem menuitem (object $link, [boolean $highlighted = false], integer $parent_id, integer $menu_level)
  • object $link: Link object to associate with menu item
  • boolean $highlighted: Whether item is highlighted or not
  • integer $parent_id: ID of parent menuitem (or 0 if none)
  • integer $menu_level: Level of this item (zero-based)
html (line 195)

This renders the field as HTML.

  • return: The field as HTML.
string html ()

Redefinition of:
RenderableObject::html()
Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.
set_font (line 177)

Set the menu item font

void set_font (string $font)
  • string $font: Font settings to apply to the menu item
wml (line 187)

This renders the field as WML.

  • return: The field as WML.
string wml ()

Redefinition of:
RenderableObject::wml()
Return output suitable for normal wap-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to wap devices.

Inherited Methods

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3