<?php
// $Id$

/**
 * @file
 * Install/Update/Uninstall functions for node_example module
 */

/**
 * Implements hook_install().
 *
 * Note: This process is not required to work with the menu system.
 *
 * It is a Best Practice to include menu entries in existing menues, but it not
 * guarantied by Drupal that the menu exists in all the Drupal sites. A site 
 * administrator may have removed all the predefined menues and create new ones,
 * so everytime you put a menu link in a menu you are responsible of checking 
 * that the menu already exists.
 * 
 * This and other requirements may lead you to create your custom menu instead
 * of using Drupal's defined ones. To create it you can do using Drupal's user
 * interface at admin/structure/menu/add, or do it programatically using
 * menu_save().
 *
 * In this example module we are creating the menu programatically to make it
 * available for all Drupal sites where the module is installed, to put into it
 * some menu entries later in hook_menu().
 *
 *
 * @see menu_save()
 * @link menu Menu System @endlink and
 * @link http://drupal.org/node/1004922 Issue about missing menues @endlink
 */
function menu_example_install() {

  /**
   * A menu is just a container of menu entries. Very little information is
   * required to build it: a machine name, a title and a description.
   */
  $menu = array(
    'menu_name' => 'example_menu',
    'title' => $t('Example menu'),
    'description' => $t('A menu created to put some example entries in it'),
  );

  /**
   * menu_save() actually creates the menu.
   */
  menu_save($menu);
}

/**
 * Implements hook_uninstall().
 *
 * Remove our custom created menu.
 *
 * @see menu_load()
 * @see menu_delete()
 * @link menu Menu System @endlink
 */
function menu_example_uninstall() {
  // Load our custom menu.
  $menu = menu_load('example_menu');

  // At this point we can change the menu entry and save again, but in this case
  // we are only interested in removing it.
  menu_delete($menu);
}