Register and return times, count and data elements

package salt\utils

 Methods

Add a data

addData(string $name, mixed $value) 
Static

Parameters

$name

string

the name of the data

$value

mixed

data to append

Add a time to a timer

addTime(string $name, float $time) 
Static

Parameters

$name

string

name of the timer

$time

float

time to add

Decrement a counter

decrement(string $name, integer $number = 1) : integer
Static

Parameters

$name

string

name of the counter

$number

integer

number to substract, default 1

Returns

integerthe counter value

End a timer and return his value

end(string $name) : float
Static

The timer is destroyed after the call. If we call start() on it again, it will restart to 0

Parameters

$name

string

name of the timer

Returns

floattime of the ended timer

Get all counters values

getAllCounters() : array<mixed,integer>
Static

Returns

array<mixed,integer>all counters : name => int

Get all datas values

getAllDatas() : array<mixed,mixed[]>
Static

Returns

array<mixed,mixed[]>all datas : name => array (mixed)

Get all timers values

getAllTimes() : array<mixed,float>
Static

Returns

array<mixed,float>all timers at their last stop() : name => float

Get a counter value

getCounter(string $name) : integer
Static

Parameters

$name

string

name of a counter

Returns

integercounter value

Get a data value

getData(string $name) : NULL | array<mixed,mixed>
Static

Parameters

$name

string

name of a data to retrieve

Returns

NULLarray<mixed,mixed>: NULL if name does not exist. array of registered data otherwise.

Get a timer value

getTime(string $name) : float
Static

Parameters

$name

string

name of a timer

Returns

floattimer value at the last stop

Check if a data exists

hasData(string $name) : boolean
Static

Parameters

$name

string

name of a data

Returns

booleantrue if some data exists for name.

Increment a counter

increment(string $name, integer $number = 1) : integer
Static

Parameters

$name

string

name of the counter

$number

integer

number to add, default 1

Returns

integerthe counter value

Reset a counter

resetCount(string $name) 
Static

Parameters

$name

string

name of the counter

Reset a timer

resetTime(string $name) 
Static

Parameters

$name

string

name of the timer

Start or restart a timer

start(string $name) 
Static

Parameters

$name

string

name of the timer

Stop a timer

stop(string $name) : float
Static

Parameters

$name

string

name of the timer

Returns

floattime of the stopped timer

 Properties

 

all counters values : name => int

$counters : array<mixed,integer>

Default

array()
Static
 

all data values : name => array(mixed)

$datas : array<mixed,mixed>

Default

array()
Static
 

all active timers : name => float (microtime)

$inProgress : array<mixed,float>

Default

array()
Static
 

all stopped timers : name => float (microtime)

$times : array<mixed,float>

Default

array()
Static