PHP Class PhpBench\Benchmark\RunnerContext

Afficher le fichier Open project: dantleech/phpbench Class Usage Examples

Méthodes publiques

Méthode 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.

Method Details

__construct() public méthode

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

getContextName() public méthode

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
Résultat string

getExecutor() public méthode

Return either an executor configuration name or an actual configuration.
public getExecutor ( ) : string | array
Résultat string | array

getFilters() public méthode

Whitelist of subject method names.
public getFilters ( )

getGroups() public méthode

Whitelist of groups to execute.
public getGroups ( ) : string[]
Résultat string[]

getIterations() public méthode

Override the number of iterations to execute.
public getIterations ( $default = null ) : integer
Résultat integer

getOutputTimePrecision() public méthode

Return the output time precision.
public getOutputTimePrecision ( $default = null ) : string
Résultat string

getOutputTimeUnit() public méthode

Return the output time unit.
public getOutputTimeUnit ( $default = null ) : string
Résultat string

getParameterSets() public méthode

Override parameters.
public getParameterSets ( $default = null ) : mixed[]
Résultat mixed[]

getPath() public méthode

Return the path underwhich to scan for benchmarks.
public getPath ( ) : string
Résultat string

getRetryThreshold() public méthode

A value of NULL will disable retry.
public getRetryThreshold ( $default = null ) : float
Résultat float

getRevolutions() public méthode

Get the number of rev(olutions) to run.
public getRevolutions ( integer $default = null )
$default integer

getSleep() public méthode

Override the sleep interval (in microseconds).
public getSleep ( $default = null )

getStopOnError() public méthode

Return true if the runner should exit on the first exception encountered.
public getStopOnError ( )

getWarmup() public méthode

Return the number of warmup revolutions that should be exectuted.
public getWarmup ( integer $default = null )
$default integer