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

Section

class Section

Stopwatch section.

Methods

__construct(float|null $origin = null)

Constructor.

Section|null
get(string $id)

Returns the child section.

Section
open(string|null $id)

Creates or re-opens a child section.

string
getId()

No description

Section
setId(string $id)

Sets the session identifier.

StopwatchEvent
startEvent(string $name, string $category)

Starts an event.

bool
isEventStarted(string $name)

Checks if the event was started.

StopwatchEvent
stopEvent(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[]
getEvents()

Returns the events from this section.

Details

at line line 46
__construct(float|null $origin = null)

Constructor.

Parameters

float|null $origin Set the origin of the events in this section, use null to set their origin to their start time

at line line 58
Section|null get(string $id)

Returns the child section.

Parameters

string $id The child section identifier

Return Value

Section|null The child section or null when none found

at line line 74
Section open(string|null $id)

Creates or re-opens a child section.

Parameters

string|null $id null to create a new section, the identifier to re-open an existing one.

Return Value

Section A child section

at line line 86
string getId()

Return Value

string The identifier of the section

at line line 98
Section setId(string $id)

Sets the session identifier.

Parameters

string $id The session identifier

Return Value

Section The current section

at line line 113
StopwatchEvent startEvent(string $name, string $category)

Starts an event.

Parameters

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

Return Value

StopwatchEvent The event

at line line 129
bool isEventStarted(string $name)

Checks if the event was started.

Parameters

string $name The event name

Return Value

bool

at line line 143
StopwatchEvent stopEvent(string $name)

Stops an event.

Parameters

string $name The event name

Return Value

StopwatchEvent The event

Exceptions

LogicException When the event has not been started

at line line 161
StopwatchEvent lap(string $name)

Stops then restarts an event.

Parameters

string $name The event name

Return Value

StopwatchEvent The event

Exceptions

LogicException When the event has not been started

at line line 175
StopwatchEvent getEvent(string $name)

Returns a specific event by name.

Parameters

string $name The event name

Return Value

StopwatchEvent The event

Exceptions

LogicException When the event is not known

at line line 189
StopwatchEvent[] getEvents()

Returns the events from this section.

Return Value

StopwatchEvent[] An array of StopwatchEvent instances