Interface TestInterface

Defines the contract for Peridot test fixtures like Test and Suite

Direct known implementers

Indirect known implementers

Peridot\Core\Suite, Peridot\Core\Test, Peridot\Test\ItWasRun

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

Methods summary
`public mixed`	# `run( Peridot\Core\TestResult $result )` Parameters `$result` Returns mixed
`public`	# `addSetupFunction( callable $setupFn )` Add a function to execute before the test runs Add a function to execute before the test runs Parameters `$setupFn`
`public array`	# `getSetupFunctions( )` Return all registered setup functions Return all registered setup functions Returns array
`public`	# `addTearDownFunction( callable $tearDownFn )` Add a function to execute after the test runs Add a function to execute after the test runs Parameters `$tearDownFn`
`public array`	# `getTearDownFunctions( )` Return all registered tear down functions Return all registered tear down functions Returns array
`public string`	# `getDescription( )` Returns string
`public callable`	# `getDefinition( )` Returns the callable definition of the TestInterface Returns the callable definition of the TestInterface Returns callable
`public Peridot\Core\TestInterface`	# `getParent( )` Returns `Peridot\Core\TestInterface`
`public mixed`	# `setParent( Peridot\Core\TestInterface $parent )` Parameters `$parent` Returns mixed
`public string`	# `getTitle( )` Returns the full description including parent descriptions Returns the full description including parent descriptions Returns string
`public boolean\|null`	# `getPending( )` Return whether or not the test is pending Return whether or not the test is pending Returns boolean\|null
`public`	# `setPending( boolean $state )` Set the pending status of the test Set the pending status of the test Parameters `$state`
`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`
`public Peridot\Core\Scope`	# `getScope( )` Return scope for this test. Scope contains instance variables for a spec Return scope for this test. Scope contains instance variables for a spec Returns `Peridot\Core\Scope`
`public mixed`	# `setScope( Peridot\Core\Scope $scope )` Set the scope object for a test Set the scope object for a test Parameters `$scope` Returns mixed
`public mixed`	# `setEventEmitter( Evenement\EventEmitterInterface $emitter )` Parameters `$emitter` Returns mixed
`public Evenement\EventEmitterInterface`	# `getEventEmitter( )` Returns `Evenement\EventEmitterInterface`
`public`	# `forEachNodeBottomUp( callable $fn )` Execute a callback for each node in this test, starting at the bottom of the tree. Execute a callback for each node in this test, starting at the bottom of the tree. Parameters `$fn`
`public`	# `forEachNodeTopDown( callable $fn )` Execute a callback for each node in this test, starting at the top of the tree. Execute a callback for each node in this test, starting at the top of the tree. Parameters `$fn`
`public mixed`	# `setDefinitionArguments( array $args )` Set arguments to be passed to the test definition when invoked. Set arguments to be passed to the test definition when invoked. Parameters `$args` Returns mixed
`public array`	# `getDefinitionArguments( )` Return an array of arguments to be passed to the test definition when invoked. Return an array of arguments to be passed to the test definition when invoked. Returns array

Namespaces

Classes

Interfaces

Traits

Interface TestInterface

Direct known implementers

Indirect known implementers

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Parameters

Returns

Returns