Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter Class Reference

Inheritance diagram for Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter:

Collaboration diagram for Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter:

Public Member Functions
	form ($form, &$form_state)
	formValidate ($form, &$form_state)
	run ()
	postRun ()
	formSubmit ($form, &$form_state)
Public Member Functions inherited from Drupal\tripal_chado\TripalImporter\ChadoImporterBase
	__construct (array $configuration, $plugin_id, $plugin_definition, ChadoConnection $connection)
	getChadoConnection ()
	addAnalysis ($form, &$form_state)
Public Member Functions inherited from Drupal\tripal\TripalImporter\TripalImporterBase
	__construct (array $configuration, $plugin_id, $plugin_definition)
	describeUploadFileFormat ()
	setJob ($job)
	createImportJob ($run_args, $file_details=[])
	load ($import_id)
	submitJob ()
	prepareFiles ()
	cleanFile ()
	getArguments ()

Static Public Member Functions
static	tripal_taxon_importer_set_ncbi_api_key ($form, &$form_state)
Static Public Member Functions inherited from Drupal\tripal_chado\TripalImporter\ChadoImporterBase
static	create (ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition)

Additional Inherited Members
Protected Member Functions inherited from Drupal\tripal\TripalImporter\TripalImporterBase
	setTotalItems ($total_items)
	addItemsHandled ($num_handled)
	setItemsHandled ($total_handled)
	setInterval ($interval)
Protected Attributes inherited from Drupal\tripal_chado\TripalImporter\ChadoImporterBase
	$chado_schema_main
	$messenger = NULL
	$connection
Protected Attributes inherited from Drupal\tripal\TripalImporter\TripalImporterBase
	$job
	$logger
	$arguments
	$import_id
	$is_prepared
	$messenger = NULL
	$reported
	$plugin_id
	$plugin_definition

Detailed Description

Taxonomy Importer implementation of the TripalImporterBase.

@TripalImporter( id = "chado_taxonomy_loader", label = @Translation("Taxonomy Loader"), description = @Translation("Import a Taxonomy into Chado"), file_types = {"gff","gff3"}, upload_description = @Translation("Please provide the Taxonomy file."), upload_title = @Translation("Taxonomy File"), use_analysis = False, require_analysis = False, button_text = @Translation("Import Taxonomy"), file_upload = FALSE, file_local = FALSE, file_remote = FALSE, file_required = FALSE, )

Member Function Documentation

form()

Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter::form	(		$form,
		&	$form_state
	)

See also

TripalImporter::form()

Reimplemented from Drupal\tripal_chado\TripalImporter\ChadoImporterBase.

formSubmit()

Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter::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.

}

Implements Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface.

formValidate()

Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter::formValidate	(		$form,
		&	$form_state
	)

See also

TripalImporter::formValidate()

Implements Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface.

postRun()

Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter::postRun

(

)

{Performs the import.}

Implements Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface.

run()

Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter::run

(

)

Performs the import.

Implements Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface.

tripal_taxon_importer_set_ncbi_api_key()

static Drupal\tripal_chado\Plugin\TripalImporter\TaxonomyImporter::tripal_taxon_importer_set_ncbi_api_key (   $form, &  $form_state  )

static

Ajax callback for the TaxonomyImporter::form() function.

It is called when the user makes a change to the NCBI API key field and then moves their cursor out of the field.

Parameters

array	$form	The new form element.
\Drupal\Core\Form\FormStateInterface	$form_state	The state of the new form element.

Returns

array The new api key field.

---

The documentation for this class was generated from the following file:

• tripal_chado/src/Plugin/TripalImporter/TaxonomyImporter.php