annotate modules/menu/menu.api.php @ 0:ff03f76ab3fe

initial version
author danieleb <danielebarchiesi@me.com>
date Wed, 21 Aug 2013 18:51:11 +0100
parents
children
rev   line source
danielebarchiesi@0 1 <?php
danielebarchiesi@0 2
danielebarchiesi@0 3 /**
danielebarchiesi@0 4 * @file
danielebarchiesi@0 5 * Hooks provided by the Menu module.
danielebarchiesi@0 6 */
danielebarchiesi@0 7
danielebarchiesi@0 8 /**
danielebarchiesi@0 9 * @addtogroup hooks
danielebarchiesi@0 10 * @{
danielebarchiesi@0 11 */
danielebarchiesi@0 12
danielebarchiesi@0 13 /**
danielebarchiesi@0 14 * Respond to a custom menu creation.
danielebarchiesi@0 15 *
danielebarchiesi@0 16 * This hook is used to notify modules that a custom menu has been created.
danielebarchiesi@0 17 * Contributed modules may use the information to perform actions based on the
danielebarchiesi@0 18 * information entered into the menu system.
danielebarchiesi@0 19 *
danielebarchiesi@0 20 * @param $menu
danielebarchiesi@0 21 * An array representing a custom menu:
danielebarchiesi@0 22 * - menu_name: The unique name of the custom menu.
danielebarchiesi@0 23 * - title: The human readable menu title.
danielebarchiesi@0 24 * - description: The custom menu description.
danielebarchiesi@0 25 *
danielebarchiesi@0 26 * @see hook_menu_update()
danielebarchiesi@0 27 * @see hook_menu_delete()
danielebarchiesi@0 28 */
danielebarchiesi@0 29 function hook_menu_insert($menu) {
danielebarchiesi@0 30 // For example, we track available menus in a variable.
danielebarchiesi@0 31 $my_menus = variable_get('my_module_menus', array());
danielebarchiesi@0 32 $my_menus[$menu['menu_name']] = $menu['menu_name'];
danielebarchiesi@0 33 variable_set('my_module_menus', $my_menus);
danielebarchiesi@0 34 }
danielebarchiesi@0 35
danielebarchiesi@0 36 /**
danielebarchiesi@0 37 * Respond to a custom menu update.
danielebarchiesi@0 38 *
danielebarchiesi@0 39 * This hook is used to notify modules that a custom menu has been updated.
danielebarchiesi@0 40 * Contributed modules may use the information to perform actions based on the
danielebarchiesi@0 41 * information entered into the menu system.
danielebarchiesi@0 42 *
danielebarchiesi@0 43 * @param $menu
danielebarchiesi@0 44 * An array representing a custom menu:
danielebarchiesi@0 45 * - menu_name: The unique name of the custom menu.
danielebarchiesi@0 46 * - title: The human readable menu title.
danielebarchiesi@0 47 * - description: The custom menu description.
danielebarchiesi@0 48 * - old_name: The current 'menu_name'. Note that internal menu names cannot
danielebarchiesi@0 49 * be changed after initial creation.
danielebarchiesi@0 50 *
danielebarchiesi@0 51 * @see hook_menu_insert()
danielebarchiesi@0 52 * @see hook_menu_delete()
danielebarchiesi@0 53 */
danielebarchiesi@0 54 function hook_menu_update($menu) {
danielebarchiesi@0 55 // For example, we track available menus in a variable.
danielebarchiesi@0 56 $my_menus = variable_get('my_module_menus', array());
danielebarchiesi@0 57 $my_menus[$menu['menu_name']] = $menu['menu_name'];
danielebarchiesi@0 58 variable_set('my_module_menus', $my_menus);
danielebarchiesi@0 59 }
danielebarchiesi@0 60
danielebarchiesi@0 61 /**
danielebarchiesi@0 62 * Respond to a custom menu deletion.
danielebarchiesi@0 63 *
danielebarchiesi@0 64 * This hook is used to notify modules that a custom menu along with all links
danielebarchiesi@0 65 * contained in it (if any) has been deleted. Contributed modules may use the
danielebarchiesi@0 66 * information to perform actions based on the information entered into the menu
danielebarchiesi@0 67 * system.
danielebarchiesi@0 68 *
danielebarchiesi@0 69 * @param $menu
danielebarchiesi@0 70 * An array representing a custom menu:
danielebarchiesi@0 71 * - menu_name: The unique name of the custom menu.
danielebarchiesi@0 72 * - title: The human readable menu title.
danielebarchiesi@0 73 * - description: The custom menu description.
danielebarchiesi@0 74 *
danielebarchiesi@0 75 * @see hook_menu_insert()
danielebarchiesi@0 76 * @see hook_menu_update()
danielebarchiesi@0 77 */
danielebarchiesi@0 78 function hook_menu_delete($menu) {
danielebarchiesi@0 79 // Delete the record from our variable.
danielebarchiesi@0 80 $my_menus = variable_get('my_module_menus', array());
danielebarchiesi@0 81 unset($my_menus[$menu['menu_name']]);
danielebarchiesi@0 82 variable_set('my_module_menus', $my_menus);
danielebarchiesi@0 83 }
danielebarchiesi@0 84
danielebarchiesi@0 85 /**
danielebarchiesi@0 86 * @} End of "addtogroup hooks".
danielebarchiesi@0 87 */