tripal/tripal_pub/views/template.table_defn.views.inc

<?php

/*************************************************************************
 * @file: THIS IS A TEMPLATE AND SHOULD NOT BE INCLUDED IN THE MODULE CODE
 *
 *   - Every instance of XXX should be replaced with the name of your table
 *   - If this is a base table (you want a view where every row is a row from this table)
 *     then change $data['XXX']['table'] to $data['XXX']['table']['base'] 
 *     and $data['XXX']['table']['database'] to $data['XXX']['table']['base']['database']
 *   - Relationships between this table and others: YYY is the table you are trying to join to this
 *     one. You want to join a table to this one if this table contains a foreign key to the other
 *     table. If the join between this table and another is through a linking table
 *     (ie: library-XXX/YYY => library_feature-XY => feature-XXX/YYY) then make the join in both
 *     directions (ie: in the file XXX.views.inc and the file YYY.views.inc
 *   - Create a field definition for each field in this table using the example fields already
 *     listed. Match the type of the database field to the field definition listed below.
 *     (ie: for a text/varchar field from the database use plain_text_field below)
 * 
 *  NOTE: Creating the table definition file is not enough. You also need to call the 
 *        retrieve_XXX_views_data() function from ../tripal_pub.views.inc:tripal_pub_views_data()
 *        by adding the following line:
 *           $data = array_merge($data, retrieve_XXX_views_data());
 *        to the function and including the file directly above the function (blow the function 
 *        header by adding:
 *           require_once('views/XXX.views.inc');
 *
 *  REMOVE THIS COMMENT IN THE COPY!
 */ 
 
/**
 *  @file
 *  This file defines the data array for a given chado table. This array
 *  is merged into a larger array containing definitions of all tables associated
 *  with this module in:
 *  @see tripal_pub.views.inc --in tripal_pub_views_data()
 *
 *  Documentation on views integration can be found at 
 *  http://views2.logrus.com/doc/html/index.html.
 */

/*************************************************************************
 * Purpose: this function returns the portion of the data array 
 *   which describes the XXX table, it's fields and any joins between it and other tables
 * @see tripal_pub_views_data() --in tripal_pub.views.inc
 *
 * Table: XXX
 * @code
 * XXX-Copy/Paste Table SQL code here-XXX
 * @endcode
 */
 function retrieve_XXX_views_data() {
  global $db_url;
  $data = array();

  // if the chado database is not local to the drupal database
  // then we need to set the database name.  This should always
  // be 'chado'.
  if(is_array($db_url) and array_key_exists('chado',$db_url)){
    $database = 'chado';
  }
   
  //Basic table definition-----------------------------------
  $data['XXX']['table']['group'] = t('Chado XXX');
  
  $data['XXX']['table'] = array(
    'field' => 'primary_id',
    'title' => t('Chado XXX'),
    'help' => t('Enter some user-friendly description of this tables purpose to the user.'),
  );
  if($database){
     $data['XXX']['table']['database'] = $database;
  }

  
  //Relationship Definitions---------------------------------
  //Join: YYY => XXX
  // Notice that this relationship tells the primary table to show it's fields to the
  // table referencing it by a foreign key and thus the relationship is from
  // primary table to table referenceing it (ie: cvterm => feature)
  $data['XXX']['table']['join']['YYY'] = array(
    'left_field' => 'foreign key in YYY table',
    'field' => 'primary key in XXX table',
  );  
  
  //Join: XXX => XY => YYY
  // This relationship should be described in both directions
  // in the appropriate files (ie: for feature => library 
  // describe in both feature.views.inc and library.views.inc)
  $data['XXX']['table']['join']['XY'] = array(
    'left_field' => 'matching XXX key in the XY table',
    'field' => 'primary key in XXX table',
  );  
  $data['XXX']['table']['join']['YYY'] => array(
    'left_table' => 'XY',
    'left_field' => 'matching XXX key in the XY table',
    'field' => 'primary key in XXX table',
  );
  $data['XY']['table']['join']['YYY'] = array(
    'left_field' => 'primary key in YYY table',
    'field' => 'matching YYY key in the XY table',
  );
   
  //Table Field Definitions----------------------------------
      
  //Field: XXX_id (primary key)
  $data['XXX']['field_name'] = array(
    'title' => t('XXX Primary Key'),
    'help' => t('A unique index for every XXX.'),
    'field' => array(
      'handler' => 'views_handler_field_numeric',
      'click sortable' => TRUE,
     ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
  );

  /*.......................................................
   * Beginning of Example Field definitions
   * Remove this section when done
   */

  //Field: plain_text_field (chado datatype)   
  $data['XXX']['plain_text_field'] = array(
    'title' => t('Human-Readable Name'),
    'help' => t('Description of this field.'),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE,
     ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );

  //Field: numeric_field (chado datatype)   
  $data['XXX']['numeric_field'] = array(
    'title' => t('Human-Readable Name'),
    'help' => t('Description of this field.'),
    'field' => array(
      'handler' => 'views_handler_field_numeric',
      'click sortable' => TRUE,
     ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
  );

  //Field: boolean_field (chado datatype)   
  $data['XXX']['boolean_field'] = array(
    'title' => t('Human-Readable Name'),
    'help' => t('Description of this field.'),
    'field' => array(
      'handler' => 'views_handler_field_boolean',
      'click sortable' => TRUE,
     ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_boolean_operator',
    ),
  );

  //Field: unix_timestamp (chado datatype)   
  $data['XXX']['unix_timestamp'] = array(
    'title' => t('Human-Readable Name'),
    'help' => t('Description of this field.'),
    'field' => array(
      'handler' => 'views_handler_field_date',
      'click sortable' => TRUE,
     ),
    'sort' => array(
      'handler' => 'views_handler_sort_date',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_date',
    ),
  );

  //Field: human_readable_date (chado datatype)   
  $data['XXX']['human_readable_date'] = array(
    'title' => t('Human-Readable Name'),
    'help' => t('Description of this field.'),
    'field' => array(
      'handler' => 'views_handler_field_readble_date',
      'click sortable' => TRUE,
     ),
    'sort' => array(
      'handler' => 'views_handler_sort_date',
    ),
  );
   
   /*
    * End of Example Field definitions
    *......................................................./
    
  return $data;
}