faq.install in Frequently Asked Questions 7

FAQ module install file.

File

faq.install

<?php

/**
 * @file
 * FAQ module install file.
 */

/**
 * Define the 'faq_weights' and 'faq_questions' table structures.
 *
 * @return array
 *   The schema which contains the structure for the faq module's tables.
 */
function faq_schema() {
  $schema['faq_weights'] = array(
    'description' => 'A table containing the weight of each faq node by category.',
    'fields' => array(
      'tid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The primary identifier for a term or category.  This will be 0 for non-categorized nodes.',
      ),
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The primary identifier for a node.',
      ),
      'weight' => array(
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'A number representing the weight of a node.  Nodes with lower weight values will appear above those with higher weight values.',
      ),
    ),
    'primary key' => array(
      'nid',
      'tid',
    ),
  );
  $schema['faq_questions'] = array(
    'description' => 'A table containing the long question text of each faq node revision.',
    'fields' => array(
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The primary identifier for a node.',
      ),
      'vid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The primary identifier for a node revision.',
      ),
      'question' => array(
        'type' => 'text',
        'size' => 'normal',
        'not null' => TRUE,
        'description' => 'The faq short question text.',
      ),
      'detailed_question' => array(
        'type' => 'text',
        'size' => 'normal',
        'not null' => FALSE,
        'description' => 'The faq long question text.',
      ),
    ),
    'primary key' => array(
      'nid',
      'vid',
    ),
  );
  return $schema;
}

/**
 * Implements hook_install().
 *
 * Inserts the FAQ module's schema in the SQL database.
 */
function faq_install() {
  variable_set('node_type_faq', array(
    'status',
  ));
  $t = get_t();

  // Ensure the FAQ node type is available.
  node_types_rebuild();
  $types = node_type_get_types();
  node_add_body_field($types['faq']);

  // Change the default label on the body field.
  $body_instance = field_info_instance('node', 'body', 'faq');
  $body_instance['label'] = $t('Answer');
  field_update_instance($body_instance);

  // Add the detailed question field.
  _faq_add_custom_fields();

  // Shift all fields below the body field one down and put detailed question field where the body field was.
  _faq_shift_fields_down();
}

/**
 * Implements hook_uninstall().
 *
 * Remove the variables, nodes and schema corresponding to the FAQ module.
 */
function faq_uninstall() {

  // Delete the variables we created.
  // General settings.
  variable_del('faq_title');
  variable_del('faq_description');
  variable_del('faq_path');

  // Questions page.
  variable_del('faq_display');
  variable_del('faq_question_listing');
  variable_del('faq_qa_mark');
  variable_del('faq_question_label');
  variable_del('faq_answer_label');
  variable_del('faq_question_length');
  variable_del('faq_hide_qa_accordion');
  variable_del('faq_show_expand_all');
  variable_del('faq_use_teaser');
  variable_del('faq_show_node_links');
  variable_del('faq_back_to_top');
  variable_del('faq_disable_node_links');
  variable_del('faq_default_sorting');
  variable_del('faq_question_long_form');

  // Categories page.
  variable_del('faq_use_categories');
  variable_del('faq_category_display');
  variable_del('faq_category_listing');
  variable_del('faq_category_hide_qa_accordion');
  variable_del('faq_count');
  variable_del('faq_answer_category_name');
  variable_del('faq_group_questions_top');
  variable_del('faq_hide_child_terms');
  variable_del('faq_show_term_page_children');
  variable_del('faq_omit_vocabulary');
  variable_del('faq_enable_term_links');

  // Block settings.
  variable_del('faq_block_recent_faq_count');
  variable_del('faq_block_random_faq_count');

  // Custom breadcrumbs control.
  variable_del('faq_custom_breadcrumbs');

  // Deprecated.
  variable_del('faq_more_link');

  // Remove content type and the fields created.
  $faq_type = 'faq';
  $sql = 'SELECT nid FROM {node} n WHERE n.type = :type';
  $result = db_query($sql, array(
    ':type' => $faq_type,
  ));
  $nodeids = array();
  foreach ($result as $row) {
    $nodeids[] = $row->nid;
  }
  node_delete_multiple($nodeids);
  _faq_delete_custom_fields();
  node_type_delete($faq_type);
  field_purge_batch(500);

  // Remove content type and the fields created.
  $faq_type = 'faq';
  $sql = 'SELECT nid FROM {node} n WHERE n.type = :type';
  $result = db_query($sql, array(
    ':type' => $faq_type,
  ));
  $nodeids = array();
  foreach ($result as $row) {
    $nodeids[] = $row->nid;
  }
  node_delete_multiple($nodeids);
  _faq_delete_custom_fields();
  node_type_delete($faq_type);
  field_purge_batch(500);

  // Clear the cache tables.
  cache_clear_all('*', 'cache', TRUE);
  cache_clear_all('*', 'cache_filter', TRUE);
  cache_clear_all('*', 'cache_menu', TRUE);
  cache_clear_all('*', 'cache_page', TRUE);
}

/**
 * Create 'faq_weights' table in order to upgrade from older installations.
 */
function faq_update_1() {
  $schema['faq_weights'] = array(
    'description' => 'A table containing the weight of each faq node by category.',
    'fields' => array(
      'tid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'weight' => array(
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array(
      'nid',
      'tid',
    ),
  );
  $ret = array();
  db_create_table('faq_weights', $schema['faq_weights']);
  return t('FAQ weighting table created.');
}

/**
 * Create 'faq_questions' table in order to upgrade from older installations.
 */
function faq_update_2() {
  $schema['faq_questions'] = array(
    'description' => 'A table containing the long question text of each faq node revision.',
    'fields' => array(
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The primary identifier for a node.',
      ),
      'vid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The primary identifier for a node revision.',
      ),
      'question' => array(
        'type' => 'text',
        'size' => 'normal',
        'not null' => TRUE,
        'description' => 'The faq long question text.',
      ),
    ),
    'primary key' => array(
      'nid',
      'vid',
    ),
  );
  db_create_table('faq_questions', $schema['faq_questions']);

  // Pre-populate the questions table from the existing nodes.
  $select = db_select('node', 'n');
  $select
    ->innerJoin('node_revisions', 'r', 'n.nid = %alias.nid');
  $select
    ->fields('r', array(
    'nid',
    'vid',
    'title',
  ))
    ->condition('n.type', 'faq');
  db_insert('faq_questions')
    ->fields(array(
    'nid',
    'vid',
    'question',
  ))
    ->from($select)
    ->execute();
  return t('FAQ Questions table created.');
}

/**
 * Add the 'detailed_question' column to the 'faq_questions' table.
 */
function faq_update_6003() {
  $ret = array();
  db_add_field('faq_questions', 'detailed_question', array(
    'type' => 'text',
    'size' => 'normal',
    'not null' => TRUE,
  ));
  db_update('faq_questions')
    ->expression('detailed_question', 'question')
    ->execute();
  return t('Detailed question column added.  Existing nodes have been given the same detailed question as current question.');
}

/**
 * Make'detailed_question' column nullable.
 */
function faq_update_7000() {
  db_change_field('faq_questions', 'detailed_question', 'detailed_question', array(
    'type' => 'text',
    'size' => 'normal',
    'not null' => FALSE,
  ));
  return t('Detailed question field can now be null.');
}

/**
 * Delete obsolete variables.
 */
function faq_update_7001() {
  variable_del('faq_block_recent_faq_count');
  variable_del('faq_block_random_faq_count');
  variable_del('faq_enable_term_links');
  return t('Deleted obsolete variables.');
}

/**
 * Convert old-style detailed questions to new fields.
 */
function faq_update_7002(&$sandbox) {

  // Number of nodes to update each pass.
  define('BATCH_SIZE_7002', '5');

  // Do this the first time.
  if (!isset($sandbox['progress'])) {

    // Initialize sandbox structure for multi-pass update.
    $sandbox['progress'] = 0;
    $sandbox['current_idx'] = 0;

    // Get faq nodes and run the query as user 1.
    $query = new EntityFieldQuery();
    $query
      ->entityCondition('entity_type', 'node')
      ->entityCondition('bundle', 'faq')
      ->addMetaData('account', user_load(1));
    $result = $query
      ->execute();
    if (isset($result['node'])) {
      $sandbox['faq_items_nids'] = array_keys($result['node']);
      $sandbox['max'] = count($sandbox['faq_items_nids']);
    }
    else {
      $sandbox['faq_items_nids'] = array();
      $sandbox['max'] = 0;
    }

    // Add the detailed question field.
    _faq_add_custom_fields();

    // Adjust the weight of the field so that it is above the answer (body).
    _faq_shift_fields_down();
  }
  $count = 0;

  // Convert old-style detailed questions to new full field.
  while (($nid = $sandbox['faq_items_nids'][$sandbox['current_idx']]) && $count < BATCH_SIZE_7002) {

    // Load the full node to be updated.
    $node = node_load($nid);

    // Load the detailed question.
    $dq = isset($node->detailed_question) ? $node->detailed_question : '';
    if ($dq == '') {
      $select = db_select('faq_questions', 'f');
      $dq = $select
        ->condition('f.nid', $node->nid)
        ->fields('f', array(
        'detailed_question',
      ))
        ->execute()
        ->fetchField();
    }

    // Get the default text filter format from DB as this might be integer if upgraded site or tekststring if new D7 site.
    // Default filter format: Filtered HTML.
    $filter_formats = filter_formats();
    $filter_formats_keys = array_keys($filter_formats);
    $filter_format = reset($filter_formats_keys);

    // Get the language(s) from the body, making sure we have the same set for detailed question too.
    $langs = array_keys($node->body);

    // Add proper taxonomy fields.
    $txonselect = db_select('taxonomy_index', 't');
    $taxres = $txonselect
      ->fields('t', array(
      'tid',
    ))
      ->condition('t.nid', $node->nid)
      ->execute();
    foreach ($taxres as $taxon) {
      $term = taxonomy_term_load($taxon->tid);
      $vocab = taxonomy_vocabulary_load($term->vid);
      foreach ($langs as $language) {

        // Find out if there is a field added with the vocabulary of this term.
        if (isset($node->{$vocab->module . "_" . $vocab->machine_name})) {
          $node->{$vocab->module . "_" . $vocab->machine_name}[$language][$term->tid] = (array) $term;
        }
      }
    }

    // Add detailed question field for all languages.
    foreach ($langs as $language) {
      $node->field_detailed_question[$language][0]['value'] = $dq;
      $node->field_detailed_question[$language][0]['format'] = $filter_format;
      $node->field_detailed_question[$language][0]['safe_value'] = check_markup($dq, $filter_format, $language);
    }

    // Save resulting node.
    node_save($node);

    // Should not be more than BATCH_SIZE_7002.
    $count++;

    // Progress counter.
    $sandbox['progress']++;

    // Node array index pointer.
    $sandbox['current_idx']++;
  }
  $sandbox['#finished'] = empty($sandbox['max']) ? 1 : $sandbox['progress'] / $sandbox['max'];
  return t('Custom field added, @count questions converted into fields.', array(
    '@count' => $sandbox['max'] + 1,
  ));
}

/**
 * Convert faq page description to array.
 */
function faq_update_7003(&$sandbox) {
  $description = variable_get('faq_description', '');
  $format = variable_get('faq_description_format', filter_fallback_format());
  $faq_description = array(
    'value' => $description,
    'format' => $format,
  );
  variable_set('faq_description', $faq_description);
  variable_del('faq_description_format');
  return t('Converted faq page description to array.');
}

/**
 * Code examples modified.
 *
 * @see http://www.sitepoint.com/creating-a-new-drupal-node-type/
 * @see http://www.thecarneyeffect.co.uk/creating-custom-content-type-adding-fields-programmatically-drupal-7
 */
function _faq_add_custom_fields() {
  foreach (_faq_installed_fields() as $field) {
    field_create_field($field);
  }
  foreach (_faq_installed_instances() as $fieldinstance) {
    $fieldinstance['entity_type'] = 'node';
    $fieldinstance['bundle'] = 'faq';
    field_create_instance($fieldinstance);
  }
}

/**
 * Return the detailed question field definition.
 */
function _faq_installed_fields() {
  $t = get_t();
  return array(
    'detailed_question' => array(
      'translatable' => '0',
      'entity_types' => array(),
      'settings' => array(),
      'storage' => array(
        'type' => 'field_sql_storage',
        'settings' => array(),
        'module' => 'field_sql_storage',
        'active' => '1',
        'details' => array(
          'sql' => array(
            'FIELD_LOAD_CURRENT' => array(
              'field_data_field_detailed_question' => array(
                'value' => 'field_detailed_question_value',
                'format' => 'field_detailed_question_format',
              ),
            ),
            'FIELD_LOAD_REVISION' => array(
              'field_revision_field_detailed_question' => array(
                'value' => 'field_detailed_question_value',
                'format' => 'field_detailed_question_format',
              ),
            ),
          ),
        ),
      ),
      'foreign keys' => array(
        'format' => array(
          'table' => 'filter_format',
          'columns' => array(
            'format' => 'format',
          ),
        ),
      ),
      'indexes' => array(
        'format' => array(
          'format',
        ),
      ),
      'field_name' => 'field_detailed_question',
      'type' => 'text_long',
      'module' => 'text',
      'active' => '1',
      'locked' => '0',
      'cardinality' => '1',
      'deleted' => '0',
      'columns' => array(
        'value' => array(
          'type' => 'text',
          'size' => 'big',
          'not null' => FALSE,
        ),
        'format' => array(
          'type' => 'varchar',
          'length' => 255,
          'not null' => FALSE,
        ),
      ),
      'bundles' => array(
        'node' => array(
          'page',
        ),
      ),
    ),
  );
}

/**
 * Returns the detailed question field instance.
 */
function _faq_installed_instances() {
  $t = get_t();

  // Position in the question and answer page. Body (Answer) is 0 and Question (Title) is -4.
  return array(
    'detailed_question' => array(
      'label' => 'Detailed question',
      'widget' => array(
        'weight' => '-3',
        'type' => 'text_textarea',
        'module' => 'text',
        'active' => 1,
        'settings' => array(
          'rows' => '5',
        ),
      ),
      'settings' => array(
        'text_processing' => '1',
        'user_register_form' => FALSE,
      ),
      'display' => array(
        'default' => array(
          'label' => 'hidden',
          'type' => 'text_default',
          'weight' => '-3',
          'settings' => array(),
          'module' => 'text',
        ),
        'teaser' => array(
          'label' => 'hidden',
          'type' => 'text_default',
          'weight' => '-3',
          'settings' => array(),
          'module' => 'text',
        ),
      ),
      'required' => 0,
      'description' => 'Enter the detailed question text',
      'default_value' => NULL,
      'field_name' => 'field_detailed_question',
      'entity_type' => 'node',
      'bundle' => 'page',
      'deleted' => '0',
    ),
  );
}

/**
 * Cleanup custom fields on uninstall.
 */
function _faq_delete_custom_fields() {
  foreach (array_keys(_faq_installed_fields()) as $field) {
    field_delete_field($field);
  }
  $instances = field_info_instances('node', 'faq');
  foreach ($instances as $instance_name => $fieldinstance) {
    field_delete_instance($fieldinstance);
  }
}

/**
 * Shift fields down.
 */
function _faq_shift_fields_down() {

  // Adjust the weight of the field so that it is above the answer (body).
  $instance = field_read_instance('node', 'field_detailed_question', 'faq');

  // Get all bundle instances.
  $instances = field_info_instances('node', 'faq');
  $body_widget_weight = $instances['body']['widget']['weight'];
  $body_default_weight = $instances['body']['display']['default']['weight'];
  $body_teaser_weight = $instances['body']['display']['teaser']['weight'];

  // Move all of them one down so that.
  foreach ($instances as $field => $settings) {
    if ($settings['widget']['weight'] >= $body_widget_weight) {
      $settings['widget']['weight']++;
    }
    if ($settings['display']['default']['weight'] >= $body_default_weight) {
      $settings['display']['default']['weight']++;
    }
    if ($settings['display']['teaser']['weight'] >= $body_teaser_weight) {
      $settings['display']['teaser']['weight']++;
    }
    field_update_instance($settings);
  }
  $instance['widget']['weight'] = $body_widget_weight;
  $instance['display']['default']['weight'] = $body_default_weight;
  $instance['display']['teaser']['weight'] = $body_teaser_weight;
  field_update_instance($instance);
}

Functions

Name	Description
faq_install	Implements hook_install().
faq_schema	Define the 'faq_weights' and 'faq_questions' table structures.
faq_uninstall	Implements hook_uninstall().
faq_update_1	Create 'faq_weights' table in order to upgrade from older installations.
faq_update_2	Create 'faq_questions' table in order to upgrade from older installations.
faq_update_6003	Add the 'detailed_question' column to the 'faq_questions' table.
faq_update_7000	Make'detailed_question' column nullable.
faq_update_7001	Delete obsolete variables.
faq_update_7002	Convert old-style detailed questions to new fields.
faq_update_7003	Convert faq page description to array.
_faq_add_custom_fields	Code examples modified.
_faq_delete_custom_fields	Cleanup custom fields on uninstall.
_faq_installed_fields	Return the detailed question field definition.
_faq_installed_instances	Returns the detailed question field instance.
_faq_shift_fields_down	Shift fields down.