9.5/_classes_2_persistence_2_generic_2_query_8php_source.html

<?php

namespace ‪TYPO3\CMS\Extbase\Persistence\Generic;


/*

 * 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!

 */


use ‪TYPO3\CMS\Extbase\Persistence\QueryInterface;


class ‪Query implements ‪QueryInterface

{

    const ‪JCR_JOIN_TYPE_INNER = '{http://www.jcp.org/jcr/1.0}joinTypeInner';


    const ‪JCR_JOIN_TYPE_LEFT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeLeftOuter';


    const ‪JCR_JOIN_TYPE_RIGHT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeRightOuter';


    const ‪CHARSET = 'utf-8';


    protected ‪$type;


    protected ‪$objectManager;


    protected ‪$dataMapFactory;


    protected ‪$persistenceManager;


    protected ‪$qomFactory;


    protected ‪$source;


    protected ‪$constraint;


    protected ‪$statement;


    protected ‪$orderings = [];


    protected ‪$limit;


    protected ‪$offset;


    protected ‪$querySettings;


    protected ‪$parentQuery;


    public function ‪injectObjectManager(\‪TYPO3\CMS\‪Extbase\Object\‪ObjectManagerInterface ‪$objectManager)

    {

        $this->objectManager = ‪$objectManager;

    }


    public function ‪injectDataMapFactory(\‪TYPO3\CMS\‪Extbase\Persistence\Generic\Mapper\DataMapFactory ‪$dataMapFactory)

    {

        $this->dataMapFactory = ‪$dataMapFactory;

    }


    public function ‪injectPersistenceManager(\‪TYPO3\CMS\‪Extbase\Persistence\‪PersistenceManagerInterface ‪$persistenceManager)

    {

        $this->persistenceManager = ‪$persistenceManager;

    }


    public function ‪injectQomFactory(\‪TYPO3\CMS\‪Extbase\Persistence\Generic\Qom\QueryObjectModelFactory ‪$qomFactory)

    {

        $this->qomFactory = ‪$qomFactory;

    }


    public function ‪__construct(‪$type)

    {

        $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 \TYPO3\CMS\Extbase\Persistence\Generic\Exception('Tried to get the query settings without seting them before.', 1248689115);

        }

        return ‪$this->querySettings;

    }


    public function ‪getType()

    {

        return ‪$this->type;

    }


    public function ‪setSource(\‪TYPO3\CMS\‪Extbase\Persistence\Generic\Qom\SourceInterface ‪$source)

    {

        $this->source = ‪$source;

    }


    protected function ‪getSelectorName()

    {

        ‪$source = $this->‪getSource();

        if (‪$source instanceof \‪TYPO3\CMS\‪Extbase\Persistence\Generic\Qom\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);

        }

        return $this->objectManager->get(\‪TYPO3\CMS\‪Extbase\Persistence\QueryResultInterface::class, $this);

    }


    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)

    {

        if (is_array($constraint1)) {

            $resultingConstraint = array_shift($constraint1);

            $constraints = $constraint1;

        } else {

            $constraints = func_get_args();

            $resultingConstraint = array_shift($constraints);

        }

        if ($resultingConstraint === null) {

            throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception\InvalidNumberOfConstraintsException('There must be at least one constraint or a non-empty array of constraints given.', 1268056288);

        }

        foreach ($constraints as ‪$constraint) {

            $resultingConstraint = $this->qomFactory->_and($resultingConstraint, ‪$constraint);

        }

        return $resultingConstraint;

    }


    public function ‪logicalOr($constraint1)

    {

        if (is_array($constraint1)) {

            $resultingConstraint = array_shift($constraint1);

            $constraints = $constraint1;

        } else {

            $constraints = func_get_args();

            $resultingConstraint = array_shift($constraints);

        }

        if ($resultingConstraint === null) {

            throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception\InvalidNumberOfConstraintsException('There must be at least one constraint or a non-empty array of constraints given.', 1268056289);

        }

        foreach ($constraints as ‪$constraint) {

            $resultingConstraint = $this->qomFactory->_or($resultingConstraint, ‪$constraint);

        }

        return $resultingConstraint;

    }


    public function ‪logicalNot(\‪TYPO3\CMS\‪Extbase\Persistence\Generic\Qom\‪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 (!\‪TYPO3\CMS\‪Extbase\Utility\TypeHandlingUtility::isValidTypeForMultiValueComparison($operand)) {

            throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception\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->objectManager = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\‪TYPO3\CMS\‪Extbase\Object\ObjectManager::class);

        $this->persistenceManager = $this->objectManager->get(\‪TYPO3\CMS\‪Extbase\Persistence\PersistenceManagerInterface::class);

        $this->dataMapFactory = $this->objectManager->get(\‪TYPO3\CMS\‪Extbase\Persistence\Generic\Mapper\DataMapFactory::class);

        $this->qomFactory = $this->objectManager->get(\‪TYPO3\CMS\‪Extbase\Persistence\Generic\Qom\QueryObjectModelFactory::class);

    }


    public function ‪__sleep()

    {

        return ['type', 'source', 'constraint', 'statement', 'orderings', 'limit', 'offset', 'querySettings'];

    }


    public function ‪count()

    {

        return $this->‪execute()->count();

    }


    public function ‪isEmpty($propertyName)

    {

        throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException(__METHOD__, 1476122265);

    }

}