9.5/_frontend_workspace_restriction_8php_source.html

<?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\Context\Context;

use ‪TYPO3\CMS\Core\Database\Query\Expression\CompositeExpression;

use ‪TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Core\Versioning\VersionState;


class ‪FrontendWorkspaceRestriction implements ‪QueryRestrictionInterface

{

    protected ‪$workspaceId;


    protected ‪$includeRowsForWorkspacePreview;


    protected ‪$enforceLiveRowsOnly;


    public function ‪__construct(int ‪$workspaceId = null, bool ‪$includeRowsForWorkspacePreview = null, bool ‪$enforceLiveRowsOnly = true)

    {

        $globalWorkspaceId = GeneralUtility::makeInstance(Context::class)->getPropertyFromAspect('workspace', 'id');

        $this->workspaceId = ‪$workspaceId ?? $globalWorkspaceId;

        $this->includeRowsForWorkspacePreview = ‪$includeRowsForWorkspacePreview ?? $globalWorkspaceId > 0;

        $this->enforceLiveRowsOnly = ‪$enforceLiveRowsOnly;

    }


    public function ‪buildExpression(array $queriedTables, ‪ExpressionBuilder $expressionBuilder): ‪CompositeExpression

    {

        $constraints = [];

        foreach ($queriedTables as $tableAlias => $tableName) {

            $workspaceEnabled = ‪$GLOBALS['TCA'][$tableName]['ctrl']['versioningWS'] ?? null;

            if (!empty($workspaceEnabled)) {

                if (!$this->includeRowsForWorkspacePreview) {

                    // Filter out placeholder records (new/moved/deleted items)

                    // in case we are NOT in a versioning preview (That means we are online!)

                    $constraints[] = $expressionBuilder->‪lte(

                        $tableAlias . '.t3ver_state',

                        // Trigger __toString(), then cast int

                        (int)(string)new ‪VersionState(‪VersionState::DEFAULT_STATE)

                    );

                } elseif ($tableName !== 'pages') {

                    // Show only records of the live and current workspace in case we are in a versioning preview

                    $constraints[] = $expressionBuilder->‪orX(

                        $expressionBuilder->‪eq($tableAlias . '.t3ver_wsid', 0),

                        $expressionBuilder->‪eq($tableAlias . '.t3ver_wsid', (int)$this->workspaceId)

                    );

                }

                // Filter out versioned records

                if ($this->enforceLiveRowsOnly) {

                    $constraints[] = $expressionBuilder->‪neq($tableAlias . '.pid', -1);

                }

            }

        }

        return $expressionBuilder->‪andX(...$constraints);

    }

}