Overview

Namespaces

  • cli_db
    • propel
      • map
      • om
  • cli_import
  • LoggedPDO
  • None
  • PHP
  • webservices
    • cart
    • combisearch
    • details
      • annotations
        • feature
    • graphs
      • barplot
      • genome
    • listing
    • queue

Classes

  • Console_CommandLine_Action_ExtendedHelp
  • LightOpenID
  • Log_firebugJSON
  • WebService

Interfaces

  • CLI_Command

Functions

  • acquire_database
  • cli_error_handler
  • connect_queue_db
  • create_job
  • display_feature
  • display_feature_by_id
  • display_isoform_by_id
  • display_unigene_by_id
  • download
  • execute_command
  • execute_job
  • execute_query_dir
  • get_db_connection
  • get_job_results
  • get_program_databases
  • myErrorHandler
  • pdo_connect
  • report_results_cleanup
  • requestVal
  • smarty_function_call_webservice
  • smarty_function_dbxreflink
  • smarty_function_interprolink
  • smarty_function_publink
  • smarty_modifier_clean_id
  • split_fasta
  • unzip
  • Overview
  • Namespace
  • Class
  • Tree

Interface CLI_Command

interface for classes implementing a command line application subcommand

Direct known implementers

cli_db\AbstractTable, cli_import\AbstractImporter

Indirect known implementers

cli_db\Acquisition, cli_db\Analysis, cli_import\Importer_Annotations_Dbxref, cli_import\Importer_Annotations_Description, cli_import\Importer_Annotations_EC, cli_import\Importer_Annotations_GO, cli_import\Importer_Annotations_Interpro, cli_import\Importer_Annotations_MapMan, cli_import\Importer_Annotations_Repeatmasker, cli_import\Importer_Differential_Expressions, cli_import\Importer_Expressions, cli_import\Importer_Sequence_Ids, cli_db\Assay, cli_import\Importer_Sequences_FASTA, cli_db\Biomaterial, cli_db\Contact, cli_db\Feature, cli_db\Organism, cli_db\Protocol, cli_db\Publication, cli_db\Quantification
Located at src/shared/classes/CLI_Command.php
Methods summary
public static
# CLI_commandName( )

name of subcommand

name of subcommand

public static
# CLI_commandDescription( )

description of subcommand

description of subcommand

public static
# CLI_longHelp( )

will be applied to autogenerated command --help option

will be applied to autogenerated command --help option

public static
# CLI_getCommand( Console_CommandLine $parser )

initiate your Console_Commandline subcommand on variable $parser here

initiate your Console_Commandline subcommand on variable $parser here

Parameters

$parser
Console_CommandLine
$parser
public static
# CLI_checkRequiredOpts( Console_CommandLine_Result $command )

you may check for required options for your command here

you may check for required options for your command here

Parameters

$command
type
$options
public static
# CLI_execute( Console_CommandLine_Result $command, Console_CommandLine $parser )

execute code according to the $result return true on success, return false to display help, throw Error to display Error Message

execute code according to the $result return true on success, return false to display help, throw Error to display Error Message

Parameters

$command
Console_CommandLine_Result
$command
$parser
tbro API documentation generated by ApiGen 2.8.0