kvproperty_adder.inc 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. <?php
  2. /**
  3. *
  4. * @param unknown $entity_type
  5. * @param unknown $entity
  6. * @param unknown $field
  7. * @param unknown $instance
  8. * @param unknown $langcode
  9. * @param unknown $items
  10. * @param unknown $display
  11. */
  12. function tripal_fields_kvproperty_adder_formatter(&$element, $entity_type, $entity, $field,
  13. $instance, $langcode, $items, $display) {
  14. foreach ($items as $delta => $item) {
  15. // Do nothing, this field is only meant for the form.
  16. }
  17. }
  18. /**
  19. *
  20. * @param unknown $field_name
  21. * @param unknown $widget
  22. * @param unknown $form
  23. * @param unknown $form_state
  24. * @param unknown $field
  25. * @param unknown $instance
  26. * @param unknown $langcode
  27. * @param unknown $items
  28. * @param unknown $delta
  29. * @param unknown $element
  30. */
  31. function tripal_fields_kvproperty_adder_widget(&$widget, $form, $form_state, $field, $instance, $langcode, $items, $delta, $element) {
  32. // This field has no value field. Just a fieldset for adding new properties.
  33. $widget['kvproperty_adder_fieldset'] = array(
  34. '#element_validate' => array('tripal_fields_kvproperty_adder_widget_validate'),
  35. '#type' => 'fieldset',
  36. '#title' => $element['#title'],
  37. // '#group' => 'ev_tabs',
  38. );
  39. $widget['kvproperty_adder_fieldset']['kvproperty_instructions'] = array(
  40. '#type' => 'item',
  41. '#markup' => t('You may add additional properties to this form by
  42. providing a property name (from a vocabulary) in the field below
  43. and clicking the "Add Property" button. This will add a
  44. new field to the form above for the property you entered.
  45. In the future, this field will be present for all records
  46. of this type.'),
  47. );
  48. $widget['kvproperty_adder_fieldset']['kvproperty_adder'] = array(
  49. '#title' => t('Property Type'),
  50. '#type' => 'textfield',
  51. '#description' => t("Please enter the type of property that you want to add. As you type, suggestions will be provided."),
  52. '#autocomplete_path' => "admin/tripal/chado/tripal_cv/cvterm/auto_name/",
  53. );
  54. $widget['kvproperty_adder_fieldset']['kvproperty_adder_link'] = array(
  55. '#type' => 'item',
  56. '#markup' => '<span class="kvproperty-adder-link">' . l('Add a term', 'admin/tripal/chado/tripal_cv/cvterm/add', array('attributes' => array('target' => '_blank'))) . '</span>',
  57. );
  58. // When this button is clicked, the form will be validated and submitted.
  59. // Therefore, we set custom submit and validate functions to override the
  60. // default form submit. In the validate function we set the form_state
  61. // to rebuild the form so the submit function never actually gets called,
  62. // but we need it or Drupal will run the default validate anyway.
  63. // we also set #limit_validation_errors to empty so fields that
  64. // are required that don't have values won't generate warnings.
  65. $widget['kvproperty_adder_fieldset']['kvproperty_adder_button'] = array(
  66. '#value' => t('Add Property'),
  67. '#type' => 'submit',
  68. '#name' => 'kvproperty_adder_button',
  69. '#validate' => 'tripal_fields_kvproperty_adder_widget_validate',
  70. '#submit' => 'tripal_fields_kvproperty_adder_widget_submit',
  71. '#limit_validation_errors' => array(array($field['field_name'])),
  72. );
  73. }
  74. /**
  75. * Callback function for validating the tripal_fields_kvproperty_adder_widget.
  76. */
  77. function tripal_fields_kvproperty_adder_widget_validate($element, &$form_state) {
  78. // Add the new field to the entity
  79. if (array_key_exists('triggering_element', $form_state) and
  80. $form_state['triggering_element']['#name'] == 'kvproperty_adder_button') {
  81. $form_state['rebuild'] = TRUE;
  82. $field_name = $element['#field_name'];
  83. $entity_type = $element['#entity_type'];
  84. $bundle = $element['#bundle'];
  85. // Get the term for the property
  86. $kvproperty = tripal_fields_get_field_form_values($field_name, $form_state, 0, 'kvproperty_adder');
  87. $term = chado_generate_var('cvterm', array('name' => $kvproperty), $options = array('return_array' => TRUE));
  88. if (count($term) == 1) {
  89. $prop_field_name = $field_name . '__' . $term[0]->cvterm_id;
  90. $field_info = array(
  91. 'field_type' => 'kvproperty',
  92. 'widget_type' => 'tripal_fields_kvproperty_widget',
  93. 'field_settings' => array(),
  94. 'widget_settings' => array(),
  95. 'description' => $term[0]->definition ? $term[0]->definition : '',
  96. 'label' => ucfirst(preg_replace('/_/', ' ', $term[0]->name)),
  97. 'is_required' => FALSE,
  98. // All properties are unlimited.
  99. 'cardinality' => FIELD_CARDINALITY_UNLIMITED,
  100. );
  101. tripal_add_bundle_field($prop_field_name, $field_info, $entity_type, $bundle);
  102. }
  103. else if (count($term) > 1) {
  104. form_set_error(implode('][', $element ['#parents']) . '][kvproperty_adder', t("This term is present in multiple vocabularies. Please select the appropriate one."));
  105. }
  106. else {
  107. form_set_error(implode('][', $element ['#parents']) . '][kvproperty_adder', t("Please provide a property type to add."));
  108. }
  109. }
  110. }
  111. /**
  112. * Callback function for submitting the tripal_fields_kvproperty_adder_widget.
  113. */
  114. function tripal_fields_kvproperty_adder_widget_submit($element, &$form_state) {
  115. }