glossary.install in Glossary 5.2

Install file for Glossary module.

File

glossary.install

<?php

/**
 *  @file
 *    Install file for Glossary module.
 */

/**
 * Implementation of hook_update_N().
 * In order to make sure we don't turn off the search block, we'll change the blocks table.
 */
function glossary_update_5100() {
  $ret = array();
  $ret[] = update_sql("UPDATE {blocks} SET delta=0 WHERE module='glossary' AND delta='999'");
  return $ret;
}

/**
 * Implementation of hook_update_N().
 * We no longer support the old blocks, so let's delete them from the blocks table.
 */
function glossary_update_5101() {
  $ret = array();
  $ret[] = update_sql("DELETE FROM {blocks} WHERE module='glossary' AND (delta<'999' AND delta>'0')");
  return $ret;
}

/**
 * Implementation of hook_update_N().
 * We have moved the settings, so we'll remind the user of this.
 */
function glossary_update_5102() {
  $ret = array();
  drupal_set_message('Note: The settings for the Glossary module have moved from the Input Formats page to a separate page under Administer &raquo; Site configuration &raquo; Glossary. Additionally, there are a few new settings.', 'error');
  return $ret;
}

/**
 * Implementation of hook_update_N().
 * We have moved the settings, so we'll remind the user of this.
 */
function glossary_update_5103() {
  $ret = array();

  // Find out how many input formats are set.
  $filter_count = db_result(db_query('SELECT MAX( format ) FROM {filters}'));
  for ($i = 0; $i <= $filter_count; ++$i) {
    $name = 'glossary_absolute_' . $i;
    $abs = variable_get($name, NULL);
    if (is_null($abs)) {
      continue;
    }
    $link = 'glossary_link_' . $i;
    if ($abs) {
      $value = 'absolute';
    }
    else {
      $value = 'normal';
    }
    variable_del($name);
    variable_set($link, $value);
    watchdog('Glossary', t('Glossary variable %abs deleted; %link set to %new', array(
      '%abs' => $name,
      '%link' => $link,
      '%new' => $value,
    )));
  }
  return $ret;
}

/**
 * Implementation of hook_update_N().
 * Allow code and pre to be configurable (#241377).
 */
function glossary_update_5104() {
  $ret = array();
  $result = db_query('SELECT format, name FROM {filter_formats}');
  while ($filter = db_fetch_array($result)) {
    $format = $filter['format'];
    $value = variable_get("glossary_blocking_tags_{$format}", NULL);
    if (!is_null($value)) {
      $value = "code pre {$value}";
      variable_set("glossary_blocking_tags_{$format}", $value);
      $ret[] = array(
        'success' => TRUE,
        'query' => "variable_set('glossary_blocking_tags_{$format}', {$value})",
      );
    }
  }
  return $ret;
}

/**
 * Implementation of hook_requirements().
 */
function glossary_requirements($phase) {
  $requirements = array();

  // Ensure translations don't break at install time
  $t = get_t();

  // check that php is compiled with ctype support
  $requirements['ctype'] = array(
    'title' => $t('Character type functions (ctype)'),
  );
  if (function_exists('ctype_alnum')) {
    $requirements['ctype']['value'] = $t('Enabled');
    $requirements['ctype']['severity'] = REQUIREMENT_OK;
  }
  else {
    $requirements['ctype']['value'] = $t('Disabled');
    $requirements['ctype']['description'] = $t('The Glossary module requires that you configure PHP with --enable-ctype.');
    $requirements['ctype']['severity'] = REQUIREMENT_ERROR;
  }
  return $requirements;
}

/**
 * Implementation of hook_install().
 * In order to make sure all defaults are consistent, we'll just go ahead and set them all.
 */
function glossary_install() {

  // Find out how many input formats are set.
  $filter_count = db_result(db_query('SELECT MAX(format) FROM {filters}'));

  // Set all possible variables.
  $mypath = '/' . drupal_get_path('module', 'glossary') . '/glossary.gif';
  for ($i = 0; $i <= $filter_count; ++$i) {
    variable_set('glossary_case_' . $i, 1);
    variable_set('glossary_icon_' . $i, $mypath);
    variable_set('glossary_match_' . $i, 'b');
    variable_set('glossary_replace_' . $i, 'superscript');
    variable_set('glossary_replace_all_' . $i, 0);
    variable_set('glossary_superscript_' . $i, 'i');
    variable_set('glossary_link_' . $i, 'normal');
    variable_set('glossary_vids_' . $i, array());
    variable_set('glossary_blocking_tags_' . $i, 'abbr acronym');
  }
  variable_set('glossary_page_per_letter', FALSE);
  variable_set('glossary_disable_indicator', FALSE);
  variable_set('glossary_click_option', 0);
  variable_set('glossary_allow_no_description', FALSE);
  variable_set('glossary_alphabet', range('a', 'z'));
  variable_set('glossary_digits', range('0', '9'));
  variable_set('glossary_hide_menus', FALSE);
  variable_set('glossary_show_description', FALSE);
  variable_set('glossary_suppress_unused', FALSE);
  variable_set('glossary_alphabar_separator', '|');
  variable_set('glossary_separate_letters', FALSE);
  drupal_set_message(t('The Glossary module has been installed with default settings. To change the settings, <a href="!settings_uri">click here</a>.', array(
    '!settings_uri' => url('admin/settings/glossary'),
  )));
}

/**
 * Implementation of hook_uninstall().
 * There are no tables, so we delete all variables and clear the filter cache.
 * It is left to the user to dispose of any vocabularies that are no longer needed.
 */
function glossary_uninstall() {

  // Find out how many input formats are set.
  $filter_count = db_result(db_query('SELECT MAX( format ) FROM {filters}'));

  // Delete all possible variables. Even if some don't exist, there is no harm in trying.
  for ($i = 0; $i <= $filter_count; ++$i) {
    variable_del('glossary_case_' . $i);
    variable_del('glossary_icon_' . $i);
    variable_del('glossary_match_' . $i);
    variable_del('glossary_replace_' . $i);
    variable_del('glossary_replace_all_' . $i);
    variable_del('glossary_superscript_' . $i);
    variable_del('glossary_absolute_' . $i);
    variable_del('glossary_vids_' . $i);
    variable_del('glossary_blocking_tags_' . $i);
  }
  variable_del('glossary_page_per_letter');
  variable_del('glossary_disable_indicator');
  variable_del('glossary_need_to_clear_cache');
  variable_del('glossary_click_option');
  variable_del('glossary_allow_no_description');
  variable_del('glossary_alphabet');
  variable_del('glossary_digits');
  variable_del('glossary_hide_menus');
  variable_del('glossary_show_description');
  variable_del('glossary_suppress_unused');
  variable_del('glossary_alphabar_separator');
  variable_del('glossary_block_1_interval');
  variable_del('glossary_block_1_last');
  variable_del('glossary_block_1_step');
  variable_del('glossary_block_1_tid');
  variable_del('glossary_block_1_vids');

  // Let's make sure the filter cache is cleared of our stuff.
  cache_clear_all(NULL, 'cache_filter');
  watchdog('Glossary', t('Glossary module uninstalled by uid !user.', array(
    '!user' => $user->uid,
  )));
  drupal_set_message(t('The Glossary module has been uninstalled. You will still need to decide what to do with vocabularies that were used.'), 'error');
}

Functions

Name	Description
glossary_install	Implementation of hook_install(). In order to make sure all defaults are consistent, we'll just go ahead and set them all.
glossary_requirements	Implementation of hook_requirements().
glossary_uninstall	Implementation of hook_uninstall(). There are no tables, so we delete all variables and clear the filter cache. It is left to the user to dispose of any vocabularies that are no longer needed.
glossary_update_5100	Implementation of hook_update_N(). In order to make sure we don't turn off the search block, we'll change the blocks table.
glossary_update_5101	Implementation of hook_update_N(). We no longer support the old blocks, so let's delete them from the blocks table.
glossary_update_5102	Implementation of hook_update_N(). We have moved the settings, so we'll remind the user of this.
glossary_update_5103	Implementation of hook_update_N(). We have moved the settings, so we'll remind the user of this.
glossary_update_5104	Implementation of hook_update_N(). Allow code and pre to be configurable (#241377).