Stopwatch

__construct()

Section[] getSections()

Return Value

Section[]

openSection(string|null $id = null)

Creates a new section or re-opens an existing section.

Parameters

string|null

$id

The id of the session to re-open, null to create a new one

Exceptions

LogicException

When the section to re-open is not reachable

stopSection(string $id)

Stops the last started section.

The id parameter is used to retrieve the events from this section.

Parameters

string

$id

The identifier of the section

Exceptions

LogicException

When there's no started section to be stopped

See also

getSectionEvents()

StopwatchEvent start(string $name, string $category = null)

Starts an event.

Parameters

string	$name	The event name
string	$category	The event category

Return Value

StopwatchEvent

bool isStarted(string $name)

Checks if the event was started.

Parameters

string

$name

The event name

Return Value

bool

StopwatchEvent stop(string $name)

Stops an event.

Parameters

string

$name

The event name

Return Value

StopwatchEvent

StopwatchEvent lap(string $name)

Stops then restarts an event.

Parameters

string

$name

The event name

Return Value

StopwatchEvent

StopwatchEvent getEvent(string $name)

Returns a specific event by name.

Parameters

string

$name

The event name

Return Value

StopwatchEvent

StopwatchEvent[] getSectionEvents(string $id)

Gets all events for a given section.

Parameters

string

$id

A section identifier

Return Value

StopwatchEvent[]