menu_block.install in Menu Block 5.2

Provides install, upgrade and un-install functions for menu_block.

File

menu_block.install

<?php

/**
 * @file
 * Provides install, upgrade and un-install functions for menu_block.
 */

/**
 * Implements hook_uninstall().
 */
function menu_block_uninstall() {

  // Delete menu block variables.
  foreach (variable_get('menu_block_ids', array()) as $delta) {
    variable_del("menu_block_{$delta}_menu_name");
    variable_del("menu_block_{$delta}_title");
    variable_del("menu_block_{$delta}_level");
    variable_del("menu_block_{$delta}_depth");
    variable_del("menu_block_{$delta}_expanded");
  }
  variable_del('menu_block_ids');

  // Remove block configurations.
  db_query("DELETE FROM {blocks} WHERE module = 'menu_block'");
  db_query("DELETE FROM {blocks_roles} WHERE module = 'menu_block'");
  cache_clear_all();
}

/**
 * Implements hook_enable().
 */
function menu_block_enable() {
  drupal_set_message(t('To use menu blocks, find the "Add menu block" tab (or button) on the <a href="@url">administer blocks page</a>.', array(
    '@url' => url('admin/build/block'),
  )));
}

/**
 * Implements hook_install().
 */
function menu_block_install() {

  // No-op.
}

/**
 * Implements hook_update_N().
 *
 * Pre-1.0 versions used a different naming convention for block names. Convert
 * the old names to the new format. An unfortunate side effect of this renaming
 * is that it disables all the previously enabled blocks.
 */
function menu_block_update_5100() {
  $delta = 0;
  $enabled_blocks = array();

  // Find the old enabled blocks.
  foreach (variable_get('menu_block_enabled_blocks', array()) as $old_delta => $enabled) {
    list($mid, $level) = explode('-', $old_delta);
    if ($enabled) {
      $enabled_blocks[++$delta] = TRUE;
      variable_set("menu_block_{$delta}_mid", $mid);
      variable_set("menu_block_{$delta}_level", $level);
      variable_set("menu_block_{$delta}_depth", variable_get("menu_block_depth_{$mid}_{$level}", 0));
      variable_set("menu_block_{$delta}_expanded", variable_get("menu_block_expanded_{$mid}_{$level}", 0));
    }

    // Remove any of the old-style variables.
    variable_del("menu_block_depth_{$mid}_{$level}");
    variable_del("menu_block_expanded_{$mid}_{$level}");
  }
  variable_set('menu_block_enabled_blocks', $enabled_blocks);
  return array(
    0 => array(
      'success' => TRUE,
      'query' => t('A pre-release version of Menu block has been detected. All menu blocks from the pre-release version have been given a new delta and are no longer placed in any block regions; their block placement should be re-configured immediately.'),
    ),
  );
}

/**
 * Implements hook_update_N().
 *
 * Converts $menu_block_enabled_blocks to $menu_block_ids and
 * $menu_block_DELTA_mid to $menu_block_DELTA_menu_name. Also deletes un-enabled
 * menu blocks.
 */
function menu_block_update_5200() {
  $menus = menu_get_root_menus();
  $block_ids = array();
  foreach (variable_get('menu_block_enabled_blocks', array()) as $delta => $enabled) {
    if ($enabled) {
      $block_ids[] = $delta;

      // Build new $menu_block_ids.
      // Convert $menu_block_DELTA_mid to $menu_block_DELTA_menu_name.
      $mid = variable_get("menu_block_{$delta}_mid", 1);
      variable_set("menu_block_{$delta}_menu_name", $mid);

      // Store the menu title to make upgrading to Drupal 6 possible.
      variable_set("menu_block_{$delta}_title", $menus[$mid]);
      variable_del("menu_block_{$delta}_mid");
    }
    else {

      // Delete un-enabled menu block.
      variable_del("menu_block_{$delta}_mid");
      variable_del("menu_block_{$delta}_level");
      variable_del("menu_block_{$delta}_depth");
      variable_del("menu_block_{$delta}_expanded");
      db_query("DELETE FROM {blocks} WHERE module = 'menu_block' AND delta = %d", $delta);
    }
  }

  // Finish conversion of $menu_block_enabled_blocks to $menu_block_ids.
  sort($block_ids);
  variable_set('menu_block_ids', $block_ids);
  variable_del('menu_block_enabled_blocks');
  cache_clear_all();
  return array(
    0 => array(
      'success' => TRUE,
      'query' => t('The 5.x-1.x version of Menu block has been upgraded. To use menu blocks in this new version, find the "Add menu block" tab (or button) on the <a href="@url">administer blocks page</a>.', array(
        '@url' => url('admin/build/block'),
      )),
    ),
  );
}

Functions

Name	Description
menu_block_enable	Implements hook_enable().
menu_block_install	Implements hook_install().
menu_block_uninstall	Implements hook_uninstall().
menu_block_update_5100	Implements hook_update_N().
menu_block_update_5200	Implements hook_update_N().