Class menuoption

Description

The menuoption is a class which contains the properties of a single option on a menu.

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

RenderableObject
   |
   --menuoption
Variable Summary
 mixed $action
 mixed $active
 mixed $auth_code
 mixed $description
 mixed $exists
 mixed $height
 mixed $is_parent
 mixed $label
 mixed $menu_id
 mixed $menu_level
 mixed $parent_id
 mixed $sitepage
 mixed $user_groups
 mixed $user_type
 mixed $width
Method Summary
 menuoption menuoption ([string $id = NEW_MENUOPTION])
 void delete ()
 void get (string $id)
 void put ()
 void syncparms ()
Variables
mixed $action = "" (line 730)

Internal field which combines the sitepage

mixed $active = true (line 742)

Whether menuoption is active (displayed)

mixed $auth_code = false (line 739)

Whether to apply auth code

mixed $description = "(new item)" (line 697)

Menu option descriptive text

mixed $display_order = 0 (line 726)

Order of display

mixed $exists = false (line 708)

Whether menuoption exists in database

mixed $height = 18 (line 703)

Height of option in pixels

mixed $is_parent = false (line 748)

True if this menu option is the parent of sub-menu options

mixed $label = "(new item)" (line 695)

Menuoption displayed label

mixed $last_modified (line 745)

When menu option was last modified (datetime)

mixed $menuoptionid (line 711)

menuoption ID

mixed $menu_id (line 714)

menu ID the option belongs to

mixed $menu_level = 0 (line 699)

Menu option level

mixed $parent_id = 0 (line 717)

Parent ID of this menu option

mixed $sitepage = MENU_ITEM_SUBMENU (line 733)

Target site webpage when clicked

mixed $sitepage_parms = "" (line 736)

Paramter string to pass on webpage URL

mixed $user_groups = array() (line 720)

Array of user groups allowed to access this menuoption

mixed $user_type = "" (line 723)

User type restriction

mixed $width = 100 (line 701)

Width of option in pixels

Methods
Constructor menuoption (line 755)

Constructor Create a new menuoption object.

menuoption menuoption ([string $id = NEW_MENUOPTION])
  • string $id: The unique identity of the menuoption.
delete (line 882)

Delete the menuoption.

Delete this menuoption from the database.

void delete ()
get (line 765)

Get the menuoption.

Retrieves the specified menuoption from database.

void get (string $id)
  • string $id: The unique integer identity of the menuoption to get.
put (line 831)

Save the menuoption.

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

void put ()
syncparms (line 806)

Synchronise sitepage parameters with manually edited values. This

check ensures that if people have added stuff directly into the ax_menuoption.action table field, we pick it up and sync it to our sitepage_parms field. However this only occurs if there is nothing defined in the sitepage_parms field.

void syncparms ()

Inherited Methods

Inherited From RenderableObject

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

Documentation generated by phpDocumentor 1.3.0RC3