vendor/jackalope/jackalope/src/Jackalope/Query/RowIterator.php line 84

  1. <?php
  3. namespace Jackalope\Query;
  5. use Countable;
  6. use SeekableIterator;
  7. use OutOfBoundsException;
  8. use Jackalope\ObjectManager;
  9. use Jackalope\FactoryInterface;
  11. /**
  12.  * Iterator to efficiently iterate over the raw query result.
  13.  *
  14.  * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
  15.  * @license http://opensource.org/licenses/MIT MIT License
  16.  */
  17. class RowIterator implements SeekableIterator, Countable
  18. {
  19.     /**
  20.      * @var ObjectManager
  21.      */
  22.     protected $objectManager;
  24.     /**
  25.      * @var FactoryInterface
  26.      */
  27.     protected $factory;
  29.     /**
  30.      * @var array
  31.      */
  32.     protected $rows;
  34.     /**
  35.      * @var integer
  36.      */
  37.     protected $position = 0;
  39.     /**
  40.      * Create the iterator.
  41.      *
  42.      * @param FactoryInterface $factory       the object factory
  43.      * @param ObjectManager    $objectManager
  44.      * @param array            $rows          Raw data as described in QueryResult and \Jackalope\Transport\TransportInterface
  45.      */
  46.     public function __construct(FactoryInterface $factory, ObjectManager $objectManager, $rows)
  47.     {
  48.         $this->factory = $factory;
  49.         $this->objectManager = $objectManager;
  50.         $this->rows = $rows;
  51.     }
  53.     /**
  54.      * @param int $position
  55.      *
  56.      * @throws OutOfBoundsException
  57.      */
  58.     #[\ReturnTypeWillChange]
  59.     public function seek($position)
  60.     {
  61.         $this->position = $position;
  63.         if (!$this->valid()) {
  64.             throw new OutOfBoundsException("invalid seek position ($position)");
  65.         }
  66.     }
  68.     /**
  69.      * @return integer
  70.      */
  71.     #[\ReturnTypeWillChange]
  72.     public function count()
  73.     {
  74.         return count($this->rows);
  75.     }
  77.     #[\ReturnTypeWillChange]
  78.     public function rewind()
  79.     {
  80.         $this->position = 0;
  81.     }
  83.     #[\ReturnTypeWillChange]
  84.     public function current()
  85.     {
  86.         if (!$this->valid()) {
  87.             return null;
  88.         }
  90.         return $this->factory->get(Row::class, [$this->objectManager, $this->rows[$this->position]]);
  91.     }
  93.     #[\ReturnTypeWillChange]
  94.     public function key()
  95.     {
  96.         return $this->position;
  97.     }
  99.     #[\ReturnTypeWillChange]
  100.     public function next()
  101.     {
  102.         ++$this->position;
  103.     }
  105.     /**
  106.      * @return boolean
  107.      */
  108.     #[\ReturnTypeWillChange]
  109.     public function valid()
  110.     {
  111.         return isset($this->rows[$this->position]);
  112.     }
  113. }