Class Suite

Suites organize tests and other suites.

Peridot\Core\AbstractTest implements Peridot\Core\TestInterface uses Peridot\Core\HasEventEmitterTrait

Extended by

Peridot\Core\Suite

Namespace: Peridot\Core
Package: Peridot\Core
Located at Core/Suite.php

Methods summary
`public boolean`	# `isFocused( )` Return whether or not the test is focused Return whether or not the test is focused Returns boolean
`public`	# `applyFocusPatterns( string\|null $focusPattern, string\|null $skipPattern = null )` Set the focused status of the test and its children according to the supplied focus pattern and/or skip pattern Set the focused status of the test and its children according to the supplied focus pattern and/or skip pattern Parameters `$focusPattern` `$skipPattern` Overrides `Peridot\Core\AbstractTest::applyFocusPatterns()`
`public`	# `addTest( Peridot\Core\TestInterface $test )` Add a test to the suite Add a test to the suite Parameters `$test`
`public array`	# `getTests( )` Return collection of tests Return collection of tests Returns array
`public`	# `setTests( array $tests )` Set suite tests Set suite tests Parameters `$tests`
`public`	# `define( )` Execute the Suite definition. Execute the Suite definition.
`public mixed`	# `run( Peridot\Core\TestResult $result )` Run all the specs belonging to the suite Run all the specs belonging to the suite Parameters `$result` Returns mixed
`public`	# `halt( )` Put the Suite in a halted state. A halted Suite will not run or will stop running if currently running. Put the Suite in a halted state. A halted Suite will not run or will stop running if currently running.
`protected`	# `runTest( Peridot\Core\TestInterface $test, Peridot\Core\TestResult $result )` Run a test and track its results. Run a test and track its results. Parameters `$test` `$result`
`protected array`	# `getTestsToRun( )` Get the subset of the defined tests that should actually be run. Get the subset of the defined tests that should actually be run. Returns array

Methods inherited from Peridot\Core\AbstractTest
`__construct(), addSetupFunction(), addTearDownFunction(), forEachNodeBottomUp(), forEachNodeTopDown(), getDefinition(), getDefinitionArguments(), getDescription(), getFile(), getParent(), getPending(), getScope(), getSetupFunctions(), getTearDownFunctions(), getTitle(), setDefinitionArguments(), setFile(), setParent(), setPending(), setScope()`

Methods inherited from Peridot\Core\TestInterface
`getEventEmitter(), setEventEmitter()`

Methods used from Peridot\Core\HasEventEmitterTrait
`getEventEmitter(), setEventEmitter()`

Properties summary
`protected array`	`$tests` Tests belonging to this suite Tests belonging to this suite	# `[]`
`protected boolean`	`$halted` Has the suite been halted Has the suite been halted	# `false`

Properties inherited from Peridot\Core\AbstractTest
`$definition, $definitionArguments, $description, $file, $focused, $parent, $pending, $scope, $setUpFns, $tearDownFns`

Properties used from Peridot\Core\HasEventEmitterTrait
`$eventEmitter`