tripal/tripal_contact/tripal_contact.install

<?php

/**
 * @file
 * Handles install, uninstall, disable and enable functionality including database tables.
 *
 * @ingroup tripal_contact
 */

/**
 * Implements hook_disable().
 * Disable default views when module is disabled
 *
 * @ingroup tripal_contact
 */
function tripal_contact_disable() {

  // Disable all default views provided by this module
  require_once("tripal_contact.views_default.inc");
  $views = tripal_contact_views_default_views();
  foreach (array_keys($views) as $view_name) {
    tripal_views_admin_disable_view($view_name,FALSE,array('suppress_error' => TRUE));
  }

}

/**
 * Implementation of hook_requirements().
 *
 * @ingroup tripal_contact
 */
function tripal_contact_requirements($phase) {
  $requirements = array();
  if ($phase == 'install') {
    // make sure chado is installed
    if (!$GLOBALS["chado_is_installed"]) {
      $requirements ['tripal_contact'] = array(
        'title' => "tripal_contact",
        'value' => "ERROR: Chado must be installed before this module can be enabled",
        'severity' => REQUIREMENT_ERROR,
      );
    }
  }
  return $requirements;
}

/**
 * Implementation of hook_install().
 *
 * @ingroup tripal_contact
 */
function tripal_contact_install() {

  // create the module's data directory
  tripal_create_files_dir('tripal_contact');

  // add the contactprop table to Chado
  tripal_contact_add_custom_tables();

  // add loading of the the tripal contact ontology to the job queue
  $obo_path = drupal_realpath(drupal_get_path('module', 'tripal_contact') . '/files/tcontact.obo');
  $obo_id = tripal_cv_add_obo_ref('Tripal Contacts', $obo_path);
  tripal_cv_submit_obo_job($obo_id);

  // Add cvterms for relationship types
  tripal_contact_add_cvs();
  tripal_contact_add_cvterms();

  /*
  // Install our custom block visibility settings per node type
  $query = db_insert('block_node_type')
    ->fields(array('type', 'module', 'delta'))
    ->values(array(
      'type'   => 'chado_contact',
      'module' => 'tripal_contact', // My module name
      'delta'  => 'contbase', // Same delta used in hook_block_info
    )
  )->execute();
  */
}

/**
 * Implementation of hook_uninstall().
 *
 * @ingroup tripal_contact
 */
function tripal_contact_uninstall() {
  /*
  // remove our custom block visibility settings per node type
  db_delete('block_node_type')
    ->condition('module', 'chado_contact')
    ->condition('delta', 'contbase')
    ->execute();
    */
}

/**
 * Adds any cvs needed by this module.
 *
 * @ingroup tripal_contact
 */
function tripal_contact_add_cvs() {

  tripal_cv_add_cv(
    'contact_relationship_types',
    'Contains Types of relationships between contacts.'
  );

}

/**
 * Adds any cvterms needed by this module.
 *
 * @ingroup tripal_contact
 */
function tripal_contact_add_cvterms() {

}

/**
 * Implementation of hook_schema().
 *
 * @ingroup tripal_contact
 */
function tripal_contact_schema() {
  $schema['chado_contact'] = array(
    'fields' => array(
      'vid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0
      ),
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0
      ),
      'contact_id' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0
      )
    ),
    'indexes' => array(
      'contact_id' => array('contact_id')
    ),
    'unique keys' => array(
      'nid_vid' => array('nid', 'vid'),
      'vid' => array('vid')
    ),
    'primary key' => array('nid'),
  );
  return $schema;
}

/**
 * Add any custom tables needed by this module.
 * - Contactprop: keep track of properties of contact
 *
 * @ingroup tripal_contact
 */
function tripal_contact_add_custom_tables(){
  $schema = array (
    'table' => 'contactprop',
    'fields' => array (
      'contactprop_id' => array (
        'type' => 'serial',
        'not null' => true,
      ),
      'contact_id' => array (
        'type' => 'int',
        'not null' => true,
      ),
      'type_id' => array (
        'type' => 'int',
        'not null' => true,
      ),
      'value' => array (
        'type' => 'text',
        'not null' => false,
      ),
      'rank' => array (
        'type' => 'int',
        'not null' => true,
        'default' => 0,
      ),
    ),
    'primary key' => array (
      0 => 'contactprop_id',
    ),
    'unique keys' => array (
      'contactprop_c1' => array (
        0 => 'contact_id',
        1 => 'type_id',
        2 => 'rank',
      ),
    ),
    'indexes' => array (
      'contactprop_idx1' => array (
        0 => 'contact_id',
      ),
      'contactprop_idx2' => array (
        0 => 'type_id',
      ),
    ),
    'foreign keys' => array (
      'cvterm' => array (
        'table' => 'cvterm',
        'columns' => array (
          'type_id' => 'cvterm_id',
        ),
      ),
      'contact' => array (
        'table' => 'contact',
        'columns' => array (
          'contact_id' => 'contact_id',
        ),
      ),
    ),
  );
  chado_create_custom_table('contactprop', $schema, TRUE);
}

/**
 * This is the required update for tripal_contact when upgrading from Drupal core API 6.x.
 *
 * @ingroup tripal_contact
 */
function tripal_contact_update_7200() {

  // add the new contact_relationship_types vocabulary
  // We cannot use the Tripal API calls in the 7000 update 
  // because during upgrade the tripal_core should also be disabled
  try {
    $check = db_query("SELECT cv_id FROM chado.cv WHERE name = 'contact_relationship_types'")->fetchObject();
    if (!$check->cv_id) {
      $sql = "INSERT INTO chado.cv (name, definition) VALUES (
        'contact_relationship_types',
        'Contains Types of relationships between contacts.')
      ";
      db_query($sql);
    }
  }
  catch (\PDOException $e) {
    $error = $e->getMessage();
    throw new DrupalUpdateException('Failed to add contact_relationship_types vocabulary: '. $error);
  }
}