FrontendRestrictionContainer.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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\Core\Database\Query\Restriction;
 
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Database\Query\Expression\CompositeExpression;
use ‪TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FrontendRestrictionContainer extends ‪AbstractRestrictionContainer
{
    protected array ‪$defaultRestrictionTypes = [
        DeletedRestriction::class,
        WorkspaceRestriction::class,
        HiddenRestriction::class,
        StartTimeRestriction::class,
        EndTimeRestriction::class,
        FrontendGroupRestriction::class,
    ];
 
    protected ‪$context;
 
    public function ‪__construct(‪Context ‪$context = null)
    {
        $this->context = ‪$context ?? GeneralUtility::makeInstance(Context::class);
        foreach ($this->defaultRestrictionTypes as $restrictionType) {
            $this->‪add($this->‪createRestriction($restrictionType));
        }
    }
 
    public function ‪buildExpression(array $queriedTables, ‪ExpressionBuilder $expressionBuilder): ‪CompositeExpression
    {
        $constraints = [];
        foreach ($this->restrictions as $restriction) {
            foreach ($queriedTables as $tableAlias => $tableName) {
                $disableRestriction = false;
                if ($restriction instanceof ‪HiddenRestriction || $restriction instanceof ‪StartTimeRestriction || $restriction instanceof ‪EndTimeRestriction) {
                    $visibilityAspect = $this->context->getAspect('visibility');
                    if ($restriction instanceof ‪HiddenRestriction) {
                        // If display of hidden records is requested, we must disable the hidden restriction.
                        if ($tableName === 'pages') {
                            $disableRestriction = $visibilityAspect->includeHiddenPages();
                        } else {
                            $disableRestriction = $visibilityAspect->includeHiddenContent();
                        }
                    }
                    if ($restriction instanceof StartTimeRestriction || $restriction instanceof EndTimeRestriction) {
                        $disableRestriction = $visibilityAspect->includeScheduledRecords();
                    }
                }
                if (!$disableRestriction) {
                    $constraints[] = $restriction->buildExpression([$tableAlias => $tableName], $expressionBuilder);
                }
            }
        }
        return $expressionBuilder->‪and(...$constraints);
    }
 
    protected function ‪createRestriction($restrictionClass): ‪QueryRestrictionInterface
    {
        if ($restrictionClass === WorkspaceRestriction::class) {
            return GeneralUtility::makeInstance($restrictionClass, (int)$this->context->getPropertyFromAspect('workspace', 'id', 0));
        }
        if ($restrictionClass === FrontendGroupRestriction::class) {
            return GeneralUtility::makeInstance($restrictionClass, $this->context->getPropertyFromAspect('frontend.user', 'groupIds', []));
        }
 
        return parent::createRestriction($restrictionClass);
    }
}