9e4a192e01267600498655c89ff54f9a7acf9320
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Database / Query / Restriction / DeletedRestriction.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 respect the soft-delete functionality of TYPO3.
23 * Filters out records, that were marked as deleted.
24 */
25 class DeletedRestriction implements QueryRestrictionInterface
26 {
27 /**
28 * Main method to build expressions for given tables
29 * Evaluates the ctrl/delete flag of the table and adds the according restriction if set
30 *
31 * @param array $queriedTables Array of tables, where array key is table name and value potentially an alias
32 * @param ExpressionBuilder $expressionBuilder Expression builder instance to add restrictions with
33 * @return CompositeExpression The result of query builder expression(s)
34 */
35 public function buildExpression(array $queriedTables, ExpressionBuilder $expressionBuilder): CompositeExpression
36 {
37 $constraints = [];
38 foreach ($queriedTables as $tableName => $tableAlias) {
39 $deletedFieldName = $GLOBALS['TCA'][$tableName]['ctrl']['delete'] ?? null;
40 if (!empty($deletedFieldName)) {
41 $tablePrefix = $tableAlias ?: $tableName;
42 $constraints[] = $expressionBuilder->eq(
43 $tablePrefix . '.' . $deletedFieldName,
44 0
45 );
46 }
47 }
48 return $expressionBuilder->andX(...$constraints);
49 }
50 }