-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1599 from tripal/tv4g1-issue1414-ChadoContactDefault
Tripal 4 ChadoContactDefault field
- Loading branch information
Showing
8 changed files
with
789 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
tripal_chado/src/Plugin/Field/FieldFormatter/ChadoContactFormatterDefault.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| <?php | ||
|
|
||
| namespace Drupal\tripal_chado\Plugin\Field\FieldFormatter; | ||
|
|
||
| use Drupal\tripal\TripalField\TripalFormatterBase; | ||
| use Drupal\Core\Field\FieldItemListInterface; | ||
| use Drupal\Core\Form\FormStateInterface; | ||
| use Drupal\tripal_chado\TripalField\ChadoFormatterBase; | ||
|
|
||
| /** | ||
| * Plugin implementation of default Tripal contact formatter. | ||
| * | ||
| * @FieldFormatter( | ||
| * id = "chado_contact_formatter_default", | ||
| * label = @Translation("Chado contact formatter"), | ||
| * description = @Translation("A chado contact formatter"), | ||
| * field_types = { | ||
| * "chado_contact_default" | ||
| * } | ||
| * ) | ||
| */ | ||
| class ChadoContactFormatterDefault extends ChadoFormatterBase { | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function viewElements(FieldItemListInterface $items, $langcode) { | ||
| $elements = []; | ||
|
|
||
| foreach($items as $delta => $item) { | ||
| $contact_name = $item->get('contact_name')->getString(); | ||
| // Change the non-user-friendly 'null' contact, which is spedified by chado. | ||
| if ($contact_name == 'null') { | ||
| $contact_name = 'Unknown'; | ||
| } | ||
| $elements[$delta] = [ | ||
| "#markup" => $contact_name, | ||
| ]; | ||
| } | ||
|
|
||
| return $elements; | ||
| } | ||
| } |
171 changes: 171 additions & 0 deletions
171
tripal_chado/src/Plugin/Field/FieldType/ChadoContactDefault.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| <?php | ||
|
|
||
| namespace Drupal\tripal_chado\Plugin\Field\FieldType; | ||
|
|
||
| use Drupal\tripal_chado\TripalField\ChadoFieldItemBase; | ||
| use Drupal\tripal_chado\TripalStorage\ChadoVarCharStoragePropertyType; | ||
| use Drupal\tripal_chado\TripalStorage\ChadoIntStoragePropertyType; | ||
| use Drupal\tripal_chado\TripalStorage\ChadoTextStoragePropertyType; | ||
| use Drupal\tripal\TripalField\TripalFieldItemBase; | ||
| use Drupal\tripal\TripalStorage\StoragePropertyValue; | ||
| use Drupal\Core\Field\FieldStorageDefinitionInterface; | ||
| use Drupal\core\Form\FormStateInterface; | ||
| use Drupal\core\Field\FieldDefinitionInterface; | ||
|
|
||
| /** | ||
| * Plugin implementation of Tripal Contact field type. | ||
| * | ||
| * @FieldType( | ||
| * id = "chado_contact_default", | ||
| * label = @Translation("Contact"), | ||
| * description = @Translation("An individual or organization that serves as a contact for this record"), | ||
| * default_widget = "chado_contact_widget_default", | ||
| * default_formatter = "chado_contact_formatter_default", | ||
| * cardinality = 1 | ||
| * ) | ||
| */ | ||
| class ChadoContactDefault extends ChadoFieldItemBase { | ||
|
|
||
| public static $id = 'chado_contact_default'; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function mainPropertyName() { | ||
| // Overrides the default of 'value' | ||
| return 'contact_name'; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function defaultFieldSettings() { | ||
| $settings = parent::defaultFieldSettings(); | ||
| $settings['termIdSpace'] = 'local'; | ||
| $settings['termAccession'] = 'contact'; | ||
| return $settings; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function defaultStorageSettings() { | ||
| $settings = parent::defaultStorageSettings(); | ||
| return $settings; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) { | ||
|
|
||
| $elements = parent::storageSettingsForm($form, $form_state, $has_data); | ||
| $storage_settings = $this->getSetting('storage_plugin_settings'); | ||
| $base_table = $form_state->getValue(['settings', 'storage_plugin_settings', 'base_table']); | ||
|
|
||
| // Only present base tables that have a foreign key to contact. | ||
| $elements['storage_plugin_settings']['base_table']['#options'] = $this->getBaseTables('contact'); | ||
| // Ugly special case for the arraydesign table where manufacturer_id is mapped to contact_id | ||
| $elements['storage_plugin_settings']['base_table']['#options']['arraydesign'] = 'arraydesign'; | ||
|
|
||
| // Add a validation to make sure the base table has a foreign | ||
| // key to contact_id in the chado.contact table. | ||
| $elements['storage_plugin_settings']['base_table']['#element_validate'] = [[static::class, 'storageSettingsFormValidate']]; | ||
| return $elements; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function tripalTypes($field_definition) { | ||
| $entity_type_id = $field_definition->getTargetEntityTypeId(); | ||
|
|
||
| // Get the Chado table and column this field maps to. | ||
| $storage_settings = $field_definition->getSetting('storage_plugin_settings'); | ||
| $base_table = $storage_settings['base_table']; | ||
|
|
||
| // If we don't have a base table then we're not ready to specify the | ||
| // properties for this field. | ||
| if (!$base_table) { | ||
| $record_id_term = 'local:contact'; | ||
| return [ | ||
| new ChadoIntStoragePropertyType($entity_type_id, self::$id, 'record_id', $record_id_term, [ | ||
| 'action' => 'store_id', | ||
| 'drupal_store' => TRUE, | ||
| ]) | ||
| ]; | ||
| } | ||
|
|
||
| // Get the connecting information for the foreign key from the | ||
| // base table to the contact table. | ||
| $chado = \Drupal::service('tripal_chado.database'); | ||
| $schema = $chado->schema(); | ||
| $base_table_def = $schema->getTableDef($base_table, ['format' => 'Drupal']); | ||
| $contact_table_def = $schema->getTableDef('contact', ['format' => 'Drupal']); | ||
| $base_pkey_col = $base_table_def['primary key']; | ||
| // Note that for the arraydesign table, this will be manufacturer_id instead of contact_id | ||
| $base_fkey_col = array_key_first($base_table_def['foreign keys']['contact']['columns']); | ||
|
|
||
| // Create variables to store the terms for the contact. | ||
| $storage = \Drupal::entityTypeManager()->getStorage('chado_term_mapping'); | ||
| $mapping = $storage->load('core_mapping'); | ||
| $record_id_term = 'SIO:000729'; | ||
| $contact_id_term = $mapping->getColumnTermId('contact', 'contact_id'); | ||
| $contact_name_term = $mapping->getColumnTermId('contact', 'name'); | ||
| $contact_name_length = $contact_table_def['fields']['name']['size']; | ||
|
|
||
| // Define field properties, this is a simple lookup in the contact table | ||
| $properties = []; | ||
| $properties[] = new ChadoIntStoragePropertyType($entity_type_id, self::$id, 'record_id', $record_id_term, [ | ||
| 'action' => 'store_id', | ||
| 'drupal_store' => TRUE, | ||
| 'chado_table' => $base_table, | ||
| 'chado_column' => $base_pkey_col, | ||
| ]); | ||
| $properties[] = new ChadoIntStoragePropertyType($entity_type_id, self::$id, 'contact_id', $contact_id_term, [ | ||
| 'action' => 'store', | ||
| 'chado_table' => $base_table, | ||
| 'chado_column' => $base_fkey_col, | ||
| ]); | ||
| $properties[] = new ChadoVarCharStoragePropertyType($entity_type_id, self::$id, 'contact_name', $contact_name_term, $contact_name_length, [ | ||
| 'action' => 'join', | ||
| 'path' => $base_table . '.' . $base_fkey_col . '>contact.contact_id', | ||
| 'chado_column' => 'name', | ||
| 'as' => 'contact_name', | ||
| ]); | ||
|
|
||
| return $properties; | ||
| } | ||
|
|
||
| /** | ||
| * Form element validation handler | ||
| * | ||
| * @param array $form | ||
| * The form where the settings form is being included in. | ||
| * @param \Drupal\Core\Form\FormStateInterface $form_state | ||
| * The form state of the (entire) configuration form. | ||
| */ | ||
| public static function storageSettingsFormValidate(array $form, FormStateInterface $form_state) { | ||
| $settings = $form_state->getValue('settings'); | ||
| if (!array_key_exists('storage_plugin_settings', $settings)) { | ||
| return; | ||
| } | ||
|
|
||
| // Validation confirms that the base table has a foreign key | ||
| // to contact_id in the chado.contact table. | ||
| // This validation might be redundant, since we only present | ||
| // valid base tables to the user, but let's play it safe. | ||
| $base_table = $settings['storage_plugin_settings']['base_table']; | ||
| $chado = \Drupal::service('tripal_chado.database'); | ||
| $schema = $chado->schema(); | ||
| $base_table_def = $schema->getTableDef($base_table, ['format' => 'Drupal']); | ||
| $base_fkey_col = 'contact_id'; | ||
| $fkeys = $base_table_def['foreign keys']['contact']['columns'] ?? []; | ||
| if (!in_array($base_fkey_col, $fkeys)) { | ||
| $form_state->setErrorByName('storage_plugin_settings][base_table', | ||
| 'The selected base table does not have a foreign key to contact_id,' | ||
| . ' this field cannot be used on this content type.'); | ||
| } | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.