PHP Class PhpBench\Benchmark\RunnerContext

Public Methods

Method	Description
__construct ( string $path, array $options = [] )
getContextName ( ) : string	Return the name to assign to this suite.
getExecutor ( ) : string \| array	Return either an executor configuration name or an actual configuration.
getFilters ( )	Whitelist of subject method names.
getGroups ( ) : string[]	Whitelist of groups to execute.
getIterations ( $default = null ) : integer	Override the number of iterations to execute.
getOutputTimePrecision ( $default = null ) : string	Return the output time precision.
getOutputTimeUnit ( $default = null ) : string	Return the output time unit.
getParameterSets ( $default = null ) : mixed[]	Override parameters.
getPath ( ) : string	Return the path underwhich to scan for benchmarks.
getRetryThreshold ( $default = null ) : float	Get the deviation threshold beyond which the iteration should be retried.
getRevolutions ( integer $default = null )	Get the number of rev(olutions) to run.
getSleep ( $default = null )	Override the sleep interval (in microseconds).
getStopOnError ( )	Return true if the runner should exit on the first exception encountered.
getWarmup ( integer $default = null )	Return the number of warmup revolutions that should be exectuted.

public __construct ( string $path, array $options = [] )
$path	string
$options	array

NOTE: Do not confuse this with this context class. It is simply an arbitrary identifier to identify the suite when doing a comparison.

public getContextName ( ) : string
return	string

Return either an executor configuration name or an actual configuration.

public getExecutor ( ) : string \| array
return	string \| array

Whitelist of subject method names.

public getFilters ( )

Whitelist of groups to execute.

public getGroups ( ) : string[]
return	string[]

Override the number of iterations to execute.

public getIterations ( $default = null ) : integer
return	integer

Return the output time precision.

public getOutputTimePrecision ( $default = null ) : string
return	string

Return the output time unit.

public getOutputTimeUnit ( $default = null ) : string
return	string

Override parameters.

public getParameterSets ( $default = null ) : mixed[]
return	mixed[]

Return the path underwhich to scan for benchmarks.

public getPath ( ) : string
return	string

A value of NULL will disable retry.

public getRetryThreshold ( $default = null ) : float
return	float

Get the number of rev(olutions) to run.

public getRevolutions ( integer $default = null )
$default	integer

Override the sleep interval (in microseconds).

public getSleep ( $default = null )

Return true if the runner should exit on the first exception encountered.

public getStopOnError ( )

Return the number of warmup revolutions that should be exectuted.

public getWarmup ( integer $default = null )
$default	integer