Section
class Section
Stopwatch section.
Methods
__construct(float $origin = null, bool $morePrecision = false) | ||
Section|null | get(string $id) Returns the child section. | |
Section | open(string|null $id) Creates or re-opens a child section. | |
string | getId() | |
$this | 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
__construct(float $origin = null, bool $morePrecision = false)
Parameters
float | $origin | Set the origin of the events in this section, use null to set their origin to their start time |
bool | $morePrecision | If true, time is stored as float to keep the original microsecond precision |
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 |
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 |
string getId()
Return Value
string | The identifier of the section |
$this setId(string $id)
Sets the session identifier.
Parameters
string | $id | The session identifier |
Return Value
$this |
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 |
bool isEventStarted(string $name)
Checks if the event was started.
Parameters
string | $name | The event name |
Return Value
bool |
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 |
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 |
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 |
StopwatchEvent[] getEvents()
Returns the events from this section.
Return Value
StopwatchEvent[] | An array of StopwatchEvent instances |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Stopwatch/Section.html