TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:15 +02:00
commit 6830982e7d
295 changed files with 31995 additions and 0 deletions
@@ -0,0 +1,134 @@
+<?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\Extbase\Persistence\Generic;
+
+use TYPO3\CMS\Core\Context\LanguageAspect;
+
+/**
+ * A query settings interface. This interface is NOT part of the TYPO3.Flow API.
+ */
+interface QuerySettingsInterface
+{
+    /**
+     * Sets the flag if the storage page should be respected for the query.
+     *
+     * @param bool $respectStoragePage If TRUE the storage page ID will be determined and the statement will be extended accordingly.
+     * @return $this fluent interface
+     */
+    public function setRespectStoragePage(bool $respectStoragePage): self;
+
+    /**
+     * Returns the state, if the storage page should be respected for the query.
+     *
+     * @return bool TRUE, if the storage page should be respected; otherwise FALSE.
+     */
+    public function getRespectStoragePage(): bool;
+
+    /**
+     * Sets the pid(s) of the storage page(s) that should be respected for the query.
+     *
+     * @param int[] $storagePageIds If TRUE the storage page ID will be determined and the statement will be extended accordingly.
+     * @return $this fluent interface
+     */
+    public function setStoragePageIds(array $storagePageIds): self;
+
+    /**
+     * Returns the pid(s) of the storage page(s) that should be respected for the query.
+     *
+     * @return int[] list of integers that each represent a storage page id
+     */
+    public function getStoragePageIds(): array;
+
+    /**
+     * Sets the flag if record language should be respected when querying.
+     * Other settings defines whether overlay should happen or not.
+     *
+     * @param bool $respectSysLanguage TRUE if only record language should be respected when querying
+     * @return $this fluent interface
+     */
+    public function setRespectSysLanguage(bool $respectSysLanguage): self;
+
+    /**
+     * Returns the state, if record language should be checked when querying
+     *
+     * @return bool if TRUE record language is checked.
+     */
+    public function getRespectSysLanguage(): bool;
+
+    /**
+     * Sets a flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
+     * If--in addition to this--enableFieldsToBeIgnored is set, only fields specified there are ignored. If FALSE, all
+     * enable fields are taken into account, regardless of the enableFieldsToBeIgnored setting.
+     *
+     * @param bool $ignoreEnableFields
+     * @return $this fluent interface
+     * @see setEnableFieldsToBeIgnored()
+     */
+    public function setIgnoreEnableFields(bool $ignoreEnableFields): self;
+
+    /**
+     * The returned value indicates whether all or some enable fields should be ignored.
+     *
+     * If TRUE, all enable fields are ignored. If--in addition to this--enableFieldsToBeIgnored is set, only fields specified there are ignored.
+     * If FALSE, all enable fields are taken into account, regardless of the enableFieldsToBeIgnored setting.
+     *
+     * @see getEnableFieldsToBeIgnored()
+     */
+    public function getIgnoreEnableFields(): bool;
+
+    /**
+     * An array of column names in the enable columns array (array keys in $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']),
+     * to be ignored while building the query statement. Adding a column name here effectively switches off filtering
+     * by this column. This setting is only taken into account if $this->ignoreEnableFields = TRUE.
+     *
+     * @param string[] $enableFieldsToBeIgnored
+     * @return $this fluent interface
+     * @see setIgnoreEnableFields()
+     */
+    public function setEnableFieldsToBeIgnored(array $enableFieldsToBeIgnored): self;
+
+    /**
+     * An array of column names in the enable columns array (array keys in $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']),
+     * to be ignored while building the query statement.
+     *
+     * @return string[]
+     * @see getIgnoreEnableFields()
+     */
+    public function getEnableFieldsToBeIgnored(): array;
+
+    /**
+     * Sets the flag if the query should return objects that are deleted.
+     *
+     * @param bool $includeDeleted
+     * @return $this fluent interface
+     */
+    public function setIncludeDeleted(bool $includeDeleted): self;
+
+    /**
+     * Returns if the query should return objects that are deleted.
+     */
+    public function getIncludeDeleted(): bool;
+
+    public function getLanguageAspect(): LanguageAspect;
+
+    /**
+     * Overrides the main language aspect, defined in the main Context API
+     * @return $this fluent interface
+     */
+    public function setLanguageAspect(LanguageAspect $languageAspect): self;
+}