227262aaff6768434a0e20aea63c280a266fe02e
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Database / Query / Restriction / HiddenRestriction.php
1 <?php
2 declare (strict_types = 1);
3 namespace TYPO3\CMS\Core\Database\Query\Restriction;
4
5 /*
6 * This file is part of the TYPO3 CMS project.
7 *
8 * It is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, either version 2
10 * of the License, or any later version.
11 *
12 * For the full copyright and license information, please read the
13 * LICENSE.txt file that was distributed with this source code.
14 *
15 * The TYPO3 project - inspiring people to share!
16 */
17
18 use TYPO3\CMS\Core\Database\Query\Expression\CompositeExpression;
19 use TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;
20
21 /**
22 * Restriction to filter records that have been marked as hidden
23 */
24 class HiddenRestriction implements QueryRestrictionInterface
25 {
26 /**
27 * Main method to build expressions for given tables
28 * Evaluates the ctrl/enablecolumns/disabled flag of the table and adds the according restriction if set
29 *
30 * @param array $queriedTables Array of tables, where array key is table name and value potentially an alias
31 * @param ExpressionBuilder $expressionBuilder Expression builder instance to add restrictions with
32 * @return CompositeExpression The result of query builder expression(s)
33 */
34 public function buildExpression(array $queriedTables, ExpressionBuilder $expressionBuilder): CompositeExpression
35 {
36 $constraints = [];
37 foreach ($queriedTables as $tableName => $tableAlias) {
38 $hiddenFieldName = $GLOBALS['TCA'][$tableName]['ctrl']['enablecolumns']['disabled'] ?? null;
39 if (!empty($hiddenFieldName)) {
40 $tablePrefix = $tableAlias ?: $tableName;
41 $constraints[] = $expressionBuilder->eq(
42 $tablePrefix . '.' . $hiddenFieldName,
43 0
44 );
45 }
46 }
47 return $expressionBuilder->andX(...$constraints);
48 }
49 }