LimeSurvey API - Master branch

MenuButton extends Menu
in package
implements MenuButtonInterface

Table of Contents

Interfaces

MenuButtonInterface
Interface descriptions here: https://manual.limesurvey.org/Extra_menus_event

Properties

$buttonClass  : string
$buttonId  : string
$href  : string
$iconClass  : string
Font-awesome icon class.
$isDropDown  : bool
If true, render this menu as a dropdown.
$isInMiddleSection  : bool
Added option because we split the menu into two sections for LS6 If true, render this menu in the middle section. False would render it in the right section
$isPrepended  : bool
If true, render this menu before the main menu.
$label  : string
$menuItems  : array<string|int, MenuItem>
$onClick  : string
$openInNewTab  : bool
$tooltip  : string

Methods

__construct()  : void
getButtonClass()  : string
getButtonId()  : mixed
getHref()  : string
getIconClass()  : string
getLabel()  : string
Returns the label string.
getMenuItems()  : array<string|int, MenuItem>
getOnClick()  : string
getOpenInNewTab()  : bool
getTooltip()  : string
isButton()  : bool
isDropDown()  : bool
isInMiddleSection()  : bool
isPrepended()  : bool

Properties

$buttonClass

protected string $buttonClass = "btn btn-primary"

$href

protected string $href = "#"

$iconClass

Font-awesome icon class.

protected string $iconClass = ""

$isDropDown

If true, render this menu as a dropdown.

protected bool $isDropDown = false

$isInMiddleSection

Added option because we split the menu into two sections for LS6 If true, render this menu in the middle section. False would render it in the right section

protected bool $isInMiddleSection = true

$isPrepended

If true, render this menu before the main menu.

protected bool $isPrepended = false

$label

protected string $label = "Missing label"

$menuItems

protected array<string|int, MenuItem> $menuItems = []

$onClick

protected string $onClick = ""

$openInNewTab

protected bool $openInNewTab = false

$tooltip

protected string $tooltip = ""

Methods

__construct()

public __construct(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>
  • Options for either dropdown menu or plain link

getButtonClass()

public getButtonClass() : string
Return values
string

getHref()

public getHref() : string
Return values
string

getIconClass()

public getIconClass() : string
Return values
string

getLabel()

Returns the label string.

public getLabel() : string

if a iconClass is set it will be put before the label

Return values
string

getMenuItems()

public getMenuItems() : array<string|int, MenuItem>
Return values
array<string|int, MenuItem>

getOnClick()

public getOnClick() : string
Return values
string

getOpenInNewTab()

public getOpenInNewTab() : bool
Return values
bool

getTooltip()

public getTooltip() : string
Return values
string

isButton()

public isButton() : bool
Return values
bool

isDropDown()

public isDropDown() : bool
Return values
bool

isInMiddleSection()

public isInMiddleSection() : bool
Return values
bool

isPrepended()

public isPrepended() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results