Class Menu

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

Menu Create, modify and display menus. Each menu item is defined by

 - $id   : identifier of the menu item
 - $link : URL, relative to the admidio root directory, starting with a /
           or full URL with http or https protocol
 - $text : menu text
 - $icon : URL, relative to the theme plugin, starting with a /
         : or full URL with http or https protocol
 - $desc : (optional) long description of the menu item

Located at menu.php

Methods summary

`public`	# `__construct( string $id, string $title )` constructor constructor Parameters `$id` `$title`
`private array<string,string\|array>`	# `mkItem( string $id, string $link, string $text, string $icon, string $desc = '' )` Parameters `$id` `$link` `$text` `$icon` `$desc` Returns array<string,string\|array>
`public`	# `addItem( string $id, string $link, string $text, string $icon, string $desc = '' )` Parameters `$id` `$link` `$text` `$icon` `$desc`
`public`	# `addSubItem( string $parentId, string $id, string $link, string $text )` Parameters `$parentId` `$id` `$link` `$text`
`public integer\|false`	# `getPosition( string $id )` gets the position of a given ID in the menu gets the position of a given ID in the menu Parameters `$id` Returns integer\|false
`public`	# `insertItem( integer $position, string $id, string $link, string $text, string $icon, string $desc = '' )` inserts a new menu entry before the named position inserts a new menu entry before the named position Parameters `$position` `$id` `$link` `$text` `$icon` `$desc`
`public string`	# `show( boolean $complex = false )` Create the html menu from the internal array that must be filled before. You have the option to create a simple menu with icon and link or a more complex menu with submenu and description text. Create the html menu from the internal array that must be filled before. You have the option to create a simple menu with icon and link or a more complex menu with submenu and description text. Parameters `$complex` Create a @b simple menu as default. If you set the param to @b true then you will create a menu with submenus and description Returns string Return the html code of the form.

Properties summary

`protected`	`$id`	#
`protected`	`$title`	#
`protected`	`$items`	#
`protected`	`$root_path`	#

Packages

Classes

Exceptions

Functions

Class Menu

Methods summary

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Properties summary