1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Stopwatch
  7. \
  8. Stopwatch

Stopwatch

class Stopwatch implements ResetInterface

Stopwatch provides a way to profile code.

Methods

__construct(bool $morePrecision = false)

No description

Section[]
getSections()

No description

openSection(string|null $id = null)

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

stopSection(string $id)

Stops the last started section.

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

Starts an event.

bool
isStarted(string $name)

Checks if the event was started.

StopwatchEvent
stop(string $name)

Stops an event.

StopwatchEvent
lap(string $name)

Stops then restarts an event.

StopwatchEvent
getEvent(string $name)

Returns a specific event by name.

StopwatchEvent[]
getSectionEvents(string $id)

Gets all events for a given section.

reset()

Resets the stopwatch to its original state.

Details

__construct(bool $morePrecision = false)

Parameters

bool $morePrecision If true, time is stored as float to keep the original microsecond precision

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

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

Starts an event.

Parameters

string $name The event name
string|null $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[]

reset()

Resets the stopwatch to its original state.