PHPUnit\TextUI\Command Class Reference

Inheritance diagram for PHPUnit\TextUI\Command:

Public Member Functions
	run (array $argv, $exit=true)

Static Public Member Functions
static	main ($exit=true)

Protected Member Functions
	createRunner ()
	handleArguments (array $argv)
	handleLoader ($loaderClass, $loaderFile='')
	handlePrinter ($printerClass, $printerFile='')
	handleBootstrap ($filename)
	handleVersionCheck ()
	showHelp ()
	handleCustomTestSuite ()

Protected Attributes
	$arguments
	$options = []
	$longOptions

Detailed Description

A TestRunner for the Command Line Interface (CLI) PHP SAPI Module.

Member Function Documentation

createRunner()

PHPUnit\TextUI\Command::createRunner ( )

protected

Create a TestRunner, override in subclasses.

Returns

TestRunner

handleArguments()

PHPUnit\TextUI\Command::handleArguments ( array  $argv )

protected

Handles the command-line arguments.

A child class of PHPUnit\TextUI\Command can hook into the argument parsing by adding the switch(es) to the $longOptions array and point to a callback method that handles the switch(es) in the child class like this

<?php class MyCommand extends PHPUnit\TextUI\Command { public function __construct() { // my-switch won't accept a value, it's an on/off $this->longOptions['my-switch'] = 'myHandler'; // my-secondswitch will accept a value - note the equals sign $this->longOptions['my-secondswitch='] = 'myOtherHandler'; }

// –my-switch -> myHandler() protected function myHandler() { }

// –my-secondswitch foo -> myOtherHandler('foo') protected function myOtherHandler ($value) { }

// You will also need this - the static keyword in the // PHPUnit\TextUI\Command will mean that it'll be // PHPUnit\TextUI\Command that gets instantiated, // not MyCommand public static function main($exit = true) { $command = new static;

return $command->run($_SERVER['argv'], $exit); }

}

Parameters

array

$argv

handleBootstrap()

PHPUnit\TextUI\Command::handleBootstrap (   $filename )

protected

Loads a bootstrap file.

Parameters

string

$filename

handleCustomTestSuite()

PHPUnit\TextUI\Command::handleCustomTestSuite ( )

protected

Custom callback for test suite discovery.

handleLoader()

PHPUnit\TextUI\Command::handleLoader (   $loaderClass,   $loaderFile = ''  )

protected

Handles the loading of the PHPUnit\Runner\TestSuiteLoader implementation.

Parameters

string	$loaderClass
string	$loaderFile

Returns

TestSuiteLoader|null

handlePrinter()

PHPUnit\TextUI\Command::handlePrinter (   $printerClass,   $printerFile = ''  )

protected

Handles the loading of the PHPUnit\Util\Printer implementation.

Parameters

string	$printerClass
string	$printerFile

Returns

Printer|string|null

main()

static PHPUnit\TextUI\Command::main (   $exit = true )

static

Parameters

bool

$exit

run()

PHPUnit\TextUI\Command::run	(	array	$argv,
			$exit = true
	)

Parameters

array	$argv
bool	$exit

Returns

int

showHelp()

PHPUnit\TextUI\Command::showHelp ( )

protected

Show the help message.

Member Data Documentation

$arguments

PHPUnit\TextUI\Command::$arguments

protected

Initial value:

= [
        'listGroups'              => false,
        'listSuites'              => false,
        'listTests'               => false,
        'listTestsXml'            => false,
        'loader'                  => null,
        'useDefaultConfiguration' => true,
        'loadedExtensions'        => [],
        'notLoadedExtensions'     => []
    ]

---

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

• vendor/phpunit/phpunit/src/TextUI/Command.php