vendor/symfony/stopwatch/Stopwatch.php line 17

  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. use Symfony\Contracts\Service\ResetInterface;
  16. // Help opcache.preload discover always-needed symbols
  17. class_exists(Section::class);
  19. /**
  20.  * Stopwatch provides a way to profile code.
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  */
  24. class Stopwatch implements ResetInterface
  25. {
  26.     private bool $morePrecision;
  28.     /**
  29.      * @var Section[]
  30.      */
  31.     private array $sections;
  33.     /**
  34.      * @var Section[]
  35.      */
  36.     private array $activeSections;
  38.     /**
  39.      * @param bool $morePrecision If true, time is stored as float to keep the original microsecond precision
  40.      */
  41.     public function __construct(bool $morePrecision = false)
  42.     {
  43.         $this->morePrecision = $morePrecision;
  44.         $this->reset();
  45.     }
  47.     /**
  48.      * @return Section[]
  49.      */
  50.     public function getSections(): array
  51.     {
  52.         return $this->sections;
  53.     }
  55.     /**
  56.      * Creates a new section or re-opens an existing section.
  57.      *
  58.      * @param string|null $id The id of the session to re-open, null to create a new one
  59.      *
  60.      * @throws \LogicException When the section to re-open is not reachable
  61.      */
  62.     public function openSection(string $id = null)
  63.     {
  64.         $current = end($this->activeSections);
  66.         if (null !== $id && null === $current->get($id)) {
  67.             throw new \LogicException(sprintf('The section "%s" has been started at an other level and cannot be opened.', $id));
  68.         }
  70.         $this->start('__section__.child', 'section');
  71.         $this->activeSections[] = $current->open($id);
  72.         $this->start('__section__');
  73.     }
  75.     /**
  76.      * Stops the last started section.
  77.      *
  78.      * The id parameter is used to retrieve the events from this section.
  79.      *
  80.      * @see getSectionEvents()
  81.      *
  82.      * @throws \LogicException When there's no started section to be stopped
  83.      */
  84.     public function stopSection(string $id)
  85.     {
  86.         $this->stop('__section__');
  88.         if (1 == \count($this->activeSections)) {
  89.             throw new \LogicException('There is no started section to stop.');
  90.         }
  92.         $this->sections[$id] = array_pop($this->activeSections)->setId($id);
  93.         $this->stop('__section__.child');
  94.     }
  96.     /**
  97.      * Starts an event.
  98.      */
  99.     public function start(string $name, string $category = null): StopwatchEvent
  100.     {
  101.         return end($this->activeSections)->startEvent($name, $category);
  102.     }
  104.     /**
  105.      * Checks if the event was started.
  106.      */
  107.     public function isStarted(string $name): bool
  108.     {
  109.         return end($this->activeSections)->isEventStarted($name);
  110.     }
  112.     /**
  113.      * Stops an event.
  114.      */
  115.     public function stop(string $name): StopwatchEvent
  116.     {
  117.         return end($this->activeSections)->stopEvent($name);
  118.     }
  120.     /**
  121.      * Stops then restarts an event.
  122.      */
  123.     public function lap(string $name): StopwatchEvent
  124.     {
  125.         return end($this->activeSections)->stopEvent($name)->start();
  126.     }
  128.     /**
  129.      * Returns a specific event by name.
  130.      */
  131.     public function getEvent(string $name): StopwatchEvent
  132.     {
  133.         return end($this->activeSections)->getEvent($name);
  134.     }
  136.     /**
  137.      * Gets all events for a given section.
  138.      *
  139.      * @return StopwatchEvent[]
  140.      */
  141.     public function getSectionEvents(string $id): array
  142.     {
  143.         return isset($this->sections[$id]) ? $this->sections[$id]->getEvents() : [];
  144.     }
  146.     /**
  147.      * Resets the stopwatch to its original state.
  148.      */
  149.     public function reset()
  150.     {
  151.         $this->sections = $this->activeSections = ['__root__' => new Section(null, $this->morePrecision)];
  152.     }
  153. }