vendor/doctrine/orm/lib/Doctrine/ORM/Query/TreeWalkerChainIterator.php line 69

Open in your IDE?
  1. <?php
  3. /*
  4.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  5.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  6.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  7.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  8.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  9.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  10.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  11.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  12.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  13.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  14.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  15.  *
  16.  * This software consists of voluntary contributions made by many individuals
  17.  * and is licensed under the MIT license. For more information, see
  18.  * <http://www.doctrine-project.org>.
  19.  */
  21. namespace Doctrine\ORM\Query;
  23. use ArrayAccess;
  24. use Doctrine\ORM\AbstractQuery;
  25. use Iterator;
  27. use function key;
  28. use function next;
  29. use function reset;
  31. /**
  32.  * @template-implements Iterator<TreeWalker>
  33.  * @template-implements ArrayAccess<int, TreeWalker>
  34.  */
  35. class TreeWalkerChainIterator implements Iterator, ArrayAccess
  36. {
  37.     /** @var class-string<TreeWalker>[] */
  38.     private $walkers = [];
  39.     /** @var TreeWalkerChain */
  40.     private $treeWalkerChain;
  41.     /** @var AbstractQuery */
  42.     private $query;
  43.     /** @var ParserResult */
  44.     private $parserResult;
  46.     /**
  47.      * @param AbstractQuery $query
  48.      * @param ParserResult  $parserResult
  49.      */
  50.     public function __construct(TreeWalkerChain $treeWalkerChain, $query, $parserResult)
  51.     {
  52.         $this->treeWalkerChain = $treeWalkerChain;
  53.         $this->query           = $query;
  54.         $this->parserResult    = $parserResult;
  55.     }
  57.     /**
  58.      * @return string|false
  59.      * @psalm-return class-string<TreeWalker>|false
  60.      */
  61.     public function rewind()
  62.     {
  63.         return reset($this->walkers);
  64.     }
  66.     /**
  67.      * @return TreeWalker|null
  68.      */
  69.     public function current()
  70.     {
  71.         return $this->offsetGet(key($this->walkers));
  72.     }
  74.     /**
  75.      * @return int
  76.      */
  77.     public function key()
  78.     {
  79.         return key($this->walkers);
  80.     }
  82.     /**
  83.      * @return TreeWalker|null
  84.      */
  85.     public function next()
  86.     {
  87.         next($this->walkers);
  89.         return $this->offsetGet(key($this->walkers));
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function valid()
  96.     {
  97.         return key($this->walkers) !== null;
  98.     }
  100.     /**
  101.      * {@inheritdoc}
  102.      */
  103.     public function offsetExists($offset)
  104.     {
  105.         return isset($this->walkers[$offset]);
  106.     }
  108.     /**
  109.      * @psalm-param array-key|null $offset
  110.      *
  111.      * @return TreeWalker|null
  112.      */
  113.     public function offsetGet($offset)
  114.     {
  115.         if ($this->offsetExists($offset)) {
  116.             return new $this->walkers[$offset](
  117.                 $this->query,
  118.                 $this->parserResult,
  119.                 $this->treeWalkerChain->getQueryComponents()
  120.             );
  121.         }
  123.         return null;
  124.     }
  126.     /**
  127.      * {@inheritdoc}
  128.      *
  129.      * @param string $value
  130.      * @psalm-param array-key|null $offset
  131.      */
  132.     public function offsetSet($offset, $value)
  133.     {
  134.         if ($offset === null) {
  135.             $this->walkers[] = $value;
  136.         } else {
  137.             $this->walkers[$offset] = $value;
  138.         }
  139.     }
  141.     /**
  142.      * {@inheritdoc}
  143.      */
  144.     public function offsetUnset($offset)
  145.     {
  146.         if ($this->offsetExists($offset)) {
  147.             unset($this->walkers[$offset]);
  148.         }
  149.     }
  150. }