Access Method

The same item IDs and the same methods of the HSPC::CP::Menu package are used for Control Panel menu and dashboard.

In spite of the fact that the same IDs and methods are used for menu and dashboard, the addition or other operation over the menu items does not affect dashboard. Thus, please remember that for example, to add an item both to menu and dashboard, it is necessary to all a custom code in both modules.

To add items to an existing section of the menu or dashboard or to add a new section and items to the menu or dashboard, use the add_item_to_section method.

Input parameters are:

Required parameters:

• menu – menu
• section_id – id of section. This is unique section ID. If section with specified ID not found it will be created.
• section_tab – control panel tab (available values are: site, system, account, person, upgrade, help)
• items – items for adding (reference to array of hashes)

Optional parameters:

• section_title – section title. Require only if section not yet exists
• dup_mode – action for duplicate items: 'skip' or 'replace'. This parameter specifies what to do if one (or several) passed items are already exists in the menu. If "dup_mode" not present or undefined the method returns error message "duplicate_item_id". If the value is "skip" the method will not return error and will not add duplicate items to the menu. If the value is "replace" the method will replace existing item(s).

Return value:

• undef (if success) or error message (if something wrong).

Note: This method will create a new section if section with ID equal to passed "section_id" does not exist. The full list of item IDs used in the Control Panel is attached.

If you are sure that section does not exist, always specify the "section_title" parameter in order to give a title for a newly created section. If the title was not passed, the method uses "NoName" as a section title.

Please send us your feedback on this help page