1. class
  2. Symfony
  3. Component
  4. Stopwatch
  5. StopwatchEvent

StopwatchEvent

class StopwatchEvent

Represents an Event managed by Stopwatch.

Methods

__construct(float $origin, string|null $category = null)

Constructor.

string
getCategory()

Gets the category.

float
getOrigin()

Gets the origin.

StopwatchEvent
start()

Starts a new event period.

StopwatchEvent
stop()

Stops the last started event period.

bool
isStarted()

Checks if the event was started.

StopwatchEvent
lap()

Stops the current period and then starts a new one.

ensureStopped()

Stops all non already stopped periods.

StopwatchPeriod[]
getPeriods()

Gets all event periods.

int
getStartTime()

Gets the relative time of the start of the first period.

int
getEndTime()

Gets the relative time of the end of the last period.

int
getDuration()

Gets the duration of the events (including all periods).

int
getMemory()

Gets the max memory usage of all periods.

string
__toString()

No description

Details

at line line 49
__construct(float $origin, string|null $category = null)

Constructor.

Parameters

float $origin The origin time in milliseconds
string|null $category The event category or null to use the default

Exceptions

InvalidArgumentException When the raw time is not valid

at line line 60
string getCategory()

Gets the category.

Return Value

string The category

at line line 70
float getOrigin()

Gets the origin.

Return Value

float The origin in milliseconds

at line line 80
StopwatchEvent start()

Starts a new event period.

Return Value

StopwatchEvent The event

at line line 96
StopwatchEvent stop()

Stops the last started event period.

Return Value

StopwatchEvent The event

Exceptions

LogicException When start wasn't called before stopping
LogicException When stop() is called without a matching call to start()

at line line 112
bool isStarted()

Checks if the event was started.

Return Value

bool

at line line 122
StopwatchEvent lap()

Stops the current period and then starts a new one.

Return Value

StopwatchEvent The event

at line line 130
ensureStopped()

Stops all non already stopped periods.

at line line 142
StopwatchPeriod[] getPeriods()

Gets all event periods.

Return Value

StopwatchPeriod[] An array of StopwatchPeriod instances

at line line 152
int getStartTime()

Gets the relative time of the start of the first period.

Return Value

int The time (in milliseconds)

at line line 162
int getEndTime()

Gets the relative time of the end of the last period.

Return Value

int The time (in milliseconds)

at line line 174
int getDuration()

Gets the duration of the events (including all periods).

Return Value

int The duration (in milliseconds)

at line line 198
int getMemory()

Gets the max memory usage of all periods.

Return Value

int The memory usage (in bytes)

at line line 241
string __toString()

Return Value

string