Package DE_EPAGES::Presentation::API::Object::Menu
object interface for Menu.
Base |
DE_EPAGES::Object::API::Object::DALObject |
Functions
- action
- baseMenu
- className
- dbPackage
- derivedMenus
- directSubMenus
- id
- insertSubMenu
- pageType
- parentMenu
- primaryKey
- set
- subMenus
- templateName
action
Returns the action of the menu or undef if the menu has no action.
Syntax |
$Action = $Menu->action; |
Return |
|
baseMenu
Returns the base menu of this menu or undef if the menu has no base menu.
Syntax |
$BaseMenu = $Menu->baseMenu; |
Return |
|
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $Menu->className; |
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
$DbPackage = $Menu->dbPackage; |
Return |
|
derivedMenus
Returns the direct derived menus of this menu ordered by position.
Syntax |
$aDerivedMenus = $Menu->derivedMenus; |
Return |
|
directSubMenus
Returns the direct sub menus of this menu ordered by position.
Syntax |
$aSubMenus = $Menu->directSubMenus; |
Return |
|
id
Returns the Menu id.
Syntax |
$MenuID = $Menu->id; |
Return |
|
insertSubMenu
Inserts a new sub menu into the database.
Syntax |
$SubMenu = $Menu->insertSubMenu( $hMenu ); |
Input |
|
Return |
|
pageType
Returns the page type of the menu.
Syntax |
$PageType = $Menu->pageType; |
Return |
|
parentMenu
Returns the parent menu of this menu or undef if the menu has no parent.
Syntax |
$ParentMenu = $Menu->parentMenu; |
Return |
|
primaryKey
Returns the name of the primary key.
Syntax |
$PrimaryKey = $Menu->primaryKey; |
Return |
|
set
Sets the given attribute values on the object.
Syntax |
$Object->set($hValues, $LanguageID); |
Input |
|
subMenus
Returns the sub menus of this menu ordered by position. If the menu has a base menu, then it inherits all sub menus of the base menu, but it can override the positions and actions and add additional sub menus.
Syntax |
$aSubMenus = $Menu->subMenus; |
Return |
|
templateName
obsolete. Use $Menu->get('Template') or $Menu->get('Name') instead.
Syntax |
$Template = $Menu->templateName; |
Return |
|