Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter Class Reference

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

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

Public Member Functions
	form ($form, &$form_state)
	formSubmit ($form, &$form_state)
	formValidate ($form, &$form_state)
	run ()
	postRun ()
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	formAjaxCallback ($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

OBO Importer implementation of the TripalImporterBase.

@TripalImporter( id = "chado_obo_loader", label = @Translation("OBO Vocabulary Loader"), description = @Translation("Import vocabularies and terms in OBO format."), file_types = {"obo"}, upload_description = @Translation("Please provide the details for importing a new OBO file. The file must have a .obo extension."), upload_title = @Translation("New OBO File"), use_analysis = FALSE, require_analysis = FALSE, button_text = @Translation("Import OBO File"), file_upload = FALSE, file_local = FALSE, file_remote = FALSE, file_required = FALSE, )

Member Function Documentation

form()

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

}}

Reimplemented from Drupal\tripal_chado\TripalImporter\ChadoImporterBase.

formAjaxCallback()

static Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter::formAjaxCallback (   $form, &  $form_state  )

static

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

Parameters

array	$form	The form array.
\Drupal\Core\Form\FormStateInterface	$form_state	The form state object.

formSubmit()

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

}

Implements Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface.

postRun()

Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter::postRun

(

)

{Performs the import.}

Implements Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface.

run()

Drupal\tripal_chado\Plugin\TripalImporter\OBOImporter::run

(

)

{Performs the import.}

Implements Drupal\tripal\TripalImporter\Interfaces\TripalImporterInterface.

---

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

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