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()
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

__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

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

A child section

string getId()

Return Value

string

The identifier of the section

Section setId(string $id)

Sets the session identifier.

Parameters

string

$id

The session identifier

Return Value

Section

The current section

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

Links:

http://api.symfony.com/master/Symfony/Component/Stopwatch/Section.html

doc_Symfony

2016-10-28 06:31:33

Comments