Docs For Class Menu

Description

Class used for handling Menus.

For currently used Text/Num/Date fields, see Item.php.

version: $Id: Menu.php,v 1.10 2006/11/26 22:03:59 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

MasterItemType
   |
   --Itemtype
      |
      --Item
         |
         --Menu

Method Summary

Menu Menu ([int $id = null], [String $treetype = ITEM_LOAD_FULL], [String $languageID = ''])

Layout getLayout ()

String getLayoutName ()

Modul getModul ()

String getModulID ()

Menu getParent ()

void isRoot ()

Methods

Constructor Menu (line 53)

Instantiates a MenuService representing the given Menu ID.

If you pass null as ID the Object will not be initialized but only instantiated.

Menu Menu ([int $id = null], [String $treetype = ITEM_LOAD_FULL], [String $languageID = ''])

int $id: the Menu ID or null
String $treetype: the treetype
String $languageID: the Language ID

getLayout (line 92)

Returns the layout defined for this Menu.

return: the Layout of this Menu

Layout getLayout ()

getLayoutName (line 72)

Gets the Layout Name for this Menu.

return: the Layout Name

String getLayoutName ()

getModul (line 82)

Gets the Modul that is linked to this Menu.

return: the Modul for this Menu

Modul getModul ()

getModulID (line 63)

Gets the Modul ID for the current Menu.

return: the Modul ID

String getModulID ()

getParent (line 102)

Gets a Menu instance that holds all information about the Parent MenuEntry.

return: the Parent of this Menu

Menu getParent ()

isRoot (line 110)

Checks whether this is the Root Menu or not.

void isRoot ()

Inherited Methods

Inherited From Item

Item::Item()
Item::exists()
Item::getCatchwords()
Item::getChilds()
Item::getContent()
Item::getCreateByID()
Item::getCreateDate()
Item::getDescription()
Item::getFullURL()
Item::getID()
Item::getItemDate()
Item::getItemNum()
Item::getItemText()
Item::getItemType()
Item::getLanguageID()
Item::getLastByID()
Item::getLastDate()
Item::getMimetype()
Item::getName()
Item::getOriginalName()
Item::getParentID()
Item::getPosition()
Item::getSize()
Item::getURL()
Item::getValidFrom()
Item::getValidTo()
Item::getWorkflowName()
Item::hasChilds()
Item::isHidden()
Item::isInTrash()
Item::lastModified()
Item::toString()

Inherited From Itemtype

Itemtype::Itemtype()
Itemtype::getClass()
Itemtype::getClassName()
Itemtype::getCommand()
Itemtype::getDirectory()
Itemtype::getItemtypeID()
Itemtype::initItemtype()

Inherited From MasterItemType

MasterItemType::MasterItemType()
MasterItemType::countItemtypes()
MasterItemType::getClassForItemType()
MasterItemType::getClassNameForItemType()
MasterItemType::getCommandForItemType()
MasterItemType::getDirectoryForItemType()
MasterItemType::getItemTypeForCommand()
MasterItemType::getSelectColumns()