PHP Class PDepend\TextUI\Command

Show file Open project: pdepend/pdepend Class Usage Examples

Public Methods

Method Description
main ( ) : integer Main method that starts the command line runner.
run ( ) : integer Performs the main cli process and returns the exit code.

Protected Methods

Method Description
assignArguments ( ) : boolean Assign CLI arguments to current runner instance
parseArguments ( ) : boolean Parses the cli arguments.
printAnalyzerOptions ( integer $length ) : integer Prints the analyzer options.
printHelp ( ) : void Outputs the main help of PDepend.
printLogOptions ( ) : integer Prints all available log options and returns the length of the longest option.
printUsage ( ) : void Outputs the base usage of PDepend.
printVersion ( ) : void Outputs the current PDepend version.
printWorkarounds ( ) : void If the current PHP installation requires some workarounds or limitations, this method will output a message on STDOUT.

Private Methods

Method Description
printDbusOption ( integer $length ) : void Optionally outputs the dbus option when the required extension is loaded.
printOption ( string $option, string $message, integer $length ) : void Prints a single option.
printStatistics ( $startTime )

Method Details

assignArguments() protected method

Assign CLI arguments to current runner instance
protected assignArguments ( ) : boolean
return boolean

main() public static method

Main method that starts the command line runner.
public static main ( ) : integer
return integer The exit code.

parseArguments() protected method

Parses the cli arguments.
protected parseArguments ( ) : boolean
return boolean

printAnalyzerOptions() protected method

Prints the analyzer options.
protected printAnalyzerOptions ( integer $length ) : integer
$length integer Length of the longest option.
return integer

printHelp() protected method

Outputs the main help of PDepend.
protected printHelp ( ) : void
return void

printLogOptions() protected method

Prints all available log options and returns the length of the longest option.
protected printLogOptions ( ) : integer
return integer

printUsage() protected method

Outputs the base usage of PDepend.
protected printUsage ( ) : void
return void

printVersion() protected method

Outputs the current PDepend version.
protected printVersion ( ) : void
return void

printWorkarounds() protected method

If the current PHP installation requires some workarounds or limitations, this method will output a message on STDOUT.
protected printWorkarounds ( ) : void
return void

run() public method

Performs the main cli process and returns the exit code.
public run ( ) : integer
return integer