vendor/doctrine/orm/src/Internal/Hydration/IterableResult.php line 42

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Internal\Hydration;
  7. use Iterator;
  8. use ReturnTypeWillChange;
  10. /**
  11.  * Represents a result structure that can be iterated over, hydrating row-by-row
  12.  * during the iteration. An IterableResult is obtained by AbstractHydrator#iterate().
  13.  *
  14.  * @deprecated
  15.  */
  16. class IterableResult implements Iterator
  17. {
  18.     /** @var AbstractHydrator */
  19.     private $hydrator;
  21.     /** @var bool */
  22.     private $rewinded = false;
  24.     /** @var int */
  25.     private $key = -1;
  27.     /** @var mixed[]|null */
  28.     private $current = null;
  30.     /** @param AbstractHydrator $hydrator */
  31.     public function __construct($hydrator)
  32.     {
  33.         $this->hydrator = $hydrator;
  34.     }
  36.     /**
  37.      * @return void
  38.      *
  39.      * @throws HydrationException
  40.      */
  41.     #[ReturnTypeWillChange]
  42.     public function rewind()
  43.     {
  44.         if ($this->rewinded === true) {
  45.             throw new HydrationException('Can only iterate a Result once.');
  46.         }
  48.         $this->current  = $this->next();
  49.         $this->rewinded = true;
  50.     }
  52.     /**
  53.      * Gets the next set of results.
  54.      *
  55.      * @return mixed[]|false
  56.      */
  57.     #[ReturnTypeWillChange]
  58.     public function next()
  59.     {
  60.         $this->current = $this->hydrator->hydrateRow();
  61.         $this->key++;
  63.         return $this->current;
  64.     }
  66.     /** @return mixed */
  67.     #[ReturnTypeWillChange]
  68.     public function current()
  69.     {
  70.         return $this->current;
  71.     }
  73.     /** @return int */
  74.     #[ReturnTypeWillChange]
  75.     public function key()
  76.     {
  77.         return $this->key;
  78.     }
  80.     /** @return bool */
  81.     #[ReturnTypeWillChange]
  82.     public function valid()
  83.     {
  84.         return $this->current !== false;
  85.     }
  86. }