Class AbstractImporter

abstract class as parent for tbro-import commands. implements standard behavior for command-line interaction. final importers only need to implement the import method

cli_import\AbstractImporter implements CLI_Command, cli_import\Importer

Direct known subclasses

cli_import\Importer_Annotations_Dbxref, cli_import\Importer_Annotations_Description, cli_import\Importer_Annotations_Interpro, cli_import\Importer_Annotations_Repeatmasker, cli_import\Importer_Differential_Expressions, cli_import\Importer_Expressions, cli_import\Importer_Sequence_Ids, cli_import\Importer_Sequences_FASTA

Indirect known subclasses

cli_import\Importer_Annotations_EC, cli_import\Importer_Annotations_GO, cli_import\Importer_Annotations_MapMan

Abstract
Namespace: cli_import
Located at src/cli/import/classes/AbstractImporter.php

Methods summary
`public static Console_CommandLine_Command`	# `CLI_getCommand( Console_CommandLine $parser )` adds command line options. --help --organism_id --release argument "files" adds command line options. --help --organism_id --release argument "files" Parameters `$parser` `Console_CommandLine` $parser Returns `Console_CommandLine_Command` Implementation of `CLI_Command::CLI_getCommand()`
`public static`	# `CLI_checkRequiredOpts( Console_CommandLine_Result $command )` check if all required options have been set check if all required options have been set Parameters `$command` `Console_CommandLine_Result` $command Throws `Exception` on missing argument Implementation of `CLI_Command::CLI_checkRequiredOpts()`
`public static`	# `CLI_execute( Console_CommandLine_Result $command, Console_CommandLine $parser )` execute command. sets constants and calls self::import($options) execute command. sets constants and calls self::import($options) Parameters `$command` `Console_CommandLine_Result` $command `$parser` `Console_CommandLine` $parser Implementation of `CLI_Command::CLI_execute()`
`public static`	# `preCommitMsg( )`
`protected static`	# `setLineCount( integer $count )` updates progress bar target count updates progress bar target count Parameters `$count` `integer` $count
`protected static nothing`	# `updateProgress( integer $current_count )` updates bar progress updates bar progress Parameters `$current_count` `integer` $current_count Returns `nothing`
`protected static`	# `dieOnMissingArg( Array $options, String $argname )` throws exception if required option is not set throws exception if required option is not set Parameters `$options` `Array` $options user-specified command-line options `$argname` `String` $argname name of option Throws `Exception`

Methods inherited from CLI_Command
`CLI_commandDescription(), CLI_commandName(), CLI_longHelp()`

Methods inherited from cli_import\Importer
`import()`

Properties summary
`public static Log`	`$log`		# Log instance for output Log instance for output

Namespaces

Classes

Interfaces

Class AbstractImporter

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Implementation of

Parameters

Throws

Implementation of

Parameters

Implementation of

Parameters

Parameters

Returns

Parameters

Throws