AbstractRestrictionContainer.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Core\Database\Query\Restriction;

/*
 * 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\Core\Database\Query\Expression\CompositeExpression;
use TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;
use TYPO3\CMS\Core\Utility\GeneralUtility;

abstract class AbstractRestrictionContainer implements QueryRestrictionContainerInterface
{
    protected $restrictions = [];

    protected $enforcedRestrictions = [];

    public function buildExpression(array $queriedTables, ExpressionBuilder $expressionBuilder): CompositeExpression
    {
        $constraints = [];
        foreach ($this->restrictions as $restriction) {
            $constraints[] = $restriction->buildExpression($queriedTables, $expressionBuilder);
        }
        return $expressionBuilder->andX(...$constraints);
    }

    public function removeAll()
    {
        $this->restrictions = $this->enforcedRestrictions;
        return $this;
    }

    public function removeByType(string $restrictionType)
    {
        unset($this->restrictions[$restrictionType], $this->enforcedRestrictions[$restrictionType]);
        return $this;
    }

    public function add(QueryRestrictionInterface $restriction)
    {
        $this->restrictions[get_class($restriction)] = $restriction;
        if ($restriction instanceof EnforceableQueryRestrictionInterface && $restriction->isEnforced()) {
            $this->enforcedRestrictions[get_class($restriction)] = $restriction;
        }
        return $this;
    }

    protected function createRestriction($restrictionClass)
    {
        return GeneralUtility::makeInstance($restrictionClass);
    }
}