User Tools

Site Tools


Sidebar

Dokumentation

vortex:apidoc:menu

Menu

Menu

Filename : /classes/display/menu.php
Extends :

Description

Handles the menu creation and displaying

Fields

Methods

__construct( &$display )

Definition : public function __construct( &$display )

Returns :

Description
Assigns the display to show the menu on, and instantiates the Menu

Parameters

$display

Type : Display
Default value :

Description
Display to use

display()

Definition : public function display()

Returns : boolean - false on error, otherwise true

Description
Display the menu on the given Display

Parameters

getIcon( $icon )

Definition : public static function getIcon( $icon )

Returns : String

Description
Get the path to the icon file, if found in the Vortex or DBI/public path.

Parameters

$icon

Type : String
Default value :

Description
The filename of the icon to search for

setShow( $show )

Definition : public function setShow( $show )

Returns :

Description
Set whether to show the menu

Parameters

$show

Type : boolean
Default value :

Description
True will show the menu, false will hide it

vortex/apidoc/menu.txt · Last modified: 2019/06/28 07:09 by hubbe