Class

Menu

Abstract Package: PHPBoost\Menu Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Loic ROUCHON horn@phpboost.com Version: PHPBoost 5.2 - last update: 2016 07 26 Since: PHPBoost 2.0 - 2008 11 15 Contributor: Julien BRISWALTER j1.seth@phpboost.com Located at: phpboost/menu/Menu.class.php

This class represents a menu element and is used to build any kind of menu

Indirect known subclasses
LinksMenu, LinksMenuLink
Methods summary
public
# __construct( string $title, integer $id,… )

Build a Menu element.
public boolean
# need_cached_string( )

Check if the menu needs to be cached
abstract public string
# display( )

Display the menu
public string
# admin_display( )

Display the menu admin gui
public
# id( integer $id )
protected
# _assign( Template $template )

Assign tpl vars
protected
# assign_common_template_variables( Template $template )

Assign default tpl vars
public boolean
# check_auth( )

Check the user authorization to see the LinksMenuElement
public
# set_title( string $title )
public
# set_auth( array $auth )
public
# enabled( boolean $enabled = self::MENU_ENABLED )
public integer
# set_block( $block )
public
# set_block_position( integer $position )
public
public string
# get_formated_title( )
public string
# get_title( )
public array
# get_auth( )
public integer
# get_id( )
public integer
# get_block( )
public integer
# get_block_position( )
public boolean
# is_enabled( )
public boolean
# is_hidden_with_small_screens( )
public string
# get_filters( )
public
# set_filters( Array<Filter> $filters )

Sets the filters of the menu
public
# set_template( Template $template )

Sets the template of the menu
protected Template
protected string
# get_default_template( )

Get the default template of the menu
Constants summary
integer BLOCK_POSITION__NOT_ENABLED
# 0
integer BLOCK_POSITION__HEADER
# 1
integer BLOCK_POSITION__SUB_HEADER
# 2
integer BLOCK_POSITION__TOP_CENTRAL
# 3
integer BLOCK_POSITION__BOTTOM_CENTRAL
# 4
integer BLOCK_POSITION__TOP_FOOTER
# 5
integer BLOCK_POSITION__FOOTER
# 6
integer BLOCK_POSITION__LEFT
# 7
integer BLOCK_POSITION__RIGHT
# 8
integer BLOCK_POSITION__ALL
# 9
string MENU__CLASS
# 'Menu'
Properties summary
public integer $id

the element identifier, only used by the service
# 0
public string $title

the Menu title
# ''
public int[string] $auth

Represents the Menu authorisations array
# null
public boolean $enabled

true if the Menu is used
# self::MENU_NOT_ENABLED
public integer $block

The Menu block position
# self::BLOCK_POSITION__NOT_ENABLED
public integer $position

The Menu position on the website
# -1
protected boolean $hidden_with_small_screens

menu hidden or not with small screens
# false
public Array<Filter> $filters

The filter list
# array()
protected Template $template

the template of the menu
# null