schema__alternate_name_widget.inc

File

tripal_chado/includes/TripalFields/schema__alternate_name/schema__alternate_name_widget.inc
View source
  1. <?php

  2. 

  3. class schema__alternate_name_widget extends ChadoFieldWidget {

  4.   // The default lable for this field.

  5.   public static $default_label = 'Synonyms';

  6. 

  7.   // The list of field types for which this formatter is appropriate.

  8.   public static $field_types = array('schema__alternate_name');

  9. 

  10.   /**

  11.    *

  12.    * @see TripalFieldWidget::form()

  13.    */

  14.   public function form(&$widget, &$form, &$form_state, $langcode, $items, $delta, $element) {

  15.     parent::form($widget, $form, $form_state, $langcode, $items, $delta, $element);

  16.     $field_name = $this->field['field_name'];

  17. 

  18.     // Get the FK column that links to the base table.

  19.     $table_name = $this->instance['settings']['chado_table'];

  20.     $base_table = $this->instance['settings']['base_table'];

  21.     $schema = chado_get_schema($table_name);

  22.     $pkey = $schema['primary key'][0];

  23.     $fkeys = array_values($schema['foreign keys'][$base_table]['columns']);

  24.     $fkey = $fkeys[0];

  25. 

  26.     // Get the field defaults.

  27.     $record_id = '';

  28.     $fkey_value = (array_key_exists('#entity', $element) and $element['#entity']) ? $element['#entity']->chado_record_id : NULL;

  29.     $synonym_id = '';

  30.     $pub_id = '';

  31.     $is_current = TRUE;

  32.     $is_internal = FALSE;

  33.     $syn_name = '';

  34.     $syn_type = '';

  35. 

  36.     // If the field already has a value then it will come through the $items

  37.     // array.  This happens when editing an existing record.

  38.     if (array_key_exists($delta, $items)) {

  39.       $record_id = $items[$delta]['chado-' . $table_name . '__' . $pkey];

  40.       $synonym_id = $items[$delta]['chado-' . $table_name . '__synonym_id'];

  41.       $pub_id = $items[$delta]['chado-' . $table_name . '__pub_id'];

  42.       $is_current = $items[$delta]['chado-' . $table_name . '__is_current'];

  43.       $is_internal = $items[$delta]['chado-' . $table_name . '__is_internal'];

  44.       $syn_name = $items[$delta]['name'];

  45.       $syn_type = $items[$delta]['type_id'];

  46.     }

  47. 

  48.     // Check $form_state['values'] to see if an AJAX call set the values.

  49.     if (array_key_exists('values', $form_state) and

  50.         array_key_exists($field_name, $form_state['values'])) {

  51.       $synonym_id = $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__synonym_id'];

  52.       $pub_id = $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__pub_id'];

  53.       $is_current = $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__is_current'];

  54.       $is_internal = $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__is_internal'];

  55.       $syn_name = $form_state['values'][$field_name]['und'][$delta]['name'];

  56.       $syn_type = $form_state['values'][$field_name]['und'][$delta]['type_id'];

  57.     }

  58. 

  59.     $options = array();

  60.     $value = array('cv_id' => array('name' => 'synonym_type'));

  61.     $op = array('return_array' => 1);

  62.     $types = chado_generate_var('cvterm', $value, $op);

  63.     if ($types) {

  64.       foreach($types AS $type) {

  65.         $options[$type->cvterm_id] = $type->name;

  66.       }

  67.     }

  68. 

  69.     // Get the schema for the synonym table so we can make sure we limit the

  70.     // size of the name field to the proper size.

  71.     $schema = chado_get_schema('synonym');

  72. 

  73.     $widget['#prefix'] =  "<span id='$table_name-$delta'>";

  74.     $widget['#suffix'] =  "</span>";

  75.     $widget['#table_name'] = $table_name;

  76. 

  77.     $widget['value'] = array(

  78.       '#type' => 'value',

  79.       '#value' => array_key_exists($delta, $items) ? $items[$delta]['value'] : '',

  80.     );

  81. 

  82.     $widget['chado-' . $table_name . '__' . $pkey] = array(

  83.       '#type' => 'value',

  84.       '#default_value' => $record_id,

  85.     );

  86.     $widget['chado-' . $table_name . '__synonym_id'] = array(

  87.       '#type' => 'value',

  88.       '#default_value' => $synonym_id,

  89.     );

  90.     $widget['chado-' . $table_name . '__' . $fkey] = array(

  91.       '#type' => 'value',

  92.       '#default_value' => $fkey_value,

  93.     );

  94.     // TODO: add a widget for selecting a publication.

  95.     $widget['chado-' . $table_name . '__pub_id'] = array(

  96.       '#type' => 'value',

  97.       '#default_value' => $pub_id,

  98.     );

  99.     $widget['type_id'] = array(

  100.       '#type' => 'select',

  101.       '#title' => t('Type'),

  102.       '#options' => $options,

  103.       '#default_value' => $syn_type,

  104.     );

  105.     $widget['name'] = array(

  106.       '#type' => 'textfield',

  107.       '#title' => t('Synonym Name'),

  108.       '#default_value' => $syn_name,

  109.       '#size' => 25,

  110.     );

  111. 

  112.     $widget['chado-' . $table_name . '__is_current'] = array(

  113.       '#type' => 'checkbox',

  114.       '#title' => t('Is Current'),

  115.       '#default_value' => $is_current,

  116.       '#required' => $element['#required'],

  117.     );

  118. 

  119.     $widget['chado-' . $table_name . '__is_internal'] = array(

  120.       '#type' => 'checkbox',

  121.       '#title' => t('Is Internal'),

  122.       '#default_value' => $is_internal,

  123.       '#required' => $element['#required'],

  124.     );

  125.   }

  126.   /**

  127.    * @see TripalFieldWidget::validate()

  128.    */

  129.   public function validate($element, $form, &$form_state, $langcode, $delta) {

  130. 

  131.     $field_name = $this->field['field_name'];

  132.     $field_type = $this->field['type'];

  133.     $table_name = $this->instance['settings']['chado_table'];

  134.     $field_table = $this->instance['settings']['chado_table'];

  135.     $field_column = $this->instance['settings']['chado_column'];

  136.     $base_table = $this->instance['settings']['base_table'];

  137.     $schema = chado_get_schema($table_name);

  138.     $pkey = $schema['primary key'][0];

  139.     $fkeys = array_values($schema['foreign keys'][$base_table]['columns']);

  140.     $fkey = $fkeys[0];

  141. 

  142. 

  143.     $pub_id = $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__pub_id'];

  144.     $syn_name = $form_state['values'][$field_name]['und'][$delta]['name'];

  145.     $syn_type = $form_state['values'][$field_name]['und'][$delta]['type_id'];

  146. 

  147.     // If the user provided a $syn_name and a $syn_type then we want to set

  148.     // the foreign key value to be the chado_record_id.

  149.     if ($syn_name and $syn_type) {

  150.       // Set the synonym_id and FK value

  151.       $synonym = chado_generate_var('synonym', array('name' => $syn_name, 'type_id' => $syn_type));

  152.       if ($synonym) {

  153.         $form_state['values'][$field_name]['und'][$delta]['value'] = $synonym->name;

  154.         $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__synonym_id'] = $synonym->synonym_id;

  155.       }

  156.       else {

  157.         $form_state['values'][$field_name]['und'][$delta]['value'] = $syn_name;

  158.       }

  159.       // If a publication is not provided then use the null pub.

  160.       if (!$pub_id) {

  161.         $pub = chado_generate_var('pub', array('uniquename' => 'null'));

  162.         $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__pub_id'] = $pub->pub_id;

  163.       }

  164.     }

  165.     // If no snynonym name is provided then we want to delete the record.

  166.     // To do this we have to set the value to something (here we just use

  167.     // the arbitrary 'delete_me', and set every other element to empty other

  168.     // than the pkey element.

  169.     else {

  170.       $form_state['values'][$field_name]['und'][$delta]['value'] = 'delete_me';

  171.       $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__' . $fkey] = '';

  172.       $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__synonym_id'] = '';

  173.       $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__is_internal'] = '';

  174.       $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__is_current'] = '';

  175.       $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__pub_id'] = '';

  176.     }

  177.   }

  178. 

  179.   /**

  180.    *

  181.    * @see TripalFieldWidget::submit()

  182.    */

  183.   public function submit($form, &$form_state, $entity_type, $entity, $langcode, $delta) {

  184.     $field_name = $this->field['field_name'];

  185.     $table_name = $this->instance['settings']['chado_table'];

  186. 

  187.     $syn_name = $form_state['values'][$field_name]['und'][$delta]['name'];

  188.     $syn_type = $form_state['values'][$field_name]['und'][$delta]['type_id'];

  189. 

  190.     // If the user provided a $syn_name and a $syn_type then we want to set

  191.     // the foreign key value to be the chado_record_id.

  192.     if ($syn_name and $syn_type) {

  193. 

  194.       // Get the synonym. If one with the same name and type is already present

  195.       // then use that. Otherwise, insert a new one.

  196.       $synonym = chado_generate_var('synonym', array('name' => $syn_name, 'type_id' => $syn_type));

  197.       if (!$synonym) {

  198.         $synonym = chado_insert_record('synonym', array(

  199.           'name' => $syn_name,

  200.           'type_id' => $syn_type,

  201.           'synonym_sgml' => '',

  202.         ));

  203.         $synonym = (object) $synonym;

  204.         $form_state['values'][$field_name]['und'][$delta]['value'] = $synonym->name;

  205.         $form_state['values'][$field_name]['und'][$delta]['chado-' . $table_name . '__synonym_id'] = $synonym->synonym_id;

  206.       }

  207.     }

  208.   }

  209. 

  210.   /**

  211.    * @see TripalFieldWidget::theme()

  212.    */

  213.   public function theme($element) {

  214. 

  215.     // These two fields were added to the widget to help identify the fields

  216.     // for layout.

  217.     $table_name = $element['#table_name'];

  218. 

  219.     $layout = "

  220.       <div class=\"synonym-widget\">

  221.         <div class=\"synonym-widget-item\">" .

  222.           drupal_render($element['name']) . "

  223.         </div>

  224.         <div>" .

  225.           drupal_render($element['type_id']) . "

  226.         </div>

  227.         <div class=\"synonym-widget-item\">" .

  228.           drupal_render($element['chado-' . $table_name . '__is_internal']) . "

  229.         </div>

  230.         <div>" .

  231.           drupal_render($element['chado-' . $table_name . '__is_current']) . "

  232.         </div>

  233.       </div>

  234.     ";

  235. 

  236.     return $layout;

  237.   }

  238. 

  239. }

  240. 

  241. /**

  242.  * An Ajax callback for the synonym widget.

  243.  */

  244. function schema__alternate_name_widget_form_ajax_callback($form, $form_state) {

  245. 

  246.   $field_name = $form_state['triggering_element']['#parents'][0];

  247.   $delta = $form_state['triggering_element']['#parents'][2];

  248. 

  249.   return $form[$field_name]['und'][$delta];

  250. }