[TASK] Correct QuerySettingsInterface RespectSysLanguage comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / QuerySettingsInterface.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Persistence\Generic;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * A query settings interface. This interface is NOT part of the TYPO3.Flow API.
19 */
20 interface QuerySettingsInterface
21 {
22 /**
23 * Sets the flag if the storage page should be respected for the query.
24 *
25 * @param bool $respectStoragePage If TRUE the storage page ID will be determined and the statement will be extended accordingly.
26 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
27 * @api
28 */
29 public function setRespectStoragePage($respectStoragePage);
30
31 /**
32 * Returns the state, if the storage page should be respected for the query.
33 *
34 * @return bool TRUE, if the storage page should be respected; otherwise FALSE.
35 */
36 public function getRespectStoragePage();
37
38 /**
39 * Sets the pid(s) of the storage page(s) that should be respected for the query.
40 *
41 * @param array $storagePageIds If TRUE the storage page ID will be determined and the statement will be extended accordingly.
42 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
43 * @api
44 */
45 public function setStoragePageIds(array $storagePageIds);
46
47 /**
48 * Returns the pid(s) of the storage page(s) that should be respected for the query.
49 *
50 * @return array list of integers that each represent a storage page id
51 */
52 public function getStoragePageIds();
53
54 /**
55 * Sets the flag if record language should be respected when querying.
56 * Other settings defines whether overlay should happen or not.
57 *
58 * @param bool $respectSysLanguage TRUE if only record language should be respected when querying
59 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
60 * @api
61 */
62 public function setRespectSysLanguage($respectSysLanguage);
63
64 /**
65 * Returns the state, if record language should be checked when querying
66 *
67 * @return bool if TRUE record language is checked.
68 */
69 public function getRespectSysLanguage();
70
71 /**
72 * @param mixed $languageOverlayMode TRUE, FALSE or "hideNonTranslated"
73 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
74 * @api
75 */
76 public function setLanguageOverlayMode($languageOverlayMode);
77
78 /**
79 * @return mixed TRUE, FALSE or "hideNonTranslated"
80 */
81 public function getLanguageOverlayMode();
82
83 /**
84 * @param string $languageMode NULL, "content_fallback", "strict" or "ignore"
85 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
86 * @api
87 */
88 public function setLanguageMode($languageMode);
89
90 /**
91 * @return string NULL, "content_fallback", "strict" or "ignore"
92 */
93 public function getLanguageMode();
94
95 /**
96 * @param int $languageUid
97 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
98 * @api
99 */
100 public function setLanguageUid($languageUid);
101
102 /**
103 * @return int
104 */
105 public function getLanguageUid();
106
107 /**
108 * Sets a flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
109 * If--in addition to this--enableFieldsToBeIgnored is set, only fields specified there are ignored. If FALSE, all
110 * enable fields are taken into account, regardless of the enableFieldsToBeIgnored setting.
111 *
112 * @param bool $ignoreEnableFields
113 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
114 * @see setEnableFieldsToBeIgnored()
115 * @api
116 */
117 public function setIgnoreEnableFields($ignoreEnableFields);
118
119 /**
120 * The returned value indicates whether all or some enable fields should be ignored.
121 *
122 * If TRUE, all enable fields are ignored. If--in addition to this--enableFieldsToBeIgnored is set, only fields specified there are ignored.
123 * If FALSE, all enable fields are taken into account, regardless of the enableFieldsToBeIgnored setting.
124 *
125 * @return bool
126 * @see getEnableFieldsToBeIgnored()
127 */
128 public function getIgnoreEnableFields();
129
130 /**
131 * An array of column names in the enable columns array (array keys in $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']),
132 * to be ignored while building the query statement. Adding a column name here effectively switches off filtering
133 * by this column. This setting is only taken into account if $this->ignoreEnableFields = TRUE.
134 *
135 * @param array $enableFieldsToBeIgnored
136 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
137 * @see setIgnoreEnableFields()
138 * @api
139 */
140 public function setEnableFieldsToBeIgnored($enableFieldsToBeIgnored);
141
142 /**
143 * An array of column names in the enable columns array (array keys in $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']),
144 * to be ignored while building the query statement.
145 *
146 * @return array
147 * @see getIgnoreEnableFields()
148 */
149 public function getEnableFieldsToBeIgnored();
150
151 /**
152 * Sets the flag if the query should return objects that are deleted.
153 *
154 * @param bool $includeDeleted
155 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
156 * @api
157 */
158 public function setIncludeDeleted($includeDeleted);
159
160 /**
161 * Returns if the query should return objects that are deleted.
162 *
163 * @return bool
164 */
165 public function getIncludeDeleted();
166 }