Public Member Functions | |
| form ($form, &$form_state) | |
| formSubmit ($form, &$form_state) | |
| formValidate ($form, &$form_state) | |
| run () | |
| postRun () | |
| addAnalysis ($form, &$form_state) | |
Detailed Description
Defines an interface for tripal importer plugins.
Member Function Documentation
◆ addAnalysis()
| Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface::addAnalysis | ( | $form, | |
| & | $form_state | ||
| ) |
Adds the form elements necessary for selecting an analaysis to the form.
While every Importer must implement this function, Ideally it should be implomented by a child abstract Base class for each data store (e.g. Chado) and each importer should extend the new Base class to inherit the function. This will allow for consistency in the way the analysi form element is presented for all Importers working on the same data store.
- Parameters
-
array $form The form array definition. \Drupal\Core\Form\FormStateInterface $form_state The form state object.
- Returns
- array An arrya definition containing the form elements for selecting an analysis.
Implemented in Drupal\tripal_chado\TripalImporter\ChadoImporterBase.
◆ form()
| Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface::form | ( | $form, | |
| & | $form_state | ||
| ) |
Provides form elements to be added to the loader form.
These form elements are added after the file uploader section that is automaticaly provided by the TripalImporter.
- Parameters
-
array $form The form array definition. \Drupal\Core\Form\FormStateInterface $form_state The form state object.
- Returns
- array A new form array definition.
Implemented in Drupal\tripal_chado\TripalImporter\ChadoImporterBase, Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter, Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter, Drupal\tripal_chado\Plugin\TripalImporter\NewickImporter, Drupal\tripal_chado\Plugin\TripalImporter\GFF3Importer, and Drupal\tripal_chado\Plugin\TripalImporter\FASTAImporter.
◆ formSubmit()
| Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface::formSubmit | ( | $form, | |
| & | $form_state | ||
| ) |
Handles submission of the form elements.
The form elements provided in the implementation of the form() function can be used for special submit if needed.
- Parameters
-
array $form The form array definition. \Drupal\Core\Form\FormStateInterface $form_state The form state object.
Implemented in Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter, Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter, Drupal\tripal_chado\Plugin\TripalImporter\NewickImporter, Drupal\tripal_chado\Plugin\TripalImporter\GFF3Importer, and Drupal\tripal_chado\Plugin\TripalImporter\FASTAImporter.
◆ formValidate()
| Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface::formValidate | ( | $form, | |
| & | $form_state | ||
| ) |
Handles validation of the form elements.
The form elements provided in the implementation of the form() function should be validated using this function.
- Parameters
-
array $form The form array definition.* \Drupal\Core\Form\FormStateInterface $form_state The form state object.
Implemented in Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter, Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter, Drupal\tripal_chado\Plugin\TripalImporter\NewickImporter, Drupal\tripal_chado\Plugin\TripalImporter\GFF3Importer, and Drupal\tripal_chado\Plugin\TripalImporter\FASTAImporter.
◆ postRun()
| Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface::postRun | ( | ) |
Performs the import.
Implemented in Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter, Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter, Drupal\tripal_chado\Plugin\TripalImporter\NewickImporter, Drupal\tripal_chado\Plugin\TripalImporter\GFF3Importer, and Drupal\tripal_chado\Plugin\TripalImporter\FASTAImporter.
◆ run()
| Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface::run | ( | ) |
Performs the import.
Implemented in Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter, Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter, Drupal\tripal_chado\Plugin\TripalImporter\NewickImporter, Drupal\tripal_chado\Plugin\TripalImporter\GFF3Importer, and Drupal\tripal_chado\Plugin\TripalImporter\FASTAImporter.
The documentation for this interface was generated from the following file:
- tripal/src/TripalImporter/Interfaces/TripalImporterInterface.php
