◆ form()
TaxonomyImporter::form |
( |
|
$form, |
|
|
& |
$form_state |
|
) |
| |
◆ formValidate()
TaxonomyImporter::formValidate |
( |
|
$form, |
|
|
& |
$form_state |
|
) |
| |
◆ run()
TaxonomyImporter::run |
( |
| ) |
|
◆ $argument_list
TaxonomyImporter::$argument_list = [] |
|
static |
The array of arguments used for this loader. Each argument should be a separate array containing a machine_name, name, and description keys. This information is used to build the help text for the loader.
◆ $button_text
TaxonomyImporter::$button_text = 'Import from NCBI Taxonomy' |
|
static |
Text that should appear on the button at the bottom of the importer form.
◆ $cardinality
TaxonomyImporter::$cardinality = 0 |
|
static |
Indicates how many files are allowed to be uploaded. By default this is set to allow only one file. Change to any positive number. A value of zero indicates an unlimited number of uploaded files are allowed.
◆ $description
TaxonomyImporter::$description |
|
static |
Initial value:= 'Imports new organisms from NCBI using taxonomy IDs, ' .
'or loads taxonomic details about existing organisms.'
A brief description for this loader. This description will be presented to the site user.
◆ $file_required
TaxonomyImporter::$file_required = FALSE |
|
static |
Indicates if the file must be provided. An example when it may not be necessary to require that the user provide a file for uploading if the loader keeps track of previous files and makes those available for selection.
◆ $file_types
TaxonomyImporter::$file_types = [] |
|
static |
An array containing the extensions of allowed file types.
◆ $machine_name
TaxonomyImporter::$machine_name = 'chado_taxonomy' |
|
static |
The machine name for this loader. This name will be used to construct the URL for the loader.
◆ $methods
TaxonomyImporter::$methods |
|
static |
Initial value:= [
'file_upload' => FALSE,
'file_local' => FALSE,
'file_remote' => FALSE,
]
Indicates the methods that the file uploader will support.
◆ $name
TaxonomyImporter::$name = 'Chado NCBI Taxonomy Loader' |
|
static |
The name of this loader. This name will be presented to the site user.
◆ $require_analysis
TaxonomyImporter::$require_analysis = FALSE |
|
static |
If the $use_analysis value is set above then this value indicates if the analysis should be required.
◆ $upload_description
TaxonomyImporter::$upload_description = '' |
|
static |
Provides information to the user about the file upload. Typically this may include a description of the file types allowed.
◆ $upload_title
TaxonomyImporter::$upload_title = 'File Upload' |
|
static |
The title that should appear above the upload button.
◆ $use_analysis
TaxonomyImporter::$use_analysis = FALSE |
|
static |
If the loader should require an analysis record. To maintain provenance we should always indicate where the data we are uploading comes from. The method that Tripal attempts to use for this by associating upload files with an analysis record. The analysis record provides the details for how the file was created or obtained. Set this to FALSE if the loader should not require an analysis when loading. if $use_analysis is set to true then the form values will have an 'analysis_id' key in the $form_state array on submitted forms.
The documentation for this class was generated from the following file:
- tripal_chado/includes/TripalImporter/TaxonomyImporter.inc