vendor/doctrine/mongodb-odm/lib/Doctrine/ODM/MongoDB/Iterator/HydratingIterator.php line 120

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ODM\MongoDB\Iterator;
  7. use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
  8. use Doctrine\ODM\MongoDB\UnitOfWork;
  9. use Generator;
  10. use Iterator;
  11. use ReturnTypeWillChange;
  12. use RuntimeException;
  13. use Traversable;
  15. /**
  16.  * Iterator that wraps a traversable and hydrates results into objects
  17.  *
  18.  * @internal
  19.  *
  20.  * @psalm-import-type Hints from UnitOfWork
  21.  *
  22.  * @template TValue
  23.  * @template TDocument of object
  24.  * @template-implements Iterator<TValue>
  25.  */
  26. final class HydratingIterator implements Iterator
  27. {
  28.     /** @var Generator<mixed, TValue>|null */
  29.     private $iterator;
  31.     /** @var UnitOfWork */
  32.     private $unitOfWork;
  34.     /** @var ClassMetadata<TDocument> */
  35.     private $class;
  37.     /**
  38.      * @var array<int, mixed>
  39.      * @psalm-var Hints
  40.      */
  41.     private $unitOfWorkHints;
  43.     /**
  44.      * @param Traversable<mixed, TValue> $traversable
  45.      * @param ClassMetadata<TDocument>   $class
  46.      * @psalm-param Hints $unitOfWorkHints
  47.      */
  48.     public function __construct(Traversable $traversable, UnitOfWork $unitOfWork, ClassMetadata $class, array $unitOfWorkHints = [])
  49.     {
  50.         $this->iterator        = $this->wrapTraversable($traversable);
  51.         $this->unitOfWork      = $unitOfWork;
  52.         $this->class           = $class;
  53.         $this->unitOfWorkHints = $unitOfWorkHints;
  54.     }
  56.     public function __destruct()
  57.     {
  58.         $this->iterator = null;
  59.     }
  61.     /**
  62.      * @return TDocument|null
  63.      */
  64.     #[ReturnTypeWillChange]
  65.     public function current()
  66.     {
  67.         return $this->hydrate($this->getIterator()->current());
  68.     }
  70.     /**
  71.      * @return mixed
  72.      */
  73.     #[ReturnTypeWillChange]
  74.     public function key()
  75.     {
  76.         return $this->getIterator()->key();
  77.     }
  79.     /**
  80.      * @see http://php.net/iterator.next
  81.      */
  82.     public function next(): void
  83.     {
  84.         $this->getIterator()->next();
  85.     }
  87.     /**
  88.      * @see http://php.net/iterator.rewind
  89.      */
  90.     public function rewind(): void
  91.     {
  92.         $this->getIterator()->rewind();
  93.     }
  95.     /**
  96.      * @see http://php.net/iterator.valid
  97.      */
  98.     public function valid(): bool
  99.     {
  100.         return $this->key() !== null;
  101.     }
  103.     /**
  104.      * @return Generator<mixed, TValue>
  105.      */
  106.     private function getIterator(): Generator
  107.     {
  108.         if ($this->iterator === null) {
  109.             throw new RuntimeException('Iterator has already been destroyed');
  110.         }
  112.         return $this->iterator;
  113.     }
  115.     /**
  116.      * @param array<string, mixed>|null $document
  117.      *
  118.      * @return TDocument|null
  119.      */
  120.     private function hydrate(?array $document): ?object
  121.     {
  122.         return $document !== null ? $this->unitOfWork->getOrCreateDocument($this->class->name, $document, $this->unitOfWorkHints) : null;
  123.     }
  125.     /**
  126.      * @param Traversable<mixed, TValue> $traversable
  127.      *
  128.      * @return Generator<mixed, TValue>
  129.      */
  130.     private function wrapTraversable(Traversable $traversable): Generator
  131.     {
  132.         foreach ($traversable as $key => $value) {
  133.             yield $key => $value;
  134.         }
  135.     }
  136. }