Tripal
Public Member Functions | Static Public Attributes | List of all members
NewickImporter Class Reference
Inheritance diagram for NewickImporter:
Inheritance graph
[legend]
Collaboration diagram for NewickImporter:
Collaboration graph
[legend]

Public Member Functions

 form ($form, &$form_state)
 
 formValidate ($form, &$form_state)
 
 run ()
 
- Public Member Functions inherited from TripalImporter
 __construct (TripalJob $job=NULL)
 
 setJob (TripalJob $job)
 
 create ($run_args, $file_details=[])
 
 load ($import_id)
 
 submitJob ()
 
 prepareFiles ()
 
 cleanFile ()
 
 logMessage ($message, $variables=[], $severity=TRIPAL_INFO)
 
 formSubmit ($form, &$form_state)
 
 postRun ()
 
 getArguments ()
 

Static Public Attributes

static $name = 'Newick Tree Loader'
 
static $machine_name = 'chado_newick_loader'
 
static $description = 'Load Newick formatted phylogenetic trees.'
 
static $file_types = ['tree', 'txt']
 
static $upload_description = 'Please provide the Newick formatted tree file (one tree per file only). The file must have a .txt or .tree extension.'
 
static $upload_title = 'Newick Upload'
 
static $button_text = 'Import Newick file'
 
static $methods
 
- Static Public Attributes inherited from TripalImporter
static $name = 'Tripal Loader'
 
static $machine_name = 'tripal_loader'
 
static $description = 'A base loader for all Tripal loaders'
 
static $file_types = []
 
static $upload_description = ''
 
static $upload_title = 'File Upload'
 
static $use_analysis = TRUE
 
static $require_analysis = TRUE
 
static $button_text = 'Import File'
 
static $use_button = TRUE
 
static $methods
 
static $file_required = TRUE
 
static $argument_list = []
 
static $cardinality = 1
 
static $menu_path = ''
 
static $callback = ''
 
static $callback_module = ''
 
static $callback_path = ''
 

Additional Inherited Members

- Static Public Member Functions inherited from TripalImporter
static byID ($import_id)
 
- Protected Member Functions inherited from TripalImporter
 setTotalItems ($total_items)
 
 addItemsHandled ($num_handled)
 
 setItemsHandled ($total_handled)
 
 setInterval ($interval)
 
- Protected Attributes inherited from TripalImporter
 $job
 
 $arguments
 
 $import_id
 
 $is_prepared
 
 $reported = 0
 

Member Function Documentation

◆ form()

NewickImporter::form (   $form,
$form_state 
)
See also
TripalImporter::form()

Reimplemented from TripalImporter.

◆ formValidate()

NewickImporter::formValidate (   $form,
$form_state 
)
See also
TripalImporter::formValidate()

Reimplemented from TripalImporter.

◆ run()

NewickImporter::run ( )
See also
TripalImporter::run()

Reimplemented from TripalImporter.

Member Data Documentation

◆ $button_text

NewickImporter::$button_text = 'Import Newick file'
static

Text that should appear on the button at the bottom of the importer form.

◆ $description

NewickImporter::$description = 'Load Newick formatted phylogenetic trees.'
static

A brief description for this loader. This description will be presented to the site user.

◆ $file_types

NewickImporter::$file_types = ['tree', 'txt']
static

An array containing the extensions of allowed file types.

◆ $machine_name

NewickImporter::$machine_name = 'chado_newick_loader'
static

The machine name for this loader. This name will be used to construct the URL for the loader.

◆ $methods

NewickImporter::$methods
static
Initial value:
= [
'file_upload' => TRUE,
'file_local' => TRUE,
'file_remote' => TRUE,
]

Indicates the methods that the file uploader will support.

◆ $name

NewickImporter::$name = 'Newick Tree Loader'
static

The name of this loader. This name will be presented to the site user.

◆ $upload_description

NewickImporter::$upload_description = 'Please provide the Newick formatted tree file (one tree per file only). The file must have a .txt or .tree extension.'
static

Provides information to the user about the file upload. Typically this may include a description of the file types allowed.

◆ $upload_title

NewickImporter::$upload_title = 'Newick Upload'
static

The title that should appear above the file upload section.


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