organism.views.inc 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. <?php
  2. /**
  3. * Purpose: this function returns the portion of the data array
  4. * which describes the organism table, it's fields and any joins between it and other tables
  5. * @see tripal_organism_views_data() --in tripal_organism.views.inc
  6. *
  7. * BASE TABLE: organism
  8. * @code
  9. * create table organism (
  10. * organism_id serial not null,
  11. * primary key (organism_id),
  12. * abbreviation varchar(255) null,
  13. * genus varchar(255) not null,
  14. * species varchar(255) not null,
  15. * common_name varchar(255) null,
  16. * comment text null,
  17. * constraint organism_c1 unique (genus,species)
  18. * );
  19. * @endcode
  20. */
  21. function retrieve_organism_views_data() {
  22. // Basic table definition
  23. $data['organism']['table']['group'] = 'Chado Organism';
  24. $data['organism']['table']['base'] = array(
  25. 'field' => 'organism_id',
  26. 'title' => 'Chado Organism',
  27. 'help' => 'Organisms existing in the Chado Database',
  28. 'database' => 'chado'
  29. );
  30. // Define relationships between this table and others
  31. $data['organism']['table']['join'] = array(
  32. 'feature' => array(
  33. 'left_field' => 'organism_id',
  34. 'field' => 'organism_id',
  35. ),
  36. 'library' => array(
  37. 'left_field' => 'organism_id',
  38. 'field' => 'organism_id',
  39. ),
  40. 'stock' => array(
  41. 'left_field' => 'organism_id',
  42. 'field' => 'organism_id',
  43. ),
  44. );
  45. // Table Field Definitions----------------------
  46. // Field: organism_id (primary key)
  47. $data['organism']['organism_id'] = array(
  48. 'title' => 'Organism ID',
  49. 'help' => 'The primary key of the organism.',
  50. 'field' => array(
  51. 'handler' => 'views_handler_field_numeric',
  52. 'click sortable' => TRUE,
  53. ),
  54. 'filter' => array(
  55. 'handler' => 'views_handler_filter_numeric',
  56. ),
  57. 'sort' => array(
  58. 'handler' => 'views_handler_sort',
  59. ),
  60. );
  61. // Calculated Field: Node ID
  62. // use custom field handler to query drupal for the node ID
  63. // this is only needed if chado is in a separate database from drupal
  64. $data['organism']['nid'] = array(
  65. 'title' => 'Node ID',
  66. 'help' => 'This is the node ID of this organism. It can be used as a link to the node.',
  67. 'field' => array(
  68. 'handler' => 'views_handler_field_organism_nid',
  69. ),
  70. );
  71. // Field: abbreviation (varchar 255)
  72. $data['organism']['abbreviation'] = array(
  73. 'title' => 'Abbreviation',
  74. 'help' => 'The abbreviation of the organism name ie: A.thaliana.',
  75. 'field' => array(
  76. 'handler' => 'views_handler_field',
  77. 'click sortable' => TRUE,
  78. ),
  79. 'sort' => array(
  80. 'handler' => 'views_handler_sort',
  81. ),
  82. 'filter' => array(
  83. 'handler' => 'views_handler_filter_string',
  84. ),
  85. 'argument' => array(
  86. 'handler' => 'views_handler_argument_string',
  87. ),
  88. );
  89. // Field: genus (varchar 255)
  90. $data['organism']['genus'] = array(
  91. 'title' => 'Genus',
  92. 'help' => 'The genus portion of the organism\'s scientific name',
  93. 'field' => array(
  94. 'handler' => 'views_handler_field',
  95. 'click sortable' => TRUE,
  96. ),
  97. 'sort' => array(
  98. 'handler' => 'views_handler_sort',
  99. ),
  100. 'filter' => array(
  101. 'handler' => 'views_handler_filter_string',
  102. ),
  103. 'argument' => array(
  104. 'handler' => 'views_handler_argument_string',
  105. ),
  106. );
  107. // Field: species (varchar 255)
  108. $data['organism']['species'] = array(
  109. 'title' => 'Species',
  110. 'help' => 'The species portion of the organism\'s scientific name',
  111. 'field' => array(
  112. 'handler' => 'views_handler_field',
  113. 'click sortable' => TRUE,
  114. ),
  115. 'sort' => array(
  116. 'handler' => 'views_handler_sort',
  117. ),
  118. 'filter' => array(
  119. 'handler' => 'views_handler_filter_string',
  120. ),
  121. 'argument' => array(
  122. 'handler' => 'views_handler_argument_string',
  123. ),
  124. );
  125. // Field: common name (varchar 255)
  126. $data['organism']['common_name'] = array(
  127. 'title' => 'Common Name',
  128. 'help' => 'The common name of the organism.',
  129. 'field' => array(
  130. 'handler' => 'views_handler_field',
  131. 'click sortable' => TRUE,
  132. ),
  133. 'sort' => array(
  134. 'handler' => 'views_handler_sort',
  135. ),
  136. 'filter' => array(
  137. 'handler' => 'views_handler_filter_string',
  138. ),
  139. 'argument' => array(
  140. 'handler' => 'views_handler_argument_string',
  141. ),
  142. );
  143. // Field: Comment (text)
  144. $data['organism']['comment'] = array(
  145. 'title' => 'Comment',
  146. 'help' => 'A free-text comment about the organism',
  147. 'field' => array(
  148. 'handler' => 'views_handler_field',
  149. 'click sortable' => TRUE,
  150. ),
  151. 'filter' => array(
  152. 'handler' => 'views_handler_filter_string',
  153. ),
  154. 'argument' => array(
  155. 'handler' => 'views_handler_argument_string',
  156. ),
  157. );
  158. return $data;
  159. }