Class

Menu

Abstract Package: phpboost Author: Loic Rouchon <loic.rouchon@phpboost.com> Desc: This class represents a menu element and is used to build any kind of menu Located at phpboost/menu/Menu.class.php

Indirect known subclasses

LinksMenu, LinksMenuLink
Methods summary
public
# __construct( string $title )
public boolean
# need_cached_string( )
abstract public string
# display( )
public string
# admin_display( )
public
# id( integer $id )
protected
# _assign( Template $template )
protected
# assign_common_template_variables( Template $template )
public boolean
# check_auth( )
public
# set_title( string $title )
public
# set_auth( array $auth )
public
# enabled( boolean $enabled = Menu::MENU_ENABLED )
public integer
# set_block( mixed $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( )
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__LEFT 7
#
integer BLOCK_POSITION__RIGHT 8
#
integer BLOCK_POSITION__ALL 9
#
Properties summary
public integer $id 0
#

the element identifier, only used by the service

public string $title ''
#

the Menu title

public int[string] $auth null
#

Represents the Menu authorisations array

public boolean $enabled Menu::MENU_NOT_ENABLED
#

true if the Menu is used

public integer $block Menu::BLOCK_POSITION__NOT_ENABLED
#

The Menu block position

public integer $position -1
#

The Menu position on the website

protected boolean $hidden_with_small_screens false
#

menu hidden or not with small screens

public Array<Filter> $filters array()
#

The filter list

protected Template $template null
#

the template of the menu