Class

LinksMenu

Package: PHPBoost\Menu\links Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Regis VIARRE crowkait@phpboost.com Version: PHPBoost 5.2 - last update: 2016 10 24 Since: PHPBoost 2.0 - 2008 07 08 Contributor: Loic ROUCHON horn@phpboost.com Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: phpboost/menu/links/LinksMenu.class.php

Create a Menu with children. Children could be Menu or LinksMenuLink objects

Menu
Extended by LinksMenuElement
Extended by LinksMenu
Methods summary
public
# __construct( string $title, string $url, string $image = '', string $type = self::AUTOMATIC_MENU, integer $id,… )

Constructor

public
# add_array( LinksMenuElement[] $menu_elements )

Add a list of LinksMenu or (sub)Menu to the current one

public
# add( LinksMenuElement $element )

Add a single LinksMenuLink or (sub) Menu

public
# update_uid( )

Update the menu uid

public string
# display( Template $template = false, $mode = LinksMenuElement::LINKS_MENU_ELEMENT__CLASSIC_DISPLAYING )

Display the menu

public string
# cache_export( $template = false )
public static string[]
# get_menu_types_list( )

static method which returns all the menu types

protected
# _parent( string $type )

Increase the Menu Depth and set the menu type to its parent one

public string
# get_type( )
public
# set_type( string $type )

Sets the type of the menu

public LinksMenuElement[]
# get_children( )
Constants summary
string AUTOMATIC_MENU
# 'automatic'
string VERTICAL_MENU
# 'vertical'
string HORIZONTAL_MENU
# 'horizontal'
string STATIC_MENU
# 'static'
string VERTICAL_SCROLLING_MENU
# 'vertical_scrolling'
string HORIZONTAL_SCROLLING_MENU
# 'horizontal_scrolling'
Properties summary
public string $type

menu's type

#
public LinksMenuElement[] $elements

Direct menu children list

# array()