QueryResult.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Extbase\Persistence\Generic;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Persistence\ForwardCompatibleQueryResultInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper;
use ‪TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
use ‪TYPO3\CMS\Extbase\Persistence\QueryInterface;
use ‪TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 
class ‪QueryResult implements ‪QueryResultInterface, ‪ForwardCompatibleQueryResultInterface
{
    protected ‪DataMapper ‪$dataMapper;
    protected ‪PersistenceManagerInterface ‪$persistenceManager;
 
    protected ‪$numberOfResults;
 
    protected ?‪QueryInterface ‪$query = null;
 
    protected ‪$queryResult;
 
    public function ‪__construct(
        ‪DataMapper ‪$dataMapper,
        ‪PersistenceManagerInterface ‪$persistenceManager
    ) {
        $this->dataMapper = ‪$dataMapper;
        $this->persistenceManager = ‪$persistenceManager;
    }
 
    public function ‪setQuery(‪QueryInterface ‪$query): void
    {
        $this->query = ‪$query;
        $this->dataMapper->setQuery(‪$query);
    }
 
    protected function ‪initialize()
    {
        if (!is_array($this->queryResult)) {
            $this->queryResult = $this->dataMapper->map($this->query->getType(), $this->persistenceManager->getObjectDataByQuery($this->query));
        }
    }
 
    public function ‪getQuery()
    {
        return clone ‪$this->query;
    }
 
    public function ‪getFirst()
    {
        if (is_array($this->queryResult)) {
            ‪$queryResult = ‪$this->queryResult;
            reset(‪$queryResult);
        } else {
            ‪$query = $this->‪getQuery();
            $query->‪setLimit(1);
            ‪$queryResult = $this->dataMapper->map(‪$query->‪getType(), $this->persistenceManager->getObjectDataByQuery(‪$query));
        }
        $firstResult = ‪current(‪$queryResult);
        if ($firstResult === false) {
            $firstResult = null;
        }
        return $firstResult;
    }
 
    #[\ReturnTypeWillChange]
    public function ‪count()
    {
        if ($this->numberOfResults === null) {
            if (is_array($this->queryResult)) {
                $this->numberOfResults = ‪count($this->queryResult);
            } else {
                $this->numberOfResults = $this->persistenceManager->getObjectCountByQuery($this->query);
            }
        }
        return ‪$this->numberOfResults;
    }
 
    public function ‪toArray()
    {
        $this->‪initialize();
        return iterator_to_array($this);
    }
 
    #[\ReturnTypeWillChange]
    public function ‪offsetExists($offset)
    {
        $this->‪initialize();
        return isset($this->queryResult[$offset]);
    }
 
    #[\ReturnTypeWillChange]
    public function ‪offsetGet($offset)
    {
        $this->‪initialize();
        return $this->queryResult[$offset] ?? null;
    }
 
    #[\ReturnTypeWillChange]
    public function ‪offsetSet($offset, $value)
    {
        $this->‪initialize();
        $this->numberOfResults = null;
        $this->queryResult[$offset] = $value;
    }
 
    #[\ReturnTypeWillChange]
    public function ‪offsetUnset($offset)
    {
        $this->‪initialize();
        $this->numberOfResults = null;
        unset($this->queryResult[$offset]);
    }
 
    #[\ReturnTypeWillChange]
    public function ‪current()
    {
        $this->‪initialize();
        return ‪current($this->queryResult);
    }
 
    #[\ReturnTypeWillChange]
    public function ‪key()
    {
        $this->‪initialize();
        return ‪key($this->queryResult);
    }
 
    #[\ReturnTypeWillChange]
    public function ‪next()
    {
        $this->‪initialize();
        ‪next($this->queryResult);
    }
 
    #[\ReturnTypeWillChange]
    public function ‪rewind()
    {
        $this->‪initialize();
        reset($this->queryResult);
    }
 
    #[\ReturnTypeWillChange]
    public function ‪valid()
    {
        $this->‪initialize();
        return ‪current($this->queryResult) !== false;
    }
 
    public function ‪__wakeup()
    {
        $this->persistenceManager = GeneralUtility::makeInstance(PersistenceManagerInterface::class);
        $this->dataMapper = GeneralUtility::makeInstance(DataMapper::class);
    }
 
    public function ‪__sleep()
    {
        return ['query'];
    }
}