Class LinksMenu

__construct()

__construct(string $title, string $url, string $image = '', string $type = self::AUTOMATIC_MENU) 

Constructor

Parameters

string	$title	Menu title
string	$url	Destination url
string	$image	Menu's image url relative to the website root or absolute
string	$type	Menu's type

• Inherited from \LinksMenu

Tags

None found

set_image()

set_image(string $image) 

Parameters

string

$image

the value to set

• Inherited from \LinksMenuElement

Tags

None found

set_url()

set_url(string $url) 

Parameters

string

$url

the value to set

• Inherited from \LinksMenuElement

Tags

None found

get_uid()

get_uid() : integer

Returns the menu uid

Returns

integer —

the menu uid

• Inherited from \LinksMenuElement

Tags

None found

update_uid()

update_uid() 

Update the menu uid

• Inherited from \LinksMenu

Tags

None found

get_url()

get_url(boolean $compute_relative_url = true) : string

Parameters

boolean

$compute_relative_url

If true, computes relative urls to the website root

Returns

string —

the link $url

• Inherited from \LinksMenuElement

Tags

None found

get_image()

get_image(boolean $compute_relative_url = true) : string

Parameters

boolean

$compute_relative_url

If true, computes relative urls to the website root

Returns

string —

the $image url

• Inherited from \LinksMenuElement

Tags

None found

need_cached_string()

need_cached_string() : boolean

Check if the menu needs to be cached

Returns

boolean —

true if the menu need to be cached

• Inherited from \Menu

Tags

None found

display()

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

Display the menu

Parameters

\Template	$template	the template to use
	$mode

Returns

string —

the menu parsed in xHTML

• Inherited from \LinksMenu

Tags

None found

admin_display()

admin_display() : string

Display the menu admin gui

Returns

string —

the menu parsed in xHTML

• Inherited from \Menu

Tags

None found

id()

id(integer $id) 

Parameters

integer

$id

Set the Menu database id

• Inherited from \Menu

Tags

None found

check_auth()

check_auth() : boolean

Check the user authorization to see the LinksMenuElement

Returns

boolean —

true if the user is authorised, false otherwise

• Inherited from \Menu

Tags

None found

set_title()

set_title( $title) 

Parameters

$title

• Inherited from \Menu

Tags

None found

set_auth()

set_auth( $auth) 

Parameters

$auth

• Inherited from \Menu

Tags

None found

enabled()

enabled(boolean $enabled = self::MENU_ENABLED) 

Parameters

boolean

$enabled

Enable or not the Menu

• Inherited from \Menu

Tags

None found

set_block()

set_block( $block) : integer

Parameters

$block

Returns

integer —

the Menu $block position

• Inherited from \Menu

Tags

None found

set_block_position()

set_block_position(integer $position) 

Parameters

integer

$position

the Menu position to set

• Inherited from \Menu

Tags

None found

set_hidden_with_small_screens()

set_hidden_with_small_screens( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

set_disabled_body()

set_disabled_body( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

set_pushed_content()

set_pushed_content( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

set_pushmenu_opening()

set_pushmenu_opening( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

set_pushmenu_expanding()

set_pushmenu_expanding( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

get_formated_title()

get_formated_title() : string

Returns

string —

the displayable Menu $title

• Inherited from \Menu

Tags

None found

get_title()

get_title() : string

Returns

string —

the Menu $title

• Inherited from \Menu

Tags

None found

get_auth()

get_auth() : array

Returns

array —

the authorization array $auth

• Inherited from \Menu

Tags

None found

get_id()

get_id() : integer

Returns

integer —

the $id of the menu in the database

• Inherited from \Menu

Tags

None found

get_block()

get_block() : integer

Returns

integer —

the Menu $block position

• Inherited from \Menu

Tags

None found

get_block_position()

get_block_position() : integer

Returns

integer —

the Menu $position

• Inherited from \Menu

Tags

None found

is_enabled()

is_enabled() : boolean

Returns

boolean —

true if the Menu is enabled, false otherwise

• Inherited from \Menu

Tags

None found

is_hidden_with_small_screens()

is_hidden_with_small_screens() : boolean

Returns

boolean —

check if menu is hidden with small screens

• Inherited from \Menu

Tags

None found

is_disabled_body()

is_disabled_body() : boolean

Returns

boolean —

check if body is disabled (pushmenu)

• Inherited from \Menu

Tags

None found

is_pushed_content()

is_pushed_content() : boolean

Returns

boolean —

check if body is pushed (pushmenu)

• Inherited from \Menu

Tags

None found

get_pushmenu_opening()

get_pushmenu_opening() : string

Returns

string —

the opening of the pushmenu

• Inherited from \Menu

Tags

None found

get_pushmenu_expanding()

get_pushmenu_expanding() : string

Returns

string —

the expanding of the pushmenu

• Inherited from \Menu

Tags

None found

get_filters()

get_filters() : string

Returns

string —

the menu filters

• Inherited from \Menu

Tags

None found

set_filters()

set_filters(\Array<Filter> $filters) 

Sets the filters of the menu

Parameters

\Array

$filters

Filters of the menu

• Inherited from \Menu

Tags

None found

set_template()

set_template(\Template $template) 

Sets the template of the menu

Parameters

\Template

$template

Template of the menu

• Inherited from \Menu

Tags

None found

add_array()

add_array(array<mixed,\LinksMenuElement> $menu_elements) 

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

Parameters

array<mixed,\LinksMenuElement>

$menu_elements

A reference to a list of LinksMenuLink and / or Menu to add

• Inherited from \LinksMenu

Tags

None found

add()

add(\LinksMenuElement $element) 

Add a single LinksMenuLink or (sub) Menu

Parameters

\LinksMenuElement

$element

the LinksMenuLink or Menu to add

• Inherited from \LinksMenu

Tags

None found

cache_export()

cache_export( $template = false) : string

Parameters

$template

Returns

string —

the string to write in the cache file

• Inherited from \LinksMenu

Tags

None found

get_menu_types_list()

get_menu_types_list() : array<mixed,string>

static method which returns all the menu types

Returns

array<mixed,string> —

The list of the menu types

static

• Inherited from \LinksMenu

Tags

static

get_type()

get_type() : string

Returns

string —

the menu type

• Inherited from \LinksMenu

Tags

None found

set_type()

set_type(string $type) 

Sets the type of the menu

Parameters

string

$type

Type of the menu

• Inherited from \LinksMenu

Tags

None found

get_children()

get_children() : array<mixed,\LinksMenuElement>

Returns

array<mixed,\LinksMenuElement> —

the menu children elements

• Inherited from \LinksMenu

Tags

None found

_assign()

_assign(\Template $template) 

Assign tpl vars

Parameters

\Template

$template

the template on which we gonna assign vars

• Inherited from \Menu

Tags

None found

_parent()

_parent(string $type) 

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

Parameters

string

$type

the type of the menu

• Inherited from \LinksMenu

Tags

None found

assign_common_template_variables()

assign_common_template_variables(\Template $template) 

Assign default tpl vars

Parameters

\Template

$template

the template on which we gonna assign vars

• Inherited from \Menu

Tags

None found

get_template_to_use()

get_template_to_use() : \Template

Returns

\Template

• Inherited from \Menu

Tags

None found

get_default_template()

get_default_template() : string

Get the default template of the menu

Returns

string —

the default template of the menu

• Inherited from \Menu

Tags

None found

_get_url()

_get_url(string $string_url, boolean $compute_relative_url = true) : string

Parameters

string	$string_url	the url to relativize / absolutize
boolean	$compute_relative_url	If true, computes relative urls to the website root

Returns

string —

the $string_url url

• Inherited from \LinksMenuElement

Tags

None found