tripal_stock-properties.inc

@todo Add file header description

File

tripal_stock/includes/tripal_stock-properties.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * @todo Add file header description
  5. */
  6. /**
  7. *
  8. *
  9. * @ingroup tripal_stock
  10. */
  11. function tripal_stock_add_ALL_property_page($node) {
  12. $output = '';
  13. $output .= tripal_stock_add_chado_properties_progress('properties') . '<br />';
  14. $output .= '<b>All Properties should strictly pertain to THE CURRENT Individual</b><br />';
  15. $output .= '<br />';
  16. $output .= theme('tripal_stock_properties', $node);
  17. $output .= '<br /><br />';
  18. $output .= drupal_get_form('tripal_stock_add_ONE_property_form', $node);
  19. $output .= '<br />';
  20. $output .= drupal_get_form('tripal_stock_add_chado_properties_navigate', 'properties', $node->nid);
  21. return $output;
  22. }
  23. /**
  24. *
  25. *
  26. * @ingroup tripal_stock
  27. */
  28. function tripal_stock_add_ONE_property_form($form_state, $node) {
  29. $form = array();
  30. $stock_id = $node->stock->stock_id;
  31. $form['add_properties'] = array(
  32. '#type' => 'fieldset',
  33. '#title' => t('Add Property') . '<span class="form-optional" title="This field is optional"> (optional)</span>',
  34. );
  35. $form['prop_nid'] = array(
  36. '#type' => 'hidden',
  37. '#value' => $node->nid
  38. );
  39. $tmp_obj = tripal_cv_get_cvterm_by_name('synonym', variable_get('chado_stock_prop_types_cv', 'null'));
  40. $synonym_id = $tmp_obj->cvterm_id;
  41. $prop_type_options = tripal_cv_get_cvterm_options( variable_get('chado_stock_prop_types_cv', 'null') );
  42. $prop_type_options[0] = 'Select a Type';
  43. ksort($prop_type_options);
  44. $form['add_properties']['prop_type_id'] = array(
  45. '#type' => 'select',
  46. '#title' => t('Type of Property'),
  47. '#options' => $prop_type_options,
  48. );
  49. $form['add_properties']['prop_value'] = array(
  50. '#type' => 'textfield',
  51. '#title' => t('Value') . '<span class="form-optional" title="This field is optional">+</span>',
  52. );
  53. $form['add_properties']['preferred_synonym'] = array(
  54. '#type' => 'checkbox',
  55. '#title' => t('Preferred Synonym (only applicable if type is synonym)'),
  56. );
  57. $form['add_properties']['prop_stock_id'] = array(
  58. '#type' => 'value',
  59. '#value' => $stock_id,
  60. '#required' => TRUE
  61. );
  62. $form['add_properties']['submit-add'] = array(
  63. '#type' => 'submit',
  64. '#value' => t('Add Property')
  65. );
  66. return $form;
  67. }
  68. /**
  69. *
  70. *
  71. * @ingroup tripal_stock
  72. */
  73. function tripal_stock_add_ONE_property_form_validate($form, &$form_state) {
  74. // Only Require if Adding Property
  75. if ($form_state['clicked_button']['#value'] == t('Add Property') ) {
  76. // Check that there is a stock
  77. if ( $form_state['values']['prop_stock_id'] <= 0 ) {
  78. form_set_error('prop_stock_id', 'There is no associated stock.');
  79. }
  80. // Check that Selected a type
  81. if ( $form_state['values']['prop_type_id'] == 0) {
  82. form_set_error('prop_type_id', 'Please select a type of property.');
  83. }
  84. else {
  85. // Check that type is in chado
  86. $num_rows = db_fetch_object(chado_query("SELECT count(*) as count FROM {cvterm} WHERE cvterm_id=%d", $form_state['values']['prop_type_id']));
  87. if ( $num_rows->count != 1) {
  88. form_set_error('prop_type_id', "The type you selected is not valid. Please choose another one. (CODE:$num_rows)");
  89. } // end of if more or less than 1 row
  90. } // if no prop type
  91. // only check preferred synonym if type is synonym
  92. if ($form_state['values']['preferred_synonym'] == 1) {
  93. $tmp_obj = tripal_cv_get_cvterm_by_name('synonym', variable_get('chado_stock_prop_types_cv', 'null'));
  94. if ($form_state['values']['prop_type_id'] != $tmp_obj->cvterm_id) {
  95. form_set_error('preferred_synonym', 'Preferred Synonym Checkbox Only Applicable if Type of Property is Synonym');
  96. }
  97. }
  98. } // if add Property
  99. }
  100. /**
  101. *
  102. *
  103. * @ingroup tripal_stock
  104. */
  105. function tripal_stock_add_ONE_property_form_submit($form, &$form_state) {
  106. // if there is a property add it (only won't be a property if clicked next step w/ no property)
  107. if ($form_state['values']['prop_type_id'] != 0) {
  108. //determine the rank for this property
  109. $max_rank = get_max_chado_rank('stockprop',
  110. array('stock_id' => array('type' => 'INT', 'value' => $form_state['values']['prop_stock_id']),
  111. 'type_id' => array('type' => 'INT', 'value' => $form_state['values']['prop_type_id']) ));
  112. if ($max_rank == -1) {
  113. $rank = 0;
  114. }
  115. else { $rank = $max_rank+1; }
  116. chado_query(
  117. "INSERT INTO {stockprop} (stock_id, type_id, value, rank) VALUES (%d, %d, '%s', %d)",
  118. $form_state['values']['prop_stock_id'],
  119. $form_state['values']['prop_type_id'],
  120. $form_state['values']['prop_value'],
  121. $rank
  122. );
  123. drupal_set_message(t("Successfully Added Property"));
  124. // Set Preferred Synonym
  125. if ($form_state['values']['preferred_synonym'] == 1) {
  126. //use update node form so that both title and name get set
  127. $node = node_load($form_state['values']['prop_nid']);
  128. $node->title = $form_state['values']['prop_value'];
  129. $node_form_state = array(
  130. 'values' => array(
  131. 'title' => $form_state['values']['prop_value'],
  132. 'op' => 'Save'
  133. )
  134. );
  135. module_load_include('inc', 'node', 'node.pages');
  136. drupal_execute('chado_stock_node_form', $node_form_state, $node);
  137. }
  138. } //end of if property to add
  139. }
  140. /**
  141. *
  142. *
  143. * @ingroup tripal_stock
  144. */
  145. function tripal_stock_edit_ALL_properties_page($node) {
  146. $output = '';
  147. $output .= drupal_get_form('tripal_stock_edit_ALL_properties_form', $node);
  148. $output .= '<br />';
  149. $output .= drupal_get_form('tripal_stock_add_ONE_property_form', $node);
  150. $output .= '<br />';
  151. $output .= drupal_get_form('tripal_stock_back_to_stock_button', $node->nid);
  152. return $output;
  153. }
  154. /**
  155. * Implements Hook_form(): Handles adding of Properties & Synonyms to Stocks
  156. *
  157. * @ingroup tripal_stock
  158. */
  159. function tripal_stock_edit_ALL_properties_form($form_state, $node) {
  160. $form = array();
  161. // Add properties and synonyms
  162. $node = tripal_core_expand_chado_vars($node, 'table', 'stockprop');
  163. $form['nid'] = array(
  164. '#type' => 'hidden',
  165. '#value' => $node->nid
  166. );
  167. $i=0;
  168. if (!$node->stock->stockprop) {
  169. $node->stock->stockprop = array();
  170. }
  171. elseif (!is_array($node->stock->stockprop)) {
  172. $node->stock->stockprop = array($node->stock->stockprop);
  173. }
  174. if (sizeof($node->stock->stockprop) != 0) {
  175. foreach ($node->stock->stockprop as $property) {
  176. $i++;
  177. $form["num-$i"] = array(
  178. '#type' => 'item',
  179. '#value' => $i . '.'
  180. );
  181. $form["id-$i"] = array(
  182. '#type' => 'hidden',
  183. '#value' => $property->stockprop_id
  184. );
  185. $prop_type_options = tripal_cv_get_cvterm_options( variable_get('chado_stock_prop_types_cv', 'null') );
  186. ksort($prop_type_options);
  187. $form["type-$i"] = array(
  188. '#type' => 'select',
  189. //'#title' => t('Type of Property'),
  190. '#options' => $prop_type_options,
  191. '#default_value' => $property->type_id->cvterm_id
  192. );
  193. $form["value-$i"] = array(
  194. '#type' => 'textfield',
  195. //'#title' => t('Value'),
  196. '#default_value' => $property->value
  197. );
  198. $form["submit-$i"] = array(
  199. '#type' => 'submit',
  200. '#value' => t("Delete #$i")
  201. );
  202. }} //end of foreach property
  203. $form['num_properties'] = array(
  204. '#type' => 'hidden',
  205. '#value' => $i
  206. );
  207. $form["submit-edits"] = array(
  208. '#type' => 'submit',
  209. '#value' => t('Update Properties')
  210. );
  211. return $form;
  212. }
  213. /**
  214. *
  215. *
  216. * @ingroup tripal_stock
  217. */
  218. function tripal_stock_edit_ALL_properties_form_submit($form, &$form_state) {
  219. if ($form_state['clicked_button']['#value'] == t('Update Properties') ) {
  220. //Update all
  221. for ($i=1; $i<=$form_state['values']['num_properties']; $i++) {
  222. tripal_stock_update_property($form_state['values']["id-$i"], $form_state['values']["type-$i"], $form_state['values']["value-$i"], $form_state['values']["preferred-$i"], $form_state['values']["nid"]);
  223. }
  224. drupal_set_message(t("Updated all Properties"));
  225. drupal_goto('node/' . $form_state['values']['nid']);
  226. }
  227. elseif ( preg_match('/Delete #(\d+)/', $form_state['clicked_button']['#value'], $matches) ) {
  228. $i = $matches[1];
  229. tripal_stock_delete_property($form_state['values']["id-$i"], $form_state['values']["type-$i"], $form_state['values']["value-$i"]);
  230. drupal_set_message(t("Deleted Property"));
  231. }
  232. else {
  233. drupal_set_message(t("Unrecognized Button Pressed"), 'error');
  234. }
  235. }
  236. /**
  237. *
  238. *
  239. * @ingroup tripal_stock
  240. */
  241. function tripal_stock_update_property($stockprop_id, $cvterm_id, $value, $preferred, $nid) {
  242. $old_obj = db_fetch_object(chado_query("SELECT * FROM {stockprop} WHERE stockprop_id=%d", $stockprop_id));
  243. // if they changed the type need to check rank
  244. // (if there is another property of the same type then rank needs to be increased to prevent collisions)
  245. if ($cvterm_id == $old_obj->type_id) {
  246. chado_query(
  247. "UPDATE {stockprop} SET type_id=%d, value='%s' WHERE stockprop_id=%d",
  248. $cvterm_id,
  249. $value,
  250. $stockprop_id
  251. );
  252. }
  253. else {
  254. //determine the rank for this property
  255. $max_rank = get_max_chado_rank('stockprop',
  256. array('stock_id' => array('type' => 'INT', 'value' => $old_obj->stock_id),
  257. 'type_id' => array('type' => 'INT', 'value' => $cvterm_id ) ));
  258. if ($max_rank == -1) {
  259. $rank = 0;
  260. }
  261. else { $rank = $max_rank+1; }
  262. chado_query(
  263. "UPDATE {stockprop} SET type_id=%d, value='%s', rank=%d WHERE stockprop_id=%d",
  264. $cvterm_id,
  265. $value,
  266. $rank,
  267. $stockprop_id
  268. );
  269. }
  270. // Set Preferred Synonym
  271. //use update node form so that both title and name get set
  272. if ($preferred) {
  273. $node = node_load($nid);
  274. $node->title = $value;
  275. $node_form_state = array(
  276. 'values' => array(
  277. 'title' => $value,
  278. 'op' => 'Save'
  279. )
  280. );
  281. module_load_include('inc', 'node', 'node.pages');
  282. drupal_execute('chado_stock_node_form', $node_form_state, $node);
  283. }
  284. }
  285. /**
  286. *
  287. *
  288. * @ingroup tripal_stock
  289. */
  290. function tripal_stock_delete_property($stockprop_id) {
  291. chado_query(
  292. "DELETE FROM {stockprop} WHERE stockprop_id=%d",
  293. $stockprop_id
  294. );
  295. }
  296. /**
  297. *
  298. *
  299. * @ingroup tripal_stock
  300. */
  301. function theme_tripal_stock_edit_ALL_properties_form($form) {
  302. $output = '';
  303. $output .= '<br /><fieldset>';
  304. $output .= '<legend>Edit Already Existing Properties<span class="form-optional" title="This field is optional">(optional)</span></legend>';
  305. $output .= '<p>Below is a list of already existing properties for this stock, one property per line. The type refers to the type of '
  306. .'property and the value is the value for that property. For example, if this stock has a seed coat colour of green then '
  307. .'the property type=sead coat colour and the value=green. When the type of property is synonym, there is an extra checkbox '
  308. .'allowing you to specify which is the <b>Preferred Synonym</b>. This will change the current name of the stock.</p>';
  309. $output .= '<table>';
  310. $output .= '<tr><th>#</th><th>Type</th><th>Value</th><th></th></tr>';
  311. for ($i=1; $i<=$form['num_properties']['#value']; $i++) {
  312. $output .= '<tr><td>' . drupal_render($form["num-$i"]) . '</td><td>' . drupal_render($form["type-$i"]) . '</td><td>' . drupal_render($form["value-$i"]) . drupal_render($form["preferred-$i"]) . '</td><td>' . drupal_render($form["submit-$i"]) . '</td></tr>';
  313. }
  314. $output .= '</table><br />';
  315. $output .= drupal_render($form);
  316. $output .= '</fieldset>';
  317. return $output;
  318. }
  319. /**
  320. *
  321. *
  322. * @ingroup tripal_stock
  323. */
  324. function tripal_stock_list_properties_for_node($properties, $synonyms) {
  325. if (!empty($properties) OR !empty($synonyms) ) {
  326. $output = '<table>';
  327. $output .= '<tr><th>Type</th><th>Value</th></tr>';
  328. if (!empty($synonyms) ) {
  329. foreach ($synonyms as $s) {
  330. $output .= '<tr><td>synonym</td><td>' . $s . '</td></tr>';
  331. }
  332. }
  333. if (!empty($properties) ) {
  334. foreach ($properties as $p) {
  335. $output .= '<tr><td>' . $p->type . '</td><td>' . $p->value . '</td></tr>';
  336. } // end of foreach property
  337. }
  338. $output .= '</table>';
  339. }
  340. else {
  341. $output = 'No Properties Added to the Current Stock';
  342. }
  343. return $output;
  344. }