vendor/symfony/stopwatch/Section.php line 39

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Stopwatch;
  14. /**
  15.  * Stopwatch section.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  */
  19. class Section
  20. {
  21.     /**
  22.      * @var StopwatchEvent[]
  23.      */
  24.     private array $events = [];
  26.     private ?float $origin;
  27.     private bool $morePrecision;
  28.     private ?string $id = null;
  30.     /**
  31.      * @var Section[]
  32.      */
  33.     private array $children = [];
  35.     /**
  36.      * @param float|null $origin        Set the origin of the events in this section, use null to set their origin to their start time
  37.      * @param bool       $morePrecision If true, time is stored as float to keep the original microsecond precision
  38.      */
  39.     public function __construct(float $origin = null, bool $morePrecision = false)
  40.     {
  41.         $this->origin = $origin;
  42.         $this->morePrecision = $morePrecision;
  43.     }
  45.     /**
  46.      * Returns the child section.
  47.      */
  48.     public function get(string $id): ?self
  49.     {
  50.         foreach ($this->children as $child) {
  51.             if ($id === $child->getId()) {
  52.                 return $child;
  53.             }
  54.         }
  56.         return null;
  57.     }
  59.     /**
  60.      * Creates or re-opens a child section.
  61.      *
  62.      * @param string|null $id Null to create a new section, the identifier to re-open an existing one
  63.      */
  64.     public function open(?string $id): self
  65.     {
  66.         if (null === $id || null === $session = $this->get($id)) {
  67.             $session = $this->children[] = new self(microtime(true) * 1000, $this->morePrecision);
  68.         }
  70.         return $session;
  71.     }
  73.     public function getId(): ?string
  74.     {
  75.         return $this->id;
  76.     }
  78.     /**
  79.      * Sets the session identifier.
  80.      *
  81.      * @return $this
  82.      */
  83.     public function setId(string $id): static
  84.     {
  85.         $this->id = $id;
  87.         return $this;
  88.     }
  90.     /**
  91.      * Starts an event.
  92.      */
  93.     public function startEvent(string $name, ?string $category): StopwatchEvent
  94.     {
  95.         if (!isset($this->events[$name])) {
  96.             $this->events[$name] = new StopwatchEvent($this->origin ?: microtime(true) * 1000, $category, $this->morePrecision, $name);
  97.         }
  99.         return $this->events[$name]->start();
  100.     }
  102.     /**
  103.      * Checks if the event was started.
  104.      */
  105.     public function isEventStarted(string $name): bool
  106.     {
  107.         return isset($this->events[$name]) && $this->events[$name]->isStarted();
  108.     }
  110.     /**
  111.      * Stops an event.
  112.      *
  113.      * @throws \LogicException When the event has not been started
  114.      */
  115.     public function stopEvent(string $name): StopwatchEvent
  116.     {
  117.         if (!isset($this->events[$name])) {
  118.             throw new \LogicException(sprintf('Event "%s" is not started.', $name));
  119.         }
  121.         return $this->events[$name]->stop();
  122.     }
  124.     /**
  125.      * Stops then restarts an event.
  126.      *
  127.      * @throws \LogicException When the event has not been started
  128.      */
  129.     public function lap(string $name): StopwatchEvent
  130.     {
  131.         return $this->stopEvent($name)->start();
  132.     }
  134.     /**
  135.      * Returns a specific event by name.
  136.      *
  137.      * @throws \LogicException When the event is not known
  138.      */
  139.     public function getEvent(string $name): StopwatchEvent
  140.     {
  141.         if (!isset($this->events[$name])) {
  142.             throw new \LogicException(sprintf('Event "%s" is not known.', $name));
  143.         }
  145.         return $this->events[$name];
  146.     }
  148.     /**
  149.      * Returns the events from this section.
  150.      *
  151.      * @return StopwatchEvent[]
  152.      */
  153.     public function getEvents(): array
  154.     {
  155.         return $this->events;
  156.     }
  157. }