PHP Class Scientist\Result

Here we have the results of our experiment. My fingers are crossed for you! - Dayle.
Show file Open project: daylerees/scientist Class Usage Examples

Protected Properties

Property Type Description
$endMemory float The memory usage after the callback is executed.
$endTime float The time the callback finished executing.
$exception Exception | null Exception thrown by callback.
$match boolean Does the callback result value match the control.
$startMemory float The memory usage before the callback is executed.
$startTime float The time the callback was executed.
$value mixed Callback result value.

Public Methods

Method Description
getEndMemory ( ) : float Get the callback execution ending memory usage.
getEndTime ( ) : float Get the callback execution end time.
getException ( ) : Exceptio\Exception | null Get the exception thrown by the callback.
getMemory ( ) : float Get the memory spike amount of the callback.
getStartMemory ( ) : float Get the callback execution starting memory usage.
getStartTime ( ) : float Get the callback execution start time.
getTime ( ) : float Get the execution time of the callback.
getValue ( ) : mixed Get the callback result value.
isMatch ( ) : boolean Determine whether the callback result matches the control.
setEndMemory ( float $endMemory ) Set the callback execution ending memory usage.
setEndTime ( float $endTime ) Set the callback execution end time.
setException ( Exceptio\Exception | null $exception ) Set the exception thrown by the callback.
setMatch ( boolean $match ) Set whether the callback result matches the control.
setStartMemory ( float $startMemory ) Set the callback execution starting memory usage.
setStartTime ( float $startTime ) Set the callback execution start time.
setValue ( mixed $value ) Set the callback result value.

Method Details

getEndMemory() public method

Get the callback execution ending memory usage.
public getEndMemory ( ) : float
return float

getEndTime() public method

Get the callback execution end time.
public getEndTime ( ) : float
return float

getException() public method

Get the exception thrown by the callback.
public getException ( ) : Exceptio\Exception | null
return Exceptio\Exception | null

getMemory() public method

Get the memory spike amount of the callback.
public getMemory ( ) : float
return float

getStartMemory() public method

Get the callback execution starting memory usage.
public getStartMemory ( ) : float
return float

getStartTime() public method

Get the callback execution start time.
public getStartTime ( ) : float
return float

getTime() public method

Get the execution time of the callback.
public getTime ( ) : float
return float

getValue() public method

Get the callback result value.
public getValue ( ) : mixed
return mixed

isMatch() public method

Determine whether the callback result matches the control.
public isMatch ( ) : boolean
return boolean

setEndMemory() public method

Set the callback execution ending memory usage.
public setEndMemory ( float $endMemory )
$endMemory float

setEndTime() public method

Set the callback execution end time.
public setEndTime ( float $endTime )
$endTime float

setException() public method

Set the exception thrown by the callback.
public setException ( Exceptio\Exception | null $exception )
$exception Exceptio\Exception | null

setMatch() public method

Set whether the callback result matches the control.
public setMatch ( boolean $match )
$match boolean

setStartMemory() public method

Set the callback execution starting memory usage.
public setStartMemory ( float $startMemory )
$startMemory float

setStartTime() public method

Set the callback execution start time.
public setStartTime ( float $startTime )
$startTime float

setValue() public method

Set the callback result value.
public setValue ( mixed $value )
$value mixed

Property Details

$endMemory protected property

The memory usage after the callback is executed.
protected float $endMemory
return float

$endTime protected property

The time the callback finished executing.
protected float $endTime
return float

$exception protected property

Exception thrown by callback.
protected Exception|null $exception
return Exception | null

$match protected property

Does the callback result value match the control.
protected bool $match
return boolean

$startMemory protected property

The memory usage before the callback is executed.
protected float $startMemory
return float

$startTime protected property

The time the callback was executed.
protected float $startTime
return float

$value protected property

Callback result value.
protected mixed $value
return mixed