vendor/symfony/stopwatch/Section.php line 19

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. /**
  15.  * Stopwatch section.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  */
  19. class Section
  20. {
  21.     /**
  22.      * @var StopwatchEvent[]
  23.      */
  24.     private $events = [];
  26.     /**
  27.      * @var float|null
  28.      */
  29.     private $origin;
  31.     /**
  32.      * @var bool
  33.      */
  34.     private $morePrecision;
  36.     /**
  37.      * @var string
  38.      */
  39.     private $id;
  41.     /**
  42.      * @var Section[]
  43.      */
  44.     private $children = [];
  46.     /**
  47.      * @param float|null $origin        Set the origin of the events in this section, use null to set their origin to their start time
  48.      * @param bool       $morePrecision If true, time is stored as float to keep the original microsecond precision
  49.      */
  50.     public function __construct(float $origin = null, bool $morePrecision = false)
  51.     {
  52.         $this->origin = $origin;
  53.         $this->morePrecision = $morePrecision;
  54.     }
  56.     /**
  57.      * Returns the child section.
  58.      *
  59.      * @return self|null
  60.      */
  61.     public function get(string $id)
  62.     {
  63.         foreach ($this->children as $child) {
  64.             if ($id === $child->getId()) {
  65.                 return $child;
  66.             }
  67.         }
  69.         return null;
  70.     }
  72.     /**
  73.      * Creates or re-opens a child section.
  74.      *
  75.      * @param string|null $id Null to create a new section, the identifier to re-open an existing one
  76.      *
  77.      * @return self
  78.      */
  79.     public function open(?string $id)
  80.     {
  81.         if (null === $id || null === $session = $this->get($id)) {
  82.             $session = $this->children[] = new self(microtime(true) * 1000, $this->morePrecision);
  83.         }
  85.         return $session;
  86.     }
  88.     /**
  89.      * @return string
  90.      */
  91.     public function getId()
  92.     {
  93.         return $this->id;
  94.     }
  96.     /**
  97.      * Sets the session identifier.
  98.      *
  99.      * @return $this
  100.      */
  101.     public function setId(string $id)
  102.     {
  103.         $this->id = $id;
  105.         return $this;
  106.     }
  108.     /**
  109.      * Starts an event.
  110.      *
  111.      * @return StopwatchEvent
  112.      */
  113.     public function startEvent(string $name, ?string $category)
  114.     {
  115.         if (!isset($this->events[$name])) {
  116.             $this->events[$name] = new StopwatchEvent($this->origin ?: microtime(true) * 1000, $category, $this->morePrecision, $name);
  117.         }
  119.         return $this->events[$name]->start();
  120.     }
  122.     /**
  123.      * Checks if the event was started.
  124.      *
  125.      * @return bool
  126.      */
  127.     public function isEventStarted(string $name)
  128.     {
  129.         return isset($this->events[$name]) && $this->events[$name]->isStarted();
  130.     }
  132.     /**
  133.      * Stops an event.
  134.      *
  135.      * @return StopwatchEvent
  136.      *
  137.      * @throws \LogicException When the event has not been started
  138.      */
  139.     public function stopEvent(string $name)
  140.     {
  141.         if (!isset($this->events[$name])) {
  142.             throw new \LogicException(sprintf('Event "%s" is not started.', $name));
  143.         }
  145.         return $this->events[$name]->stop();
  146.     }
  148.     /**
  149.      * Stops then restarts an event.
  150.      *
  151.      * @return StopwatchEvent
  152.      *
  153.      * @throws \LogicException When the event has not been started
  154.      */
  155.     public function lap(string $name)
  156.     {
  157.         return $this->stopEvent($name)->start();
  158.     }
  160.     /**
  161.      * Returns a specific event by name.
  162.      *
  163.      * @return StopwatchEvent
  164.      *
  165.      * @throws \LogicException When the event is not known
  166.      */
  167.     public function getEvent(string $name)
  168.     {
  169.         if (!isset($this->events[$name])) {
  170.             throw new \LogicException(sprintf('Event "%s" is not known.', $name));
  171.         }
  173.         return $this->events[$name];
  174.     }
  176.     /**
  177.      * Returns the events from this section.
  178.      *
  179.      * @return StopwatchEvent[]
  180.      */
  181.     public function getEvents()
  182.     {
  183.         return $this->events;
  184.     }
  185. }