InnerResultArray.php

<?php
declare(strict_types=1);

namespace TheCodingMachine\TDBM;

use TheCodingMachine\TDBM\QueryFactory\SmartEagerLoad\ManyToOneDataLoader;
use TheCodingMachine\TDBM\QueryFactory\SmartEagerLoad\StorageNode;
use TheCodingMachine\TDBM\QueryFactory\SmartEagerLoad\StorageNodeTrait;

/*
 Copyright (C) 2006-2017 David Négrier - THE CODING MACHINE

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/**
 * Iterator used to retrieve results. It behaves like an array.
 */
class InnerResultArray extends InnerResultIterator implements StorageNode
{
    use StorageNodeTrait;

    /**
     * The list of results already fetched.
     *
     * @var AbstractTDBMObject[]
     */
    private $results = [];

    /**
     * Whether a offset exists.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
     *
     * @param mixed $offset <p>
     *                      An offset to check for.
     *                      </p>
     *
     * @return bool true on success or false on failure.
     *              </p>
     *              <p>
     *              The return value will be casted to boolean if non-boolean was returned
     *
     * @since 5.0.0
     */
    public function offsetExists($offset)
    {
        if ($this->count === 0) {
            return false;
        }
        try {
            $this->toIndex($offset);
        } catch (TDBMInvalidOffsetException $e) {
            return false;
        }

        return true;
    }

    /**
     * Offset to retrieve.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetget.php
     *
     * @param mixed $offset <p>
     *                      The offset to retrieve.
     *                      </p>
     *
     * @return mixed Can return all value types
     *
     * @since 5.0.0
     */
    public function offsetGet($offset)
    {
        $this->toIndex($offset);

        return $this->results[$offset];
    }

    /**
     * @param mixed $offset
     * @throws TDBMInvalidOffsetException
     */
    private function toIndex($offset): void
    {
        if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) {
            throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.');
        }
        if ($this->statement === null) {
            $this->executeQuery();
        }
        while (!isset($this->results[$offset])) {
            $this->next();
            if ($this->current === null) {
                throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.');
            }
        }
    }

    public function next()
    {
        // Let's overload the next() method to store the result.
        if (isset($this->results[$this->key + 1])) {
            ++$this->key;
            $this->current = $this->results[$this->key];
        } else {
            parent::next();
            if ($this->current !== null) {
                $this->results[$this->key] = $this->current;
            }
        }
    }

    /**
     * Overloads the rewind implementation.
     * Do not reexecute the query.
     */
    public function rewind()
    {
        if ($this->count === 0) {
            return;
        }
        if (!$this->fetchStarted) {
            $this->executeQuery();
        }
        $this->key = -1;
        $this->next();
    }
}