vendor/symfony/stopwatch/Stopwatch.php line 24

Open in your IDE?
  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.     /**
  27.      * @var bool
  28.      */
  29.     private $morePrecision;
  31.     /**
  32.      * @var Section[]
  33.      */
  34.     private $sections;
  36.     /**
  37.      * @var Section[]
  38.      */
  39.     private $activeSections;
  41.     /**
  42.      * @param bool $morePrecision If true, time is stored as float to keep the original microsecond precision
  43.      */
  44.     public function __construct(bool $morePrecision = false)
  45.     {
  46.         $this->morePrecision = $morePrecision;
  47.         $this->reset();
  48.     }
  50.     /**
  51.      * @return Section[]
  52.      */
  53.     public function getSections()
  54.     {
  55.         return $this->sections;
  56.     }
  58.     /**
  59.      * Creates a new section or re-opens an existing section.
  60.      *
  61.      * @param string|null $id The id of the session to re-open, null to create a new one
  62.      *
  63.      * @throws \LogicException When the section to re-open is not reachable
  64.      */
  65.     public function openSection(string $id = null)
  66.     {
  67.         $current = end($this->activeSections);
  69.         if (null !== $id && null === $current->get($id)) {
  70.             throw new \LogicException(sprintf('The section "%s" has been started at an other level and cannot be opened.', $id));
  71.         }
  73.         $this->start('__section__.child', 'section');
  74.         $this->activeSections[] = $current->open($id);
  75.         $this->start('__section__');
  76.     }
  78.     /**
  79.      * Stops the last started section.
  80.      *
  81.      * The id parameter is used to retrieve the events from this section.
  82.      *
  83.      * @see getSectionEvents()
  84.      *
  85.      * @throws \LogicException When there's no started section to be stopped
  86.      */
  87.     public function stopSection(string $id)
  88.     {
  89.         $this->stop('__section__');
  91.         if (1 == \count($this->activeSections)) {
  92.             throw new \LogicException('There is no started section to stop.');
  93.         }
  95.         $this->sections[$id] = array_pop($this->activeSections)->setId($id);
  96.         $this->stop('__section__.child');
  97.     }
  99.     /**
  100.      * Starts an event.
  101.      *
  102.      * @return StopwatchEvent
  103.      */
  104.     public function start(string $name, string $category = null)
  105.     {
  106.         return end($this->activeSections)->startEvent($name, $category);
  107.     }
  109.     /**
  110.      * Checks if the event was started.
  111.      *
  112.      * @return bool
  113.      */
  114.     public function isStarted(string $name)
  115.     {
  116.         return end($this->activeSections)->isEventStarted($name);
  117.     }
  119.     /**
  120.      * Stops an event.
  121.      *
  122.      * @return StopwatchEvent
  123.      */
  124.     public function stop(string $name)
  125.     {
  126.         return end($this->activeSections)->stopEvent($name);
  127.     }
  129.     /**
  130.      * Stops then restarts an event.
  131.      *
  132.      * @return StopwatchEvent
  133.      */
  134.     public function lap(string $name)
  135.     {
  136.         return end($this->activeSections)->stopEvent($name)->start();
  137.     }
  139.     /**
  140.      * Returns a specific event by name.
  141.      *
  142.      * @return StopwatchEvent
  143.      */
  144.     public function getEvent(string $name)
  145.     {
  146.         return end($this->activeSections)->getEvent($name);
  147.     }
  149.     /**
  150.      * Gets all events for a given section.
  151.      *
  152.      * @return StopwatchEvent[]
  153.      */
  154.     public function getSectionEvents(string $id)
  155.     {
  156.         return isset($this->sections[$id]) ? $this->sections[$id]->getEvents() : [];
  157.     }
  159.     /**
  160.      * Resets the stopwatch to its original state.
  161.      */
  162.     public function reset()
  163.     {
  164.         $this->sections = $this->activeSections = ['__root__' => new Section(null, $this->morePrecision)];
  165.     }
  166. }