Class humhub\widgets\FooterMenu

Inheritancehumhub\widgets\FooterMenu » humhub\widgets\BaseMenu » yii\base\Widget
Available since version1.2.6

FooterMenu displays a footer navigation for pages e.g. Imprint

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$id string Dom element id humhub\widgets\FooterMenu
$itemGroups array Of item groups humhub\widgets\BaseMenu
$items array Of items humhub\widgets\BaseMenu
$location string Location of footer menu (e.g. login, mail, sidebar) humhub\widgets\FooterMenu
$template string Template file humhub\widgets\FooterMenu
$type string Type of the navigation, optional for identifing. humhub\widgets\BaseMenu

Public Methods

Hide inherited methods

MethodDescriptionDefined By
addItem() Adds new Item to the menu humhub\widgets\BaseMenu
addItemGroup() Adds new Item Group to the menu humhub\widgets\BaseMenu
deleteItemByUrl() Removes Item by URL humhub\widgets\BaseMenu
getActive() humhub\widgets\BaseMenu
getItemGroups() Returns all Item Groups humhub\widgets\BaseMenu
getItems() Returns Items of this Navigation humhub\widgets\BaseMenu
init() Initializes the navigation widget. humhub\widgets\FooterMenu
markAsActive() Add the active class from a menue item. humhub\widgets\BaseMenu
markAsInactive() Remove the active class from a menue item. humhub\widgets\BaseMenu
run() Executes the Menu Widget humhub\widgets\FooterMenu
setActive() Activates the menu item with the given url humhub\widgets\BaseMenu
setInactive() humhub\widgets\BaseMenu
setViewState() This function is used in combination with pjax to get sure the required menu is active humhub\widgets\BaseMenu

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
EVENT_INIT 'init' humhub\widgets\BaseMenu
EVENT_RUN 'run' humhub\widgets\BaseMenu
LOCATION_ACCOUNT_MENU 'account_menu' humhub\widgets\FooterMenu
LOCATION_EMAIL 'mail' humhub\widgets\FooterMenu
LOCATION_FULL_PAGE 'full' humhub\widgets\FooterMenu
LOCATION_LOGIN 'login' humhub\widgets\FooterMenu
LOCATION_SIDEBAR 'sidebar' humhub\widgets\FooterMenu

Property Details

$id public property

Dom element id

public string $id 'footer-menu-nav'
$location public property

Location of footer menu (e.g. login, mail, sidebar)

public string $location 'full'
$template public property

Template file

public string $template 'footerNavigation'

Method Details

init() public method

Initializes the navigation widget.

This method mainly normalizes the {@link items} property. If this method is overridden, make sure the parent implementation is invoked.

public void init ( )
run() public method

Executes the Menu Widget

public void run ( )