tripal_core.chado_nodes.dbxrefs.api.inc 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698
  1. <?php
  2. /**
  3. * @file
  4. * API to manage the chado _dbxref table for various Tripal Node Types
  5. *
  6. * How To Use:
  7. * @code
  8. function chado_example_form($form, &$form_state) {
  9. // Default values for form elements can come in the following ways:
  10. //
  11. // 1) as elements of the $node object. This occurs when editing an existing node
  12. // 2) in the $form_state['values'] array which occurs on a failed validation or
  13. // ajax callbacks when the ajax call originates from non-submit fields other
  14. // than button
  15. // 3) in the $form_state['input'] array which occurs on ajax callbacks from submit
  16. // form elements (e.g. buttons) and the form is being rebuilt but has not yet
  17. // been validated
  18. //
  19. // The reference elements added by this function do use AJAX calls from buttons,
  20. // therefore, it is important to check for form values in the $form_state['values']
  21. // for case #2 above, and in the $form_state['input'] for case #3.
  22. // See the chado analysis node form for an example.
  23. // Next, add in all the form array definition particular to your node type
  24. // To add in the additional database reference form elements, you first need to prepare the arguments
  25. // for the function call.
  26. $details = array(
  27. 'linking_table' => 'example_dbxref', // the name of the table linking additional dbxrefs to this node
  28. 'base_foreign_key' => 'example_id', // key to link to the chado content created by this node
  29. 'base_key_value' => $example_id, // the value of the above key
  30. 'fieldset_title' => 'Additional References', // the non-translated title for this fieldset
  31. 'additional_instructions' => '' // a non-stranslated string providing additional instructions
  32. );
  33. // Finally, and add the additional form elements to the form
  34. chado_add_node_form_dbxrefs($form, $form_state, $details);
  35. return $form;
  36. }
  37. function chado_example_insert($node) {
  38. // if there is an example_id in the $node object then this must be a sync so
  39. // we can skip adding the chado_example as it is already there, although
  40. // we do need to proceed with the rest of the insert
  41. if (!property_exists($node, 'example_id')) {
  42. // Add record to chado example table
  43. // Add to any other tables needed
  44. // Add all additional database references
  45. // This function will create new database references as needed and select existing ones.
  46. // Existing _dbxref links will be cleared and then re-added
  47. chado_update_node_form_dbxrefs(
  48. $node, // the node object passed in via hook_insert()
  49. 'example_dbxref', // the name of the _dbxref linking table
  50. 'example_id', // key to link to the chado content created by this node
  51. $node->example_id // value of the above key
  52. );
  53. }
  54. // Add record to chado_example linking example_id to new node
  55. }
  56. function chado_example_update($node) {
  57. // Update record in chado example table
  58. // Update any other tables needed
  59. // Update all additional database references
  60. // This function will create new database references as needed and select existing ones.
  61. // Existing _dbxref links will be cleared and then re-added
  62. chado_update_node_form_dbxrefs(
  63. $node, // the node object passed in via hook_insert()
  64. 'example_dbxref', // the name of the _dbxref linking table
  65. 'example_id', // key to link to the chado content created by this node
  66. $node->example_id // value of the above key
  67. );
  68. // Don't need to update chado_example linking table since niether example_id or nid can be changed in update
  69. }
  70. * @endcode
  71. *
  72. * @ingroup tripal_chado_node_api
  73. */
  74. /**
  75. * @section
  76. * Additional Database References Form to be added to node forms
  77. */
  78. /**
  79. * Provides a form for adding to BASE_dbxref and dbxref tables
  80. *
  81. * @param $form
  82. * The Drupal form array into which the dbxref elements will be added
  83. * @param $form_state
  84. * The corresponding form_state array for the form
  85. * @param $details
  86. * An array defining details needed by this form. Required Keys are:
  87. * - linking_table: the name of the dbxref linking table (ie: feature_dbxref)
  88. * - base_foreign_key: the name of the foreign key linking this table to the non-dbxref table (ie: feature_id)
  89. * - base_key_value: the value of the base_foreign_key for the current form (ie: 999 if the feature_id=999)
  90. * Optional keys include:
  91. * - fieldset_title: the non-translated title for this fieldset
  92. * - additional_instructions: a non-translated string providing additional instructions
  93. * - select_options: must be an array where the [key] is a valid db_id and
  94. * the [value] is the human-readable name of the option. This includes all databases
  95. * in the chado db table by default
  96. *
  97. * @ingroup tripal_chado_node_api
  98. */
  99. function chado_add_node_form_dbxrefs(&$form, &$form_state, $details) {
  100. // Set defaults for optional fields
  101. $details['fieldset_title'] = 'External References';
  102. $details['additional_instructions'] = '';
  103. // Get the list of databases to display in the dropdown.
  104. if (isset($details['select_options'])) {
  105. // the callee has provided a list
  106. $db_options = $details['select_options'];
  107. }
  108. else {
  109. // get the list of databases from the db table
  110. $db_options = array(0 => 'Select a Database');
  111. $options = array('order_by' => array('name' => 'ASC'));
  112. $select = chado_select_record('db', array('db_id','name'), array(), $options);
  113. foreach($select as $db) {
  114. $db_options[$db->db_id] = $db->name;
  115. }
  116. }
  117. // Tell tripal administrators how to add terms to the property types drop down.
  118. $importance = (empty($db_options)) ? TRIPAL_WARNING : TRIPAL_INFO;
  119. $tripal_message = tripal_set_message(
  120. t('To add databases to the drop down list, you need to <a href="@dblink">add
  121. an external database reference</a>.',
  122. array(
  123. '@dblink' => url('admin/tripal/chado/tripal_db/add')
  124. )
  125. ),
  126. $importance,
  127. array('return_html' => TRUE)
  128. );
  129. // Group all of the chado node api fieldsets into vertical tabs.
  130. $form['chado_node_api'] = array(
  131. '#type' => 'vertical_tabs',
  132. '#attached' => array(
  133. 'css' => array(
  134. 'chado-node-api' => drupal_get_path('module', 'tripal_core') . '/theme/css/chado_node_api.css',
  135. ),
  136. ),
  137. );
  138. // the fieldset of the dbxref elements
  139. $form['addtl_dbxrefs'] = array(
  140. '#type' => 'fieldset',
  141. '#title' => t($details['fieldset_title']),
  142. '#description' => t('You may add additional database references by
  143. selecting a database reference type from the dropdown and adding text. You may add
  144. as many database references as desired by clicking the add button on the right. To
  145. remove a database reference, click the remove button. ' . $details['additional_instructions']),
  146. '#collapsible' => TRUE,
  147. '#collapsed' => TRUE,
  148. '#group' => 'chado_node_api',
  149. '#weight' => 9,
  150. '#attributes' => array('class' => array('chado-node-api','dbxrefs')),
  151. '#attached' => array(
  152. 'js' => array(
  153. 'chado-node-api-vertical-tabs' => drupal_get_path('module', 'tripal_core') . '/theme/js/chadoNodeApi_updateVerticalTabSummary.js',
  154. ),
  155. ),
  156. );
  157. $form['addtl_dbxrefs']['admin_message'] = array(
  158. '#type' => 'markup',
  159. '#markup' => $tripal_message
  160. );
  161. // this form element is a tree, so that we don't puke all of the values into then node variable
  162. // it is set as a tree, and keeps them in the $form_state['values']['dbxref_table'] heading.
  163. $form['addtl_dbxrefs']['dbxref_table'] = array(
  164. '#type' => 'markup',
  165. '#tree' => TRUE,
  166. '#prefix' => '<div id="tripal-generic-edit-addtl_dbxrefs-table">',
  167. '#suffix' => '</div>',
  168. '#theme' => 'chado_node_additional_dbxrefs_form_table'
  169. );
  170. /* DBxrefs can come to us in two ways:
  171. *
  172. * 1) In the form state in the $form_state['chado_additional_dbxrefs']. Data is in this field
  173. * when an AJAX call updates the form state or a validation error.
  174. *
  175. * 2) Directly from the database if the record already has dbxref's associated. This
  176. * data is only used the first time the form is loaded. On AJAX calls or validation
  177. * errors the fields on the form are populated from the $form_state['chado_additional_dbxrefs']
  178. * entry.
  179. */
  180. if (isset($form_state['chado_additional_dbxrefs'])) {
  181. $existing_dbxrefs = $form_state['chado_additional_dbxrefs'];
  182. }
  183. else {
  184. $existing_dbxrefs = chado_query(
  185. "SELECT
  186. db.name as db_name,
  187. db.db_id as db_id,
  188. dbxref.dbxref_id,
  189. dbxref.accession as accession,
  190. dbxref.description as description,
  191. dbxref.version
  192. FROM {dbxref} dbxref
  193. LEFT JOIN {db} db ON db.db_id = dbxref.db_id
  194. LEFT JOIN {".$details['linking_table']."} linking_table ON linking_table.dbxref_id = dbxref.dbxref_id
  195. WHERE linking_table.".$details['base_foreign_key']."= :base_key_value
  196. ORDER BY db.name ASC, dbxref.version ASC",
  197. array(':base_key_value' => $details['base_key_value'])
  198. );
  199. }
  200. /* The format of the $existing_dbxref's array is either:
  201. *
  202. * From the chado_additional_dbxrefs array:
  203. * $form_state['chado_additional_dbxrefs'] = array(
  204. * '[db_id]-[version]' => array(
  205. * 'db_id' => [the db.db_id value]
  206. * 'db_name' => [the db.name value]
  207. * 'dbxref_id' => [the dbxref.dbxref_id value, or temporary value if it doesn't yet exists],
  208. * 'version' => [the dbxref.version value],
  209. * 'accession' => [the dbxref.accession value],
  210. * ),
  211. * );
  212. *
  213. * OR
  214. * Populated from the database:
  215. * $existing_dbxref = array(
  216. * 0 => array(
  217. * 'dbxref_id' => [the dbxref.dbxref_id value],
  218. * 'db_name' => [the db.name value],
  219. * 'db_id' => [the db.db_id value],
  220. * 'accession' => [the dbxref.accession value],
  221. * 'description' => [the dbxref.description value],
  222. * 'version' => [the dbxref.versiion value],
  223. * ),
  224. * );
  225. *
  226. * NOTE: The main difference is the key
  227. *
  228. * Loop on the array elements of the $existing_dbxrefs array and add
  229. * an element to the form for each one.
  230. */
  231. $num_dbxrefs = 0;
  232. foreach ($existing_dbxrefs as $dbxref) {
  233. if (array_key_exists($dbxref->db_id, $db_options)) {
  234. $num_dbxrefs++;
  235. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id]['#type'] = 'markup';
  236. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id]['#value'] = '';
  237. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['#type'] = 'markup';
  238. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['#value'] = '';
  239. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['#attributes'] = array(
  240. 'class' => array('dbxref', 'saved')
  241. );
  242. // Determine whether this dbxref is unsaved or not.
  243. // We can tell this by looking at the dbxref_id: if it's not
  244. // saved yet we will have entered a TEMP###.
  245. if (preg_match('/^TEMP/', $dbxref->dbxref_id)) {
  246. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['#attributes'] = array(
  247. 'class' => array('dbxref', 'unsaved')
  248. );
  249. }
  250. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['db_id'] = array(
  251. '#type' => 'hidden',
  252. '#value' => $dbxref->db_id
  253. );
  254. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['accession'] = array(
  255. '#type' => 'hidden',
  256. '#value' => $dbxref->accession
  257. );
  258. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['version'] = array(
  259. '#type' => 'hidden',
  260. '#value' => $dbxref->version,
  261. );
  262. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['dbxref_id'] = array(
  263. '#type' => 'hidden',
  264. '#value' => $dbxref->dbxref_id
  265. );
  266. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['db'] = array(
  267. '#type' => 'markup',
  268. '#markup' => $dbxref->db_name
  269. );
  270. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['dbxref_version'] = array(
  271. '#type' => 'markup',
  272. '#markup' => $dbxref->version,
  273. );
  274. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['dbxref_accession'] = array(
  275. '#type' => 'markup',
  276. '#markup' => $dbxref->accession
  277. );
  278. // remove button
  279. $form['addtl_dbxrefs']['dbxref_table'][$dbxref->db_id][$dbxref->dbxref_id]['dbxref_action'] = array(
  280. '#type' => 'submit',
  281. '#value' => t('Remove'),
  282. '#name' => "dbxrefs_remove-".$dbxref->db_id.'-'.$dbxref->dbxref_id,
  283. '#ajax' => array(
  284. 'callback' => "chado_add_node_form_subtable_ajax_update",
  285. 'wrapper' => 'tripal-generic-edit-addtl_dbxrefs-table',
  286. 'effect' => 'fade',
  287. 'method' => 'replace',
  288. 'prevent' => 'click'
  289. ),
  290. // When this button is clicked, the form will be validated and submitted.
  291. // Therefore, we set custom submit and validate functions to override the
  292. // default node form submit. In the validate function we validate only the
  293. // additional dbxref fields and in the submit we remove the indicated dbxref
  294. // from the chado_additional_dbxrefs array. In order to keep validate errors
  295. // from the node form validate and Drupal required errors for non-dbxref fields
  296. // preventing the user from removing dbxrefs we set the #limit_validation_errors below
  297. '#validate' => array('chado_add_node_form_subtables_remove_button_validate'),
  298. '#submit' => array('chado_add_node_form_subtables_remove_button_submit'),
  299. // Limit the validation of the form upon clicking this button to the dbxref_table tree
  300. // No other fields will be validated (ie: no fields from the main form or any other api
  301. // added form).
  302. '#limit_validation_errors' => array(
  303. array('dbxref_table') // Validate all fields within $form_state['values']['dbxref_table']
  304. )
  305. );
  306. }
  307. }
  308. // Quickly add a hidden field stating how many dbxrefs are currently added.
  309. $form['addtl_dbxrefs']['num_dbxrefs'] = array(
  310. '#type' => 'hidden',
  311. '#value' => $num_dbxrefs,
  312. '#attributes' => array('class' => 'num-dbxrefs')
  313. );
  314. // Form elements for adding a new dbxref
  315. //---------------------------------------------
  316. $form['addtl_dbxrefs']['dbxref_table']['new'] = array(
  317. '#type' => 'markup',
  318. '#prefix' => '<span class="addtl-dbxrefs-add-new-dbxref">',
  319. '#suffix' => '</span>'
  320. );
  321. // add in the existing databases
  322. $form['addtl_dbxrefs']['dbxref_table']['new']['db'] = array(
  323. '#type' => 'select',
  324. '#options' => $db_options,
  325. );
  326. $form['addtl_dbxrefs']['dbxref_table']['new']['dbxref_accession'] = array(
  327. '#type' => 'textfield',
  328. );
  329. $form['addtl_dbxrefs']['dbxref_table']['new']['dbxref_version'] = array(
  330. '#type' => 'textfield',
  331. '#size' => 10,
  332. );
  333. // add button
  334. $form['addtl_dbxrefs']['dbxref_table']['new']['dbxref_action'] = array(
  335. '#type' => 'submit',
  336. '#value' => t('Add'),
  337. '#name' => "dbxrefs-add",
  338. '#ajax' => array(
  339. 'callback' => "chado_add_node_form_subtable_ajax_update",
  340. 'wrapper' => 'tripal-generic-edit-addtl_dbxrefs-table',
  341. 'effect' => 'fade',
  342. 'method' => 'replace',
  343. 'prevent' => 'click'
  344. ),
  345. // When this button is clicked, the form will be validated and submitted.
  346. // Therefore, we set custom submit and validate functions to override the
  347. // default node form submit. In the validate function we validate only the
  348. // additional dbxref fields and in the submit we add them to the chado_additional_dbxrefs
  349. // array. In order to keep validate errors from the node form validate and Drupal
  350. // required errors for non-dbxref fields preventing the user from adding dbxrefs we
  351. // set the #limit_validation_errors below
  352. '#validate' => array('chado_add_node_form_subtables_add_button_validate'),
  353. '#submit' => array('chado_add_node_form_subtables_add_button_submit'),
  354. // Limit the validation of the form upon clicking this button to the dbxref_table tree
  355. // No other fields will be validated (ie: no fields from the main form or any other api
  356. // added form).
  357. '#limit_validation_errors' => array(
  358. array('dbxref_table') // Validate all fields within $form_state['values']['dbxref_table']
  359. )
  360. );
  361. }
  362. /**
  363. * Validate the user input for creating a new dbxref
  364. * Called by the add button in chado_add_node_form_dbxrefs
  365. *
  366. * @ingroup tripal_core
  367. */
  368. function chado_add_node_form_dbxrefs_add_button_validate($form, &$form_state) {
  369. // Ensure the db_id is supplied & Valid
  370. $db = chado_select_record(
  371. 'db',
  372. array('db_id', 'name'),
  373. array('db_id' => $form_state['values']['dbxref_table']['new']['db'])
  374. );
  375. if (!isset($db[0])) {
  376. form_set_error('dbxref_table][new][db', 'Please select a database before attempting to add a new database reference.');
  377. }
  378. else {
  379. $form_state['values']['dbxref_table']['new']['db_name'] = $db[0]->name;
  380. }
  381. // Ensure accession is supplied
  382. if (empty($form_state['values']['dbxref_table']['new']['dbxref_accession'])) {
  383. form_set_error('dbxref_table][new][dbxref_accession','You must enter the accession before attempting to add a new database reference.');
  384. }
  385. }
  386. /**
  387. * Called by the add button in chado_add_node_form_dbxrefs
  388. *
  389. * Create an array of additional dbxrefs in the form state. This array will then be
  390. * used to rebuild the form in subsequent builds
  391. *
  392. * @ingroup tripal_core
  393. */
  394. function chado_add_node_form_dbxrefs_add_button_submit($form, &$form_state) {
  395. // if the chado_additional_dbxrefs array is not set then this is the first time modifying the
  396. // dbxref table. this means we need to include all the dbxrefs from the db
  397. if (!isset($form_state['chado_additional_dbxrefs'])) {
  398. chado_add_node_form_dbxrefs_create_dbxref_formstate_array($form, $form_state);
  399. }
  400. // get details for the new dbxref
  401. $dbxref = array(
  402. 'db_id' => $form_state['values']['dbxref_table']['new']['db'],
  403. 'db_name' => $form_state['values']['dbxref_table']['new']['db_name'],
  404. 'dbxref_id' => 'TEMP' . uniqid(),
  405. 'version' => $form_state['values']['dbxref_table']['new']['dbxref_version'],
  406. 'accession' => $form_state['values']['dbxref_table']['new']['dbxref_accession'],
  407. );
  408. $key = $dbxref['db_id'] . '-' . $dbxref['dbxref_id'];
  409. $form_state['chado_additional_dbxrefs'][$key] = (object) $dbxref;
  410. // we don't want the new element to pick up the values from the previous element so wipe them out
  411. unset($form_state['input']['dbxref_table']['new']['db']);
  412. unset($form_state['input']['dbxref_table']['new']['db_name']);
  413. unset($form_state['input']['dbxref_table']['new']['dbxref_version']);
  414. unset($form_state['input']['dbxref_table']['new']['dbxref_accession']);
  415. }
  416. /**
  417. * Called by the many remove buttons in chado_add_node_form_dbxrefs
  418. *
  419. * @ingroup tripal_core
  420. */
  421. function chado_add_node_form_dbxrefs_remove_button_validate($form, $form_state) {
  422. // No validation needed.
  423. }
  424. /**
  425. * Remove the correct dbxref from the form
  426. * Called by the many remove buttons in chado_add_node_form_dbxrefs
  427. *
  428. * @ingroup tripal_core
  429. */
  430. function chado_add_node_form_dbxrefs_remove_button_submit(&$form, &$form_state) {
  431. // if the chado_additional_dbxrefs array is not set then this is the first time modifying the
  432. // dbxref table. this means we need to include all the dbxrefs from the db
  433. if (!isset($form_state['chado_additional_dbxrefs'])) {
  434. chado_add_node_form_dbxrefs_create_dbxref_formstate_array($form, $form_state);
  435. }
  436. // remove the specified dbxref from the form dbxref table
  437. if(preg_match('/dbxrefs_remove-([^-]+-[^-]+)/',$form_state['triggering_element']['#name'],$match)) {
  438. $key = $match[1];
  439. if (array_key_exists($key, $form_state['chado_additional_dbxrefs'])) {
  440. unset($form_state['chado_additional_dbxrefs'][$key]);
  441. }
  442. }
  443. }
  444. /**
  445. * Creates an array in form_state containing the existing addtl_dbxrefs. This array is
  446. * then modified by the add/remove buttons and used as a source for rebuilding the form.
  447. * This function get's called at each button (add and remove) button submits the first
  448. * time one of the button's is clicked to instantiates the $form_state['chado_additional_dbxrefs'] array
  449. *
  450. * $form_state['chado_additional_dbxrefs'] = array(
  451. * '[db_id]-[version]' => array(
  452. * 'db_id' => [the db.db_id value]
  453. * 'db_name' => [the db.name value]
  454. * 'dbxref_id' => [the dbxref.dbxref_id value, or temporary value if it doesn't yet exists],
  455. * 'version' => [the dbxref.version value],
  456. * 'accession' => [the dbxref.accession value],
  457. * ),
  458. * );
  459. *
  460. * @ingroup tripal_core
  461. */
  462. function chado_add_node_form_dbxrefs_create_dbxref_formstate_array($form, &$form_state) {
  463. $form_state['chado_additional_dbxrefs'] = array();
  464. foreach (element_children($form['addtl_dbxrefs']['dbxref_table']) as $db_id) {
  465. if ($db_id != 'new') {
  466. foreach (element_children($form['addtl_dbxrefs']['dbxref_table'][$db_id]) as $version) {
  467. $element = $form['addtl_dbxrefs']['dbxref_table'][$db_id][$version];
  468. $dbxref = array(
  469. 'db_id' => $element['db_id']['#value'],
  470. 'db_name' => $element['db']['#markup'],
  471. 'dbxref_id' => $element['dbxref_id']['#value'],
  472. 'version' => $element['dbxref_version']['#markup'],
  473. 'accession' => $element['dbxref_accession']['#markup'],
  474. );
  475. $key = $dbxref['db_id'] . '-' . $dbxref['dbxref_id'];
  476. $form_state['chado_additional_dbxrefs'][$key] = (object) $dbxref;
  477. }
  478. }
  479. }
  480. }
  481. /**
  482. * Function to theme the add/remove dbxrefs form into a table
  483. *
  484. * @ingroup tripal_chado_node_api
  485. */
  486. function theme_chado_add_node_form_dbxrefs_table($variables) {
  487. $element = $variables['element'];
  488. $header = array(
  489. 'db' => t('Database'),
  490. 'dbxref_accession' => t('Accession'),
  491. 'dbxref_version' => t('Version'),
  492. 'dbxref_action' => t('Actions'),
  493. );
  494. $rows = array();
  495. foreach (element_children($element) as $db_id) {
  496. if ($db_id == 'new') {
  497. $row = array();
  498. $row['data'] = array();
  499. foreach ($header as $fieldname => $title) {
  500. $row['data'][] = drupal_render($element[$db_id][$fieldname]);
  501. }
  502. $rows[] = $row;
  503. }
  504. else {
  505. foreach (element_children($element[$db_id]) as $version) {
  506. $row = array();
  507. $row['data'] = array();
  508. $row['class'] = $element[$db_id][$version]['#attributes']['class'];
  509. foreach ($header as $fieldname => $title) {
  510. $row['data'][] = drupal_render($element[$db_id][$version][$fieldname]);
  511. }
  512. $rows[] = $row;
  513. }
  514. }
  515. }
  516. return theme('table', array(
  517. 'header' => $header,
  518. 'rows' => $rows
  519. ));
  520. }
  521. /**
  522. * This function is used in a hook_insert, hook_update for a node form
  523. * when the additional_dbxrefs form has been added to the form. It retrieves all of the dbxrefs
  524. * and returns them in an array of the format:
  525. *
  526. * $dbxefs[<db_id>][<version>][<dbxref_id>] = <accession>
  527. *
  528. * This array can then be used for inserting or updating dbxrefs using the API call
  529. * tripal_hook_insert_dbxref()
  530. *
  531. * @param $node
  532. *
  533. * @return
  534. * A dbxref array
  535. *
  536. * @ingroup tripal_chado_node_api
  537. */
  538. function chado_retrieve_node_form_dbxrefs($node) {
  539. $dbxrefs = array();
  540. if (isset($node->dbxref_table)) {
  541. foreach ($node->dbxref_table as $db_id => $elements) {
  542. if ($db_id != 'new') {
  543. foreach ($elements as $dbxref_id => $dbxref) {
  544. $version = (!empty($dbxref['version'])) ? $dbxref['version'] : 'NONE';
  545. $dbxrefs[$db_id][$version][$dbxref_id] = $dbxref['accession'];
  546. }
  547. }
  548. }
  549. }
  550. return $dbxrefs;
  551. }
  552. /**
  553. * This function is used in hook_insert or hook_update and handles inserting of any new
  554. * dbxrefs and creation of links between those dbxrefs and node content
  555. *
  556. * @param $node
  557. * The node passed into hook_insert & hook_update
  558. * @param $details
  559. * - linking_table: the name of the _dbxref linking table (ie: feature_dbxref)
  560. * - foreignkey_name: the name of the foreign key used to link to the node content (ie: feature_id)
  561. * - foreignkey_value: the value of the foreign key (ie: 445, if there exists a feature where feature_id=445)
  562. * @param $retrieved_dbxrefs
  563. * An array of databa references from chado_retrieve_node_form_dbxrefs($node).
  564. * This can be used if you need special handling for some of the database references
  565. *
  566. * @ingroup tripal_chado_node_api
  567. */
  568. function chado_update_node_form_dbxrefs($node, $details, $retrieved_dbxrefs = FALSE) {
  569. $linking_table = $details['linking_table'];
  570. $foreignkey_name = $details['foreignkey_name'];
  571. $foreignkey_value = $details['foreignkey_value'];
  572. if (isset($node->dbxref_table) AND ($foreignkey_value > 0)) {
  573. // First remove existing dbxref links
  574. chado_delete_record($linking_table, array($foreignkey_name => $foreignkey_value));
  575. // Add back in dbxref links and insert dbxrefs as needed
  576. if ($retrieved_dbxrefs) {
  577. $dbxrefs = $retrieved_dbxrefs;
  578. }
  579. else {
  580. $dbxrefs = chado_retrieve_node_form_dbxrefs($node);
  581. }
  582. foreach ($dbxrefs as $db_id => $versions) {
  583. foreach ($versions as $version => $elements) {
  584. foreach ($elements as $dbxref_id => $accession) {
  585. // If there is no dbxref then we have to create that first
  586. if (preg_match('/^TEMP/',$dbxref_id)) {
  587. $version = ($version == 'NONE') ? '' : $version;
  588. $success = tripal_insert_dbxref(array(
  589. 'db_id' => $db_id,
  590. 'accession' => $accession,
  591. 'version' => $version,
  592. 'description' => NULL
  593. ));
  594. if ($success) {
  595. $dbxref_id = $success->dbxref_id;
  596. }
  597. else {
  598. $dbxref_id = FALSE;
  599. }
  600. }
  601. // add _dbxref linker
  602. if ($dbxref_id) {
  603. if (preg_match('/(\w+)_dbxref/',$linking_table,$matches)) {
  604. $base_table = $matches[1];
  605. $success_link = tripal_associate_dbxref(
  606. $base_table,
  607. $foreignkey_value,
  608. array('dbxref_id' => $dbxref_id)
  609. );
  610. }
  611. }
  612. }
  613. }
  614. }
  615. }
  616. }