feature #54854 [Stopwatch] Add ROOT constant to make it easier to reference (hacfi)

fabpot · fabpot · commit 8691af24668c · 2024-05-21T21:28:19.000+02:00
This PR was merged into the 7.2 branch. Discussion ---------- [Stopwatch] Add `ROOT` constant to make it easier to reference | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | - | License | MIT Just an DX improvement so you can reference the root section with `$stopwatch->getSectionEvents(Stopwatch::ROOT)` instead of `$stopwatch->getSectionEvents('__root__')`. Commits ------- fadeafd [Stopwatch] Add `getRootSectionEvents` method `ROOT` constant to `Stopwatch`
diff --git a/src/Symfony/Component/Stopwatch/CHANGELOG.md b/src/Symfony/Component/Stopwatch/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add method `getLastPeriod()` to `StopwatchEvent`
+ * Add `getRootSectionEvents()` method and `ROOT` constant to `Stopwatch`
 
 5.2
 ---
diff --git a/src/Symfony/Component/Stopwatch/Stopwatch.php b/src/Symfony/Component/Stopwatch/Stopwatch.php
@@ -23,6 +23,8 @@ class_exists(Section::class);
  */
 class Stopwatch implements ResetInterface
 {
+    public const ROOT = '__root__';
+
     /**
      * @var Section[]
      */
@@ -138,14 +140,24 @@ public function getEvent(string $name): StopwatchEvent
      */
     public function getSectionEvents(string $id): array
     {
-        return isset($this->sections[$id]) ? $this->sections[$id]->getEvents() : [];
+        return $this->sections[$id]->getEvents() ?? [];
+    }
+
+    /**
+     * Gets all events for the root section.
+     *
+     * @return StopwatchEvent[]
+     */
+    public function getRootSectionEvents(): array
+    {
+        return $this->sections[self::ROOT]->getEvents() ?? [];
     }
 
     /**
      * Resets the stopwatch to its original state.
      */
     public function reset(): void
     {
-        $this->sections = $this->activeSections = ['__root__' => new Section(null, $this->morePrecision)];
+        $this->sections = $this->activeSections = [self::ROOT => new Section(null, $this->morePrecision)];
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@ class_exists(Section::class);`
`23`	`23`	`*/`
`24`	`24`	`class Stopwatch implements ResetInterface`
`25`	`25`	`{`
	`26`	`+ public const ROOT = '__root__';`
	`27`	`+`
`26`	`28`	`/**`
`27`	`29`	`* @var Section[]`
`28`	`30`	`*/`
`@@ -138,14 +140,24 @@ public function getEvent(string $name): StopwatchEvent`
`138`	`140`	`*/`
`139`	`141`	`public function getSectionEvents(string $id): array`
`140`	`142`	`{`
`141`		`- return isset($this->sections[$id]) ? $this->sections[$id]->getEvents() : [];`
	`143`	`+ return $this->sections[$id]->getEvents() ?? [];`
	`144`	`+ }`
	`145`	`+`
	`146`	`+ /**`
	`147`	`+ * Gets all events for the root section.`
	`148`	`+ *`
	`149`	`+ * @return StopwatchEvent[]`
	`150`	`+ */`
	`151`	`+ public function getRootSectionEvents(): array`
	`152`	`+ {`
	`153`	`+ return $this->sections[self::ROOT]->getEvents() ?? [];`
`142`	`154`	`}`
`143`	`155`
`144`	`156`	`/**`
`145`	`157`	`* Resets the stopwatch to its original state.`
`146`	`158`	`*/`
`147`	`159`	`public function reset(): void`
`148`	`160`	`{`
`149`		`- $this->sections = $this->activeSections = ['__root__' => new Section(null, $this->morePrecision)];`
	`161`	`+ $this->sections = $this->activeSections = [self::ROOT => new Section(null, $this->morePrecision)];`
`150`	`162`	`}`
`151`	`163`	`}`