Class MenuService

__static()

__static() 

static

• Inherited from \MenuService

Tags

None found

get_menu_list()

get_menu_list( $class = \Menu::MENU__CLASS,  $block = \Menu::BLOCK_POSITION__ALL,  $enabled = \Menu::MENU_ENABLE_OR_NOT) : array<mixed,\Menu>

Parameters

	$class
	$block
	$enabled

Returns

array<mixed,\Menu>

static

• Inherited from \MenuService

Tags

None found

get_menus_map()

get_menus_map() : \unknown_type

Returns

\unknown_type

static

• Inherited from \MenuService

Tags

None found

load()

load(integer $id) : \Menu

Retrieve a Menu Object from the database by its id

Parameters

integer

$id

the id of the Menu to retrieve from the database

Returns

\Menu —

the requested Menu if it exists else, null

static

• Inherited from \MenuService

Tags

None found

save()

save(\Menu $menu) : boolean

save a Menu in the database

Parameters

\Menu

$menu

The Menu to save

Returns

boolean —

true if the save have been correctly done

static

• Inherited from \MenuService

Tags

None found

delete()

delete(mixed $menu) 

Delete a Menu from the database

Parameters

mixed

$menu

The (Menu) Menu or its (int) id to delete from the database

static

• Inherited from \MenuService

Tags

None found

enable()

enable(\Menu $menu) 

Enable a menu

Parameters

\Menu

$menu

the menu to enable

static

• Inherited from \MenuService

Tags

None found

disable()

disable(\Menu $menu) 

Disable a menu

Parameters

\Menu

$menu

the menu to disable

static

• Inherited from \MenuService

Tags

None found

move()

move(\Menu $menu, integer $block, integer $position, boolean $save = true) 

Move a menu into a block and save it. Enable or disable it according to the destination block

Parameters

\Menu	$menu	the menu to move
integer	$block	the destination block
integer	$position	the destination block position
boolean	$save	if true, save also the menu

static

• Inherited from \MenuService

Tags

None found

set_position()

set_position(\Menu $menu, integer $block_position) 

Set the menu position in a block

Parameters

\Menu	$menu	The menu
integer	$block_position	the new position.

static

• Inherited from \MenuService

Tags

None found

change_position()

change_position(\Menu $menu,  $direction = self::MOVE_UP) 

Change the menu position in a block

Parameters

\Menu	$menu	The menu to move
	$direction

static

• Inherited from \MenuService

Tags

None found

enable_all()

enable_all(boolean $enable = true) 

Enables or disables all menus

Parameters

boolean

$enable

if true enables all menus otherwise, disables them

static

• Inherited from \MenuService

Tags

None found

generate_cache()

generate_cache() 

Generate the cache

static

• Inherited from \MenuService

Tags

None found

add_mini_module()

add_mini_module( $module_id,  $generate_cache = true) : boolean

Add the module named $module mini modules

Parameters

	$module_id
	$generate_cache

Returns

boolean —

true if the module has been installed, else, false

static

• Inherited from \MenuService

Tags

None found

delete_mini_module()

delete_mini_module(string $module) 

delete the mini module $module

Parameters

string

$module

the mini module name

static

• Inherited from \MenuService

Tags

None found

update_mini_modules_list()

update_mini_modules_list(boolean $update_cache = true) 

Update the mini modules list by adding new ones and delete old ones

Parameters

boolean

$update_cache

if true it will also regenerate the cache

static

• Inherited from \MenuService

Tags

None found

delete_module_feeds_menus()

delete_module_feeds_menus(string $module_id) 

Delete all the feeds menus with the this module id

Parameters

string

$module_id

the module id

static

• Inherited from \MenuService

Tags

None found

website_modules()

website_modules(integer $menu_type = \LinksMenu::AUTOMATIC_MENU) : \LinksMenu

Return a menu with links to modules

Parameters

integer

$menu_type

the menu type

Returns

\LinksMenu —

the menu with links to modules

static

• Inherited from \MenuService

Tags

None found

assign_positions_conditions()

assign_positions_conditions(\Template $template, integer $position) 

Assigns the positions conditions for different printing modes

Parameters

\Template	$template	the template to use
integer	$position	the menu position

static

• Inherited from \MenuService

Tags

None found

str_to_location()

str_to_location(string $str_location) : integer

Convert the string location the int location

Parameters

string

$str_location

the location

Returns

integer —

the corresponding location

static

• Inherited from \MenuService

Tags

None found

build_menu_list_query_conditions()

build_menu_list_query_conditions(integer $class, \int_type $block, boolean $enabled) : \SQLFragment

Parameters

integer	$class
\int_type	$block
boolean	$enabled

Returns

\SQLFragment

static

• Inherited from \MenuService

Tags

None found

get_next_position()

get_next_position( $block) 

Parameters

$block

static

• Inherited from \MenuService

Tags

None found

initialize_menus_map()

initialize_menus_map() : array<mixed,array>

Returns

array<mixed,array> —

initialize the menus map structure

static

• Inherited from \MenuService

Tags

None found

initialize()

initialize(\string[key] $db_result) : \Menu

Parameters

\string[key]

$db_result

the map from the database with the Menu id and serialized object

Returns

\Menu —

the menu object from the serialized one

static

• Inherited from \MenuService

Tags

None found