PHP Class lithium\test\Dispatcher

This Dispatcher is used exclusively for the purpose of running, organizing and compiling statistics for the built-in Lithium test suite.
Inheritance: extends lithium\core\StaticObject
Show file Open project: unionofrad/lithium Class Usage Examples

Protected Properties

Property Type Description
$_classes Composed classes used by the Dispatcher.

Public Methods

Method Description
run ( string $group = null, array $options = [] ) : array Runs a test group or a specific test file based on the passed parameters.

Protected Methods

Method Description
_group ( array $data ) : object Creates the group class based
_report ( string $group, array $options ) : object Creates the test report class based on either the passed test case or the passed test group.

Method Details

_group() protected static method

Creates the group class based
See also: lithium\test\Dispatcher::$_classes
protected static _group ( array $data ) : object
$data array Array of cases or groups.
return object Group object constructed with `$data`.

_report() protected static method

Creates the test report class based on either the passed test case or the passed test group.
See also: lithium\test\Dispatcher::$_classes
protected static _report ( string $group, array $options ) : object
$group string
$options array Options array passed from Dispatcher::run(). Should contain one of 'case' or 'group' keys.
return object Group object constructed with the test case or group passed in $options.

run() public static method

Runs a test group or a specific test file based on the passed parameters.
public static run ( string $group = null, array $options = [] ) : array
$group string If set, this test group is run. If not set, a group test may also be run by passing the 'group' option to the $options parameter.
$options array Options array for the test run. Valid options are: - `'case'`: The fully namespaced test case to be run. - `'group'`: The fully namespaced test group to be run. - `'filters'`: An array of filters that the test output should be run through. - `'format'`: The format of the template to use, defaults to `'txt'`. - `'reporter'`: The reporter to use.
return array A compact array of the title, an array of the results, as well as an additional array of the results after the $options['filters'] have been applied.

Property Details

$_classes protected static property

Composed classes used by the Dispatcher.
protected static $_classes