Drupal\tripal\TripalImporter\Annotation\TripalImporter Class Reference

Inheritance diagram for Drupal\tripal\TripalImporter\Annotation\TripalImporter:

Collaboration diagram for Drupal\tripal\TripalImporter\Annotation\TripalImporter:

Public Attributes
	$id
	$label
	$description
	$file_types = ['txt']
	$upload_description
	$upload_title
	$use_analysis = TRUE
	$require_analysis = FALSE
	$use_button = TRUE
	$submit_disabled = FALSE
	$button_text = 'Import'
	$file_upload = TRUE
	$file_local = TRUE
	$file_remote = TRUE
	$file_required = TRUE
	$argument_list = []
	$cardinality = 1
	$menu_path
	$callback
	$callback_module
	$callback_path

Detailed Description

Defines a tripal importer annotation object.

See also

\Drupal\products\Plugin\ImporterManager

@Annotation

Member Data Documentation

$submit_disabled

Drupal\tripal\TripalImporter\Annotation\TripalImporter::$submit_disabled = FALSE

Indicated whether the base importer added submit button should be disabled when the form is first loaded (i.e when the user clicks the link for the importer). The form can then be programatically enabled via AJAX once certain criteria is set by setting the form state storage.

Example of programatically enabling the button via the form state on an importer where this annotation is set to TRUE.

$storage = $form_state->getStorage();
$storage['disable_TripalImporter_submit'] = FALSE;
$form_state->setStorage($storage);

$upload_description

Drupal\tripal\TripalImporter\Annotation\TripalImporter::$upload_description

Provides information to the user about the file upload.

Typically this may include a description of the file types allowed.

---

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

• tripal/src/TripalImporter/Annotation/TripalImporter.php