Class menumaintainer

Description

Menu Maintainer

Located in /menumaint-defs.php (line 43)

RenderableObject
   |
   --StylableObject
      |
      --HTMLObject
         |
         --menumaintainer
Variable Summary
 mixed $active
 mixed $exists
 mixed $formname
 mixed $language
 mixed $lang_desc
 mixed $menuoptions
 mixed $menu_desc
 mixed $menu_id
 mixed $menu_level
 mixed $menu_name
 mixed $user_groups
Method Summary
 menumaintainer menumaintainer ([mixed $menuname = ""], integer $pid, [boolean $multilang = MULTILANG_DISABLED], string $id)
 void add_menuoption ()
 void delete ()
 boolean get ()
 string html ()
 void put ()
 void remove_menuoption (integer $id)
 string sitemap ()
Variables
mixed $active = true (line 63)

Menu active flag

mixed $edit_menuop_id (line 69)

The ID of the current menuoption being edited, if any

mixed $edit_parent_id = 0 (line 66)

The parent ID of the menu-options being edited

mixed $exists = false (line 75)

Whether this menu exists in the database

mixed $formname = "" (line 81)

The name of our form

mixed $language = 0 (line 48)

The language of the menu (0 = default)

mixed $lang_desc = "default" (line 50)

The name of the language of the menu

mixed $menuoptions = array() (line 78)

The array of menu options

mixed $menu_desc = "" (line 52)

The description of the menu

mixed $menu_id = false (line 57)

The ID of the menu

mixed $menu_level = 0 (line 72)

The level of the menu-options

mixed $menu_name = "" (line 46)

The name of the menu

mixed $user_groups = array() (line 60)

Array of groups allowed to access menu

Inherited Variables

Inherited from HTMLObject

HTMLObject::$accesskey
HTMLObject::$align
HTMLObject::$alt
HTMLObject::$bgcolor
HTMLObject::$bgurl
HTMLObject::$border
HTMLObject::$color
HTMLObject::$height
HTMLObject::$hspace
HTMLObject::$lang
HTMLObject::$langdir
HTMLObject::$linkover_text
HTMLObject::$name
HTMLObject::$onblur
HTMLObject::$onchange
HTMLObject::$onclick
HTMLObject::$ondblclick
HTMLObject::$onfocus
HTMLObject::$onkeydown
HTMLObject::$onkeypress
HTMLObject::$onkeyup
HTMLObject::$onload
HTMLObject::$onmousedown
HTMLObject::$onmousemove
HTMLObject::$onmouseout
HTMLObject::$onmouseover
HTMLObject::$onmouseup
HTMLObject::$onselect
HTMLObject::$size
HTMLObject::$src
HTMLObject::$tabindex
HTMLObject::$target
HTMLObject::$title
HTMLObject::$user_attributes
HTMLObject::$valign
HTMLObject::$vspace
HTMLObject::$width

Inherited from StylableObject

StylableObject::$class
StylableObject::$id
StylableObject::$style
Methods
Constructor menumaintainer (line 90)

Constructor Create a new menumaintainer.

menumaintainer menumaintainer ([mixed $menuname = ""], integer $pid, [boolean $multilang = MULTILANG_DISABLED], string $id)
  • string $id: The unique name/identity of the menu.
  • integer $pid: The optional id of a parent menuoption.
  • boolean $multilang: If true, offer multi-language options
add_menuoption (line 298)

This adds a new menuoption to the list, but does not add any records to the database.

void add_menuoption ()
delete (line 325)

Delete this menu from the database.

void delete ()
get (line 178)

Get the menu Retrieves the specified menu from database. If it doesn't exist then we create a new one.

  • return: True if the record was acquired successfully
boolean get ()
html (line 988)

Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.

  • return: The 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.
put (line 266)

Save this menu to the database. Create a new one if it doesn't already exist.

void put ()
remove_menuoption (line 313)

Remove menuoption from the menu. Just removes the given menuoption from the list in this object - no database changes are made.

void remove_menuoption (integer $id)
  • integer $id: The id of the menuoption to remove
sitemap (line 847)

Render the whole menu layout hierarchy as a sitemap, which simply gives links to each menu page.

  • return: The HTML
string sitemap ()

Inherited Methods

Inherited From HTMLObject

 HTMLObject::HTMLObject()
 HTMLObject::inherit_attributes()
 HTMLObject::setaccesskey()
 HTMLObject::setalign()
 HTMLObject::setalt()
 HTMLObject::setbackground()
 HTMLObject::setbgcolor()
 HTMLObject::setborder()
 HTMLObject::setcolor()
 HTMLObject::setheight()
 HTMLObject::sethspace()
 HTMLObject::setlang()
 HTMLObject::setlangdir()
 HTMLObject::setname()
 HTMLObject::setsize()
 HTMLObject::setsrc()
 HTMLObject::settabindex()
 HTMLObject::settarget()
 HTMLObject::settitle()
 HTMLObject::setvalign()
 HTMLObject::setvspace()
 HTMLObject::setwidth()
 HTMLObject::set_attribute()
 HTMLObject::set_linkover_text()
 HTMLObject::set_onblur()
 HTMLObject::set_onchange()
 HTMLObject::set_onclick()
 HTMLObject::set_ondblclick()
 HTMLObject::set_onfocus()
 HTMLObject::set_onkeydown()
 HTMLObject::set_onkeypress()
 HTMLObject::set_onkeyup()
 HTMLObject::set_onload()
 HTMLObject::set_onmousedown()
 HTMLObject::set_onmousemove()
 HTMLObject::set_onmouseout()
 HTMLObject::set_onmouseover()
 HTMLObject::set_onmouseup()
 HTMLObject::set_onselect()
 HTMLObject::set_tabindex()
 HTMLObject::taghtml()

Inherited From StylableObject

 StylableObject::StylableObject()
 StylableObject::clearstyle()
 StylableObject::setclass()
 StylableObject::setcss()
 StylableObject::setid()
 StylableObject::setstyle()

Inherited From RenderableObject

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

Documentation generated by phpDocumentor 1.3.0RC3