Query.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 Psr\Container\ContainerInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Object\ObjectManager;
use ‪TYPO3\CMS\Extbase\Persistence\ForwardCompatibleQueryInterface;
use ‪TYPO3\CMS\Extbase\Persistence\ForwardCompatibleQueryResultInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Exception\InvalidNumberOfConstraintsException;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Exception\UnexpectedTypeException;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Qom\AndInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Qom\SelectorInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface;
use ‪TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
use ‪TYPO3\CMS\Extbase\Persistence\QueryInterface;
use ‪TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
use ‪TYPO3\CMS\Extbase\Utility\TypeHandlingUtility;
 
class ‪Query implements ‪QueryInterface, ‪ForwardCompatibleQueryInterface
{
    public const ‪JCR_JOIN_TYPE_INNER = '{http://www.jcp.org/jcr/1.0}joinTypeInner';
 
    public const ‪JCR_JOIN_TYPE_LEFT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeLeftOuter';
 
    public const ‪JCR_JOIN_TYPE_RIGHT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeRightOuter';
 
    public const ‪CHARSET = 'utf-8';
 
    protected ‪$type;
 
    protected ‪DataMapFactory ‪$dataMapFactory;
    protected ‪PersistenceManagerInterface ‪$persistenceManager;
    protected ‪QueryObjectModelFactory ‪$qomFactory;
    protected ContainerInterface ‪$container;
 
    protected ‪$source;
 
    protected ‪$constraint;
 
    protected ‪$statement;
 
    protected $orderings = [];
 
    protected $limit;
 
    protected $offset;
 
    protected $querySettings;
 
    protected $parentQuery;
 
    public function __construct(
        ‪DataMapFactory ‪$dataMapFactory,
        ‪PersistenceManagerInterface ‪$persistenceManager,
        ‪QueryObjectModelFactory ‪$qomFactory,
        ContainerInterface ‪$container
    ) {
        $this->‪dataMapFactory = ‪$dataMapFactory;
        $this->‪persistenceManager = ‪$persistenceManager;
        $this->‪qomFactory = ‪$qomFactory;
        $this->‪container = ‪$container;
    }
 
    public function ‪setType(string ‪$type): void
    {
        $this->type = ‪$type;
    }
 
    public function ‪getParentQuery(): ?‪QueryInterface
    {
        return $this->parentQuery;
    }
 
    public function ‪setParentQuery(?‪QueryInterface $parentQuery): void
    {
        $this->parentQuery = $parentQuery;
    }
 
    public function ‪setQuerySettings(‪QuerySettingsInterface $querySettings)
    {
        $this->querySettings = $querySettings;
    }
 
    public function ‪getQuerySettings()
    {
        if (!$this->querySettings instanceof ‪QuerySettingsInterface) {
            throw new ‪Exception('Tried to get the query settings without setting them before.', 1248689115);
        }
        return $this->querySettings;
    }
 
    public function ‪getType()
    {
        return ‪$this->type;
    }
 
    public function ‪setSource(‪SourceInterface ‪$source)
    {
        $this->source = ‪$source;
    }
 
    protected function ‪getSelectorName()
    {
        ‪$source = $this->‪getSource();
        if (‪$source instanceof ‪SelectorInterface) {
            return ‪$source->getSelectorName();
        }
        return '';
    }
 
    public function ‪getSource()
    {
        if ($this->source === null) {
            $this->source = $this->‪qomFactory->selector($this->‪getType(), $this->‪dataMapFactory->buildDataMap($this->getType())->getTableName());
        }
        return ‪$this->source;
    }
 
    public function ‪execute($returnRawQueryResult = false)
    {
        if ($returnRawQueryResult) {
            return $this->‪persistenceManager->getObjectDataByQuery($this);
        }
        if ($this->‪container->has(QueryResultInterface::class)) {
            $queryResult = $this->‪container->get(QueryResultInterface::class);
            if ($queryResult instanceof ‪ForwardCompatibleQueryResultInterface) {
                $queryResult->setQuery($this);
                return $queryResult;
            }
        }
        // @deprecated since v11, will be removed in v12. Fallback to ObjectManager, drop together with ForwardCompatibleQueryResultInterface.
        $queryResult = GeneralUtility::makeInstance(ObjectManager::class)->get(QueryResultInterface::class, $this);
        return $queryResult;
    }
 
    public function ‪setOrderings(array $orderings)
    {
        $this->‪orderings = $orderings;
        return $this;
    }
 
    public function ‪getOrderings()
    {
        return $this->orderings;
    }
 
    public function ‪setLimit($limit)
    {
        if (!is_int($limit) || $limit < 1) {
            throw new \InvalidArgumentException('The limit must be an integer >= 1', 1245071870);
        }
        $this->limit = $limit;
        return $this;
    }
 
    public function ‪unsetLimit()
    {
        unset($this->limit);
        return $this;
    }
 
    public function ‪getLimit()
    {
        return $this->limit;
    }
 
    public function ‪setOffset($offset)
    {
        if (!is_int($offset) || $offset < 0) {
            throw new \InvalidArgumentException('The offset must be a positive integer', 1245071872);
        }
        $this->offset = $offset;
        return $this;
    }
 
    public function ‪getOffset()
    {
        return $this->offset;
    }
 
    public function ‪matching(‪$constraint)
    {
        $this->constraint = ‪$constraint;
        return $this;
    }
 
    public function ‪statement(‪$statement, array $parameters = [])
    {
        $this->‪statement = $this->‪qomFactory->statement(‪$statement, $parameters);
        return $this;
    }
 
    public function ‪getStatement()
    {
        return ‪$this->statement;
    }
 
    public function ‪getConstraint()
    {
        return ‪$this->constraint;
    }
 
    public function ‪logicalAnd($constraint1, $constraint2 = null, ...$furtherConstraints)
    {
        /*
         * todo: Deprecate accepting an array as $constraint1
         *       Add param type hints for $constraint1 and $constraint2
         *       Make $constraint2 mandatory
         *       Add AndInterface return type hint
         *       Adjust method signature in interface
         */
        $constraints = [];
        if (is_array($constraint1)) {
            $constraints = array_merge($constraints, $constraint1);
        } else {
            $constraints[] = $constraint1;
        }
 
        $constraints[] = $constraint2;
        $constraints = array_merge($constraints, $furtherConstraints);
        $constraints = array_filter($constraints, fn(‪$constraint) => ‪$constraint instanceof ConstraintInterface);
 
        // todo: remove this check as soon as first and second constraint are mandatory
        if (‪count($constraints) < 1) {
            throw new InvalidNumberOfConstraintsException('There must be at least one constraint or a non-empty array of constraints given.', 1268056288);
        }
 
        $resultingConstraint = array_shift($constraints);
        foreach ($constraints as ‪$constraint) {
            $resultingConstraint = $this->‪qomFactory->_and($resultingConstraint, ‪$constraint);
        }
        return $resultingConstraint;
    }
 
    public function ‪logicalOr($constraint1, $constraint2 = null, ...$furtherConstraints)
    {
        /*
         * todo: Deprecate accepting an array as $constraint1
         *       Add param type hints for $constraint1 and $constraint2
         *       Make $constraint2 mandatory
         *       Add AndInterface return type hint
         *       Adjust method signature in interface
         */
        $constraints = [];
        if (is_array($constraint1)) {
            $constraints = array_merge($constraints, $constraint1);
        } else {
            $constraints[] = $constraint1;
        }
 
        $constraints[] = $constraint2;
        $constraints = array_merge($constraints, $furtherConstraints);
        $constraints = array_filter($constraints, fn(‪$constraint) => ‪$constraint instanceof ConstraintInterface);
 
        // todo: remove this check as soon as first and second constraint are mandatory
        if (‪count($constraints) < 1) {
            throw new InvalidNumberOfConstraintsException('There must be at least one constraint or a non-empty array of constraints given.', 1268056289);
        }
 
        $resultingConstraint = array_shift($constraints);
        foreach ($constraints as ‪$constraint) {
            $resultingConstraint = $this->‪qomFactory->_or($resultingConstraint, ‪$constraint);
        }
        return $resultingConstraint;
    }
 
    public function ‪logicalNot(‪ConstraintInterface ‪$constraint)
    {
        return $this->‪qomFactory->not($constraint);
    }
 
    public function ‪equals($propertyName, $operand, $caseSensitive = true)
    {
        if (is_object($operand) || $caseSensitive) {
            $comparison = $this->‪qomFactory->comparison(
                $this->‪qomFactory->propertyValue($propertyName, $this->getSelectorName()),
                ‪QueryInterface::OPERATOR_EQUAL_TO,
                $operand
            );
        } else {
            $comparison = $this->‪qomFactory->comparison(
                $this->‪qomFactory->lowerCase($this->qomFactory->propertyValue($propertyName, $this->getSelectorName())),
                ‪QueryInterface::OPERATOR_EQUAL_TO,
                mb_strtolower($operand, \‪TYPO3\CMS\‪Extbase\Persistence\Generic\‪Query::CHARSET)
            );
        }
        return $comparison;
    }
 
    public function ‪like($propertyName, $operand)
    {
        return $this->‪qomFactory->comparison(
            $this->‪qomFactory->propertyValue($propertyName, $this->getSelectorName()),
            ‪QueryInterface::OPERATOR_LIKE,
            $operand
        );
    }
 
    public function ‪contains($propertyName, $operand)
    {
        return $this->‪qomFactory->comparison($this->‪qomFactory->propertyValue($propertyName, $this->getSelectorName()), ‪QueryInterface::OPERATOR_CONTAINS, $operand);
    }
 
    public function ‪in($propertyName, $operand)
    {
        if (!‪TypeHandlingUtility::isValidTypeForMultiValueComparison($operand)) {
            throw new ‪UnexpectedTypeException('The "in" operator must be given a multivalued operand (array, ArrayAccess, Traversable).', 1264678095);
        }
        return $this->‪qomFactory->comparison($this->‪qomFactory->propertyValue($propertyName, $this->getSelectorName()), ‪QueryInterface::OPERATOR_IN, $operand);
    }
 
    public function ‪lessThan($propertyName, $operand)
    {
        return $this->‪qomFactory->comparison($this->‪qomFactory->propertyValue($propertyName, $this->getSelectorName()), ‪QueryInterface::OPERATOR_LESS_THAN, $operand);
    }
 
    public function ‪lessThanOrEqual($propertyName, $operand)
    {
        return $this->‪qomFactory->comparison($this->‪qomFactory->propertyValue($propertyName, $this->getSelectorName()), ‪QueryInterface::OPERATOR_LESS_THAN_OR_EQUAL_TO, $operand);
    }
 
    public function ‪greaterThan($propertyName, $operand)
    {
        return $this->‪qomFactory->comparison($this->‪qomFactory->propertyValue($propertyName, $this->getSelectorName()), ‪QueryInterface::OPERATOR_GREATER_THAN, $operand);
    }
 
    public function ‪greaterThanOrEqual($propertyName, $operand)
    {
        return $this->‪qomFactory->comparison($this->‪qomFactory->propertyValue($propertyName, $this->getSelectorName()), ‪QueryInterface::OPERATOR_GREATER_THAN_OR_EQUAL_TO, $operand);
    }
 
    public function ‪between($propertyName, $operandLower, $operandUpper)
    {
        return $this->‪logicalAnd(
            $this->‪greaterThanOrEqual($propertyName, $operandLower),
            $this->‪lessThanOrEqual($propertyName, $operandUpper)
        );
    }
 
    public function ‪__wakeup()
    {
        $this->‪persistenceManager = GeneralUtility::makeInstance(PersistenceManagerInterface::class);
        $this->‪dataMapFactory = GeneralUtility::makeInstance(DataMapFactory::class);
        $this->‪qomFactory = GeneralUtility::makeInstance(QueryObjectModelFactory::class);
    }
 
    public function ‪__sleep()
    {
        return ['type', 'source', 'constraint', 'statement', 'orderings', 'limit', 'offset', 'querySettings'];
    }
 
    public function ‪count()
    {
        return $this->‪execute()->count();
    }
}