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( )
Methods inherited from LinksMenuElement
_assign(), get_image(), get_uid(), get_url(), set_image(), set_url()
Methods inherited from Menu
admin_display(), assign_common_template_variables(), check_auth(), enabled(), get_auth(), get_block(), get_block_position(), get_default_template(), get_filters(), get_formated_title(), get_id(), get_template_to_use(), get_title(), id(), is_enabled(), is_hidden_with_small_screens(), need_cached_string(), set_auth(), set_block(), set_block_position(), set_filters(), set_hidden_with_small_screens(), set_template(), set_title()
Constants summary
string LINKS_MENU__CLASS
# 'LinksMenu'
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'
Constants inherited from LinksMenuElement
LINKS_MENU_ELEMENT__CLASS, LINKS_MENU_ELEMENT__CLASSIC_DISPLAYING, LINKS_MENU_ELEMENT__FULL_DISPLAYING
Constants inherited from Menu
BLOCK_POSITION__ALL, BLOCK_POSITION__BOTTOM_CENTRAL, BLOCK_POSITION__FOOTER, BLOCK_POSITION__HEADER, BLOCK_POSITION__LEFT, BLOCK_POSITION__NOT_ENABLED, BLOCK_POSITION__RIGHT, BLOCK_POSITION__SUB_HEADER, BLOCK_POSITION__TOP_CENTRAL, BLOCK_POSITION__TOP_FOOTER, MENU_AUTH_BIT, MENU_ENABLED, MENU_ENABLE_OR_NOT, MENU_NOT_ENABLED, MENU__CLASS
Properties summary
public string $type

menu's type
#
public LinksMenuElement[] $elements

Direct menu children list
# array()
Properties inherited from LinksMenuElement
$depth, $image, $uid, $url
Properties inherited from Menu
$auth, $block, $enabled, $filters, $hidden_with_small_screens, $id, $position, $template, $title