feature #37676 [Stopwatch] Add name property to the stopwatchEvent (AhmedRaafat14)

fabpot · fabpot · commit e29d2304bc2d · 2020-08-11T11:43:55.000+02:00
This PR was merged into the 5.2-dev branch. Discussion ---------- [Stopwatch] Add name property to the stopwatchEvent | Q | A | ------------- | --- | Branch? | master for features | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #37627 | License | MIT | Doc PR | symfony/symfony-docs#...  Commits ------- f2b64ec Add name property to the stopwatchEvent
diff --git a/src/Symfony/Component/Stopwatch/Section.php b/src/Symfony/Component/Stopwatch/Section.php
@@ -113,7 +113,7 @@ public function setId(string $id)
     public function startEvent(string $name, ?string $category)
     {
         if (!isset($this->events[$name])) {
-            $this->events[$name] = new StopwatchEvent($this->origin ?: microtime(true) * 1000, $category, $this->morePrecision);
+            $this->events[$name] = new StopwatchEvent($this->origin ?: microtime(true) * 1000, $category, $this->morePrecision, $name);
         }
 
         return $this->events[$name]->start();
diff --git a/src/Symfony/Component/Stopwatch/StopwatchEvent.php b/src/Symfony/Component/Stopwatch/StopwatchEvent.php
@@ -43,18 +43,25 @@ class StopwatchEvent
      */
     private $started = [];
 
+    /**
+     * @var string
+     */
+    private $name;
+
     /**
      * @param float       $origin        The origin time in milliseconds
      * @param string|null $category      The event category or null to use the default
      * @param bool        $morePrecision If true, time is stored as float to keep the original microsecond precision
+     * @param string|null $name          The event name or null to define the name as default
      *
      * @throws \InvalidArgumentException When the raw time is not valid
      */
-    public function __construct(float $origin, string $category = null, bool $morePrecision = false)
+    public function __construct(float $origin, string $category = null, bool $morePrecision = false, string $name = null)
     {
         $this->origin = $this->formatTime($origin);
         $this->category = \is_string($category) ? $category : 'default';
         $this->morePrecision = $morePrecision;
+        $this->name = $name ?? 'default';
     }
 
     /**
@@ -236,8 +243,16 @@ private function formatTime(float $time): float
         return round($time, 1);
     }
 
+    /**
+     * Gets the event name.
+     */
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
     public function __toString(): string
     {
-        return sprintf('%s: %.2F MiB - %d ms', $this->getCategory(), $this->getMemory() / 1024 / 1024, $this->getDuration());
+        return sprintf('%s/%s: %.2F MiB - %d ms', $this->getCategory(), $this->getName(), $this->getMemory() / 1024 / 1024, $this->getDuration());
     }
 }
diff --git a/src/Symfony/Component/Stopwatch/Tests/StopwatchEventTest.php b/src/Symfony/Component/Stopwatch/Tests/StopwatchEventTest.php
@@ -193,12 +193,24 @@ public function testStartTimeWhenStartedLater()
     public function testHumanRepresentation()
     {
         $event = new StopwatchEvent(microtime(true) * 1000);
-        $this->assertEquals('default: 0.00 MiB - 0 ms', (string) $event);
+        $this->assertEquals('default/default: 0.00 MiB - 0 ms', (string) $event);
         $event->start();
         $event->stop();
         $this->assertEquals(1, preg_match('/default: [0-9\.]+ MiB - [0-9]+ ms/', (string) $event));
 
         $event = new StopwatchEvent(microtime(true) * 1000, 'foo');
-        $this->assertEquals('foo: 0.00 MiB - 0 ms', (string) $event);
+        $this->assertEquals('foo/default: 0.00 MiB - 0 ms', (string) $event);
+
+        $event = new StopwatchEvent(microtime(true) * 1000, 'foo', false, 'name');
+        $this->assertEquals('foo/name: 0.00 MiB - 0 ms', (string) $event);
+    }
+
+    public function testGetName()
+    {
+        $event = new StopwatchEvent(microtime(true) * 1000);
+        $this->assertEquals('default', $event->getName());
+
+        $event = new StopwatchEvent(microtime(true) * 1000, 'cat', false, 'name');
+        $this->assertEquals('name', $event->getName());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ public function setId(string $id)`
`113`	`113`	`public function startEvent(string $name, ?string $category)`
`114`	`114`	`{`
`115`	`115`	`if (!isset($this->events[$name])) {`
`116`		`- $this->events[$name] = new StopwatchEvent($this->origin ?: microtime(true) * 1000, $category, $this->morePrecision);`
	`116`	`+ $this->events[$name] = new StopwatchEvent($this->origin ?: microtime(true) * 1000, $category, $this->morePrecision, $name);`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`return $this->events[$name]->start();`