Summary: Field | Method | Constr Detail: Field | Method | Constr

zenmagick.store.shared.admin.menu\ZMAdminMenu

admin\menu\ZMAdminMenu.php at line 32

Class ZMAdminMenu

ZMAdminMenu

public class ZMAdminMenu

The admin menu.

This is a singleton with all methods being static.

Author:: DerManoMann

Constant Summary
final static str	MENU_CATALOG_MANAGER_TAB Menu id for Catalog Manager tabs.
final static str	MENU_EXTRAS Extras menu id.
final static str	MENU_PLUGINS Plugins menu id.
final static str	MENU_TOOLS Tools menu id.

Method Summary
static void	addItem(ZMAdminMenuItem item) Add a admin menu item.
static void	buildMenu(string parent) Display the admin menu.
static array	getAllItems() Get all items.
static array	getItemForId(string id) Get item for the given id.
static array	getItemsForParent(string parentId) Get all child items for the given id.
static array	getItemsForParentId(string parentId) Get all child items for the given id.
static array	getRootItemForRequestId(string requestId) Get root item for the given request id.
static void	setItem(array item) Configure a admin menu item.

Constant Detail

admin\menu\ZMAdminMenu.php at line 40

MENU_CATALOG_MANAGER_TAB

public final static str MENU_CATALOG_MANAGER_TAB = 'catalog_manager_tab'

Menu id for Catalog Manager tabs.

admin\menu\ZMAdminMenu.php at line 34

MENU_EXTRAS

public final static str MENU_EXTRAS = 'menu_extras'

Extras menu id.

admin\menu\ZMAdminMenu.php at line 36

MENU_PLUGINS

public final static str MENU_PLUGINS = 'menu_plugins'

Plugins menu id.

admin\menu\ZMAdminMenu.php at line 38

MENU_TOOLS

public final static str MENU_TOOLS = 'menu_tools'

Tools menu id.

Method Detail

admin\menu\ZMAdminMenu.php at line 53

addItem

public static void addItem(ZMAdminMenuItem item)

Add a admin menu item.

Parameters:: item - The new item.
Deprecated.

admin\menu\ZMAdminMenu.php at line 92

buildMenu

public static void buildMenu(string parent)

Display the admin menu.

Parameters:: parent - Parent menu id (used for recursive calls, do not set).
Deprecated.

admin\menu\ZMAdminMenu.php at line 142

getAllItems

public static array getAllItems()

Get all items.

Returns:: List of item details.

admin\menu\ZMAdminMenu.php at line 187

getItemForId

public static array getItemForId(string id)

Get item for the given id.

Parameters:: id - The id.
Returns:: The item or null.

admin\menu\ZMAdminMenu.php at line 170

getItemsForParent

public static array getItemsForParent(string parentId)

Get all child items for the given id.

Parameters:: parentId - The parent id.
Returns:: A list of item data.

admin\menu\ZMAdminMenu.php at line 153

getItemsForParentId

public static array getItemsForParentId(string parentId)

Get all child items for the given id.

Parameters:: parentId - The parent id.
Returns:: A list of ZMAdminMenuItem instances.
Deprecated.

admin\menu\ZMAdminMenu.php at line 203

getRootItemForRequestId

public static array getRootItemForRequestId(string requestId)

Get root item for the given request id.

Parameters:: requestId - The request id.
Returns:: The root item or null.

admin\menu\ZMAdminMenu.php at line 77

setItem

public static void setItem(array item)

Configure a admin menu item.

Possible item data keys:

requestId: The item's request id
parentId: Id of the parent
id: The item id - if not set, the requestId value will be taken
title: The item title
other: Optional list of other request Ids that should be treated like this item
params: Optional URL parameter as per usual

Parameters:: item - The item data.

Frames No frames