TimeHandler
extends AbstractHandler
in package
Debug time handler class
Tags
Table of Contents
Properties
- $logger : Logger|null
- Logger object
- $loggingParams : array<string|int, mixed>
- Logging params
- $name : string|null
- Name of time measurement
- $start : float|null
- Start time
- $stop : float|null
- Stop time
Methods
- __construct() : mixed
- Constructor
- getElapsed() : string
- Get elapsed time
- getLogger() : Logger|null
- Get logger
- getLoggingParams() : array<string|int, mixed>
- Get logging params
- getName() : string|null
- Get name
- getStart() : float|null
- Get start value
- getStop() : float
- Get stop value
- hasLogger() : bool
- Has logger
- hasLoggingParams() : bool
- Has logging parameters
- hasName() : bool
- Has name
- hasStarted() : bool
- Determined if the timer has started
- hasStopped() : bool
- Determined if the timer has stopped
- log() : void
- Trigger handler logging
- prepare() : array<string|int, mixed>
- Prepare handler data for storage
- prepareAsString() : string
- Prepare handler data as string
- prepareHeaderAsString() : string
- Prepare header string
- setLogger() : AbstractHandler
- Set logger
- setLoggingParams() : AbstractHandler
- Set logger
- setName() : AbstractHandler
- Set name
- start() : TimeHandler
- Start timer
- stop() : TimeHandler
- Stop timer
Properties
$logger
Logger object
protected
Logger|null
$logger
= null
$loggingParams
Logging params
protected
array<string|int, mixed>
$loggingParams
= []
$name
Name of time measurement
protected
string|null
$name
= null
$start
Start time
protected
float|null
$start
= null
$stop
Stop time
protected
float|null
$stop
= null
Methods
__construct()
Constructor
public
__construct([bool $start = true ][, string|null $name = null ][, Logger|null $logger = null ][, array<string|int, mixed> $loggingParams = [] ]) : mixed
Instantiate a time handler object
Parameters
- $start : bool = true
- $name : string|null = null
- $logger : Logger|null = null
- $loggingParams : array<string|int, mixed> = []
getElapsed()
Get elapsed time
public
getElapsed() : string
Return values
stringgetLogger()
Get logger
public
getLogger() : Logger|null
Return values
Logger|nullgetLoggingParams()
Get logging params
public
getLoggingParams() : array<string|int, mixed>
Return values
array<string|int, mixed>getName()
Get name
public
getName() : string|null
Return values
string|nullgetStart()
Get start value
public
getStart() : float|null
Return values
float|nullgetStop()
Get stop value
public
getStop() : float
Return values
floathasLogger()
Has logger
public
hasLogger() : bool
Return values
boolhasLoggingParams()
Has logging parameters
public
hasLoggingParams() : bool
Return values
boolhasName()
Has name
public
hasName() : bool
Return values
boolhasStarted()
Determined if the timer has started
public
hasStarted() : bool
Return values
boolhasStopped()
Determined if the timer has stopped
public
hasStopped() : bool
Return values
boollog()
Trigger handler logging
public
log() : void
Tags
prepare()
Prepare handler data for storage
public
prepare() : array<string|int, mixed>
Return values
array<string|int, mixed>prepareAsString()
Prepare handler data as string
public
prepareAsString() : string
Return values
stringprepareHeaderAsString()
Prepare header string
public
prepareHeaderAsString() : string
Return values
stringsetLogger()
Set logger
public
setLogger(Logger $logger) : AbstractHandler
Parameters
- $logger : Logger
Return values
AbstractHandlersetLoggingParams()
Set logger
public
setLoggingParams(array<string|int, mixed> $loggingParams) : AbstractHandler
Parameters
- $loggingParams : array<string|int, mixed>
Return values
AbstractHandlersetName()
Set name
public
setName(string $name) : AbstractHandler
Parameters
- $name : string
Return values
AbstractHandlerstart()
Start timer
public
start() : TimeHandler
Return values
TimeHandlerstop()
Stop timer
public
stop() : TimeHandler