pathauto.install in Pathauto 5.2

Install, update, and uninstall functions for Pathauto.

File

pathauto.install

<?php

/**
 * @file
 * Install, update, and uninstall functions for Pathauto.
 *
 * @ingroup pathauto
 */

/**
 * Implementation of hook_install().
 */
function pathauto_install() {

  // Check to see if taxonomy module is enabled before we set those variables
  if (module_exists('taxonomy')) {
    variable_set('pathauto_modulelist', array(
      'node',
      'user',
      'taxonomy',
    ));
    variable_set('pathauto_taxonomy_supportsfeeds', '0/feed');
    variable_set('pathauto_taxonomy_pattern', 'category/[vocab-raw]/[catpath-raw]');
    variable_set('pathauto_taxonomy_bulkupdate', FALSE);
    variable_set('pathauto_taxonomy_applytofeeds', FALSE);
    variable_set('pathauto_taxonomy_2_pattern', '');
    variable_set('pathauto_taxonomy_1_pattern', '');
  }
  else {

    // Node and user are required so we don't have to check
    variable_set('pathauto_modulelist', array(
      'node',
      'user',
    ));
  }

  // Set the rest of the pathauto default variables
  variable_set('pathauto_ignore_words', 'a,an,as,at,before,but,by,for,from,is,in,into,like,of,off,on,onto,per,since,than,the,this,that,to,up,via,with');
  variable_set('pathauto_indexaliases', FALSE);
  variable_set('pathauto_indexaliases_bulkupdate', FALSE);
  variable_set('pathauto_max_component_length', '100');
  variable_set('pathauto_max_length', '100');
  variable_set('pathauto_node_bulkupdate', FALSE);
  variable_set('pathauto_node_forum_pattern', '');
  variable_set('pathauto_node_image_pattern', '');
  variable_set('pathauto_node_page_pattern', '');
  variable_set('pathauto_node_pattern', 'content/[title-raw]');
  variable_set('pathauto_node_story_pattern', '');
  variable_set('pathauto_punctuation_quotes', 0);
  variable_set('pathauto_separator', '-');
  variable_set('pathauto_update_action', '2');
  variable_set('pathauto_user_bulkupdate', FALSE);
  variable_set('pathauto_user_pattern', 'users/[user-raw]');
  variable_set('pathauto_user_supportsfeeds', NULL);
  variable_set('pathauto_verbose', FALSE);

  // Make sure we "replace hyphen with separator" by default
  variable_set('pathauto_punctuation_hyphen', 1);

  // 1 is replace
  // Set the weight to 1
  db_query("UPDATE {system} SET weight = 1 WHERE name = 'pathauto'");

  // Make the variable column wide enough for long cck names
  switch ($GLOBALS['db_type']) {
    case 'pgsql':

      // Using pgsql<8.x?  Help at http://drupal.org/node/195044
      db_query('ALTER TABLE {variable} ALTER name TYPE varchar(128)');
      break;
    case 'mysql':
    case 'mysqli':
      db_query("ALTER TABLE {variable} CHANGE name name varchar(128) NOT NULL default ''");
      break;
  }

  // Clear the cache to get these to take effect.
  cache_clear_all();
}

/**
 * Implementation of hook_uninstall().
 */
function pathauto_uninstall() {

  // Delete all the pathauto variables and then clear the variable cache
  db_query("DELETE FROM {variable} WHERE name LIKE 'pathauto_%'");
  cache_clear_all('variables', 'cache');
}

/**
 * Set the weight a little heavier to allow taxonomy to do its work.
 */
function pathauto_update_1() {
  $ret = array();
  $ret[] = update_sql("UPDATE {system} SET weight = 1 WHERE name = 'pathauto'");
  return $ret;
}

/**
 * Increase the maximum length of variable names from 48 to 128.
 *
 * Copied from DRUPAL-6 system_update_6002 per http://drupal.org/node/66795
 */
function pathauto_update_2() {
  $ret = array();
  switch ($GLOBALS['db_type']) {
    case 'pgsql':
      db_change_column($ret, 'variable', 'name', 'name', 'varchar(128)', array(
        'not null' => TRUE,
        'default' => "''",
      ));
      break;
    case 'mysql':
    case 'mysqli':
      $ret[] = update_sql("ALTER TABLE {variable} CHANGE name name varchar(128) NOT NULL default ''");
      break;
  }
  return $ret;
}

/**
 * Delete the pathauto_node_supportsfeeds.
 */
function pathauto_update_3() {

  // Do nothing, this update was a mistake
  return array();
}

/**
 * New style naming for the punctuation chars.
 */
function pathauto_update_4() {
  variable_set('pathauto_punctuation_quotes', variable_get('pathauto_quotes', 0));
  variable_del('pathauto_quotes');
  return array();
}

/**
 * Create a table so that we can track which items we keep
 * And eventually to improve join performance
 */
function pathauto_update_5() {

  // Note: no longer done...see http://drupal.org/node/248031
  return array();
}

/**
 * Remove some variables that are no longer used.
 */
function pathauto_update_6() {
  $ret = array();

  // Delete some unused variables
  $ret[] = update_sql("DELETE FROM {variable} WHERE name LIKE 'pathauto_%_supportsfeeds'");
  cache_clear_all('variables', 'cache');
  return $ret;
}

/**
 * Remove the url_alias_extra table which wasn't used.
 */
function pathauto_update_7() {
  $ret = array();
  if (db_table_exists('url_alias_extra')) {
    $ret[] = update_sql('DROP TABLE {url_alias_extra}');
  }
  return $ret;
}

Related topics

Pathauto: Automatically generates aliases for content

The Pathauto module automatically generates path aliases for various kinds of content (nodes, categories, users) without requiring the user to manually specify the path alias. This allows you to get aliases like /category/my-node-title.html instead of…

Functions

Name	Description
pathauto_install	Implementation of hook_install().
pathauto_uninstall	Implementation of hook_uninstall().
pathauto_update_1	Set the weight a little heavier to allow taxonomy to do its work.
pathauto_update_2	Increase the maximum length of variable names from 48 to 128.
pathauto_update_3	Delete the pathauto_node_supportsfeeds.
pathauto_update_4	New style naming for the punctuation chars.
pathauto_update_5	Create a table so that we can track which items we keep And eventually to improve join performance
pathauto_update_6	Remove some variables that are no longer used.
pathauto_update_7	Remove the url_alias_extra table which wasn't used.