QuerySettingsInterface
A query settings interface. This interface is NOT part of the TYPO3.Flow API.
Table of Contents
Methods
- getEnableFieldsToBeIgnored() : array<string|int, string>
- 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.
- getIgnoreEnableFields() : bool
- The returned value indicates whether all or some enable fields should be ignored.
- getIncludeDeleted() : bool
- Returns if the query should return objects that are deleted.
- getLanguageAspect() : LanguageAspect
- getRespectStoragePage() : bool
- Returns the state, if the storage page should be respected for the query.
- getRespectSysLanguage() : bool
- Returns the state, if record language should be checked when querying
- getStoragePageIds() : array<string|int, int>
- Returns the pid(s) of the storage page(s) that should be respected for the query.
- setEnableFieldsToBeIgnored() : $this
- 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.
- setIgnoreEnableFields() : $this
- Sets a flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
- setIncludeDeleted() : $this
- Sets the flag if the query should return objects that are deleted.
- setLanguageAspect() : $this
- Overrides the main language aspect, defined in the main Context API
- setRespectStoragePage() : $this
- Sets the flag if the storage page should be respected for the query.
- setRespectSysLanguage() : $this
- Sets the flag if record language should be respected when querying.
- setStoragePageIds() : $this
- Sets the pid(s) of the storage page(s) that should be respected for the query.
Methods
getEnableFieldsToBeIgnored()
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.
public
getEnableFieldsToBeIgnored() : array<string|int, string>
Tags
Return values
array<string|int, string>getIgnoreEnableFields()
The returned value indicates whether all or some enable fields should be ignored.
public
getIgnoreEnableFields() : bool
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.
Tags
Return values
boolgetIncludeDeleted()
Returns if the query should return objects that are deleted.
public
getIncludeDeleted() : bool
Return values
boolgetLanguageAspect()
public
getLanguageAspect() : LanguageAspect
Return values
LanguageAspectgetRespectStoragePage()
Returns the state, if the storage page should be respected for the query.
public
getRespectStoragePage() : bool
Return values
bool —TRUE, if the storage page should be respected; otherwise FALSE.
getRespectSysLanguage()
Returns the state, if record language should be checked when querying
public
getRespectSysLanguage() : bool
Return values
bool —if TRUE record language is checked.
getStoragePageIds()
Returns the pid(s) of the storage page(s) that should be respected for the query.
public
getStoragePageIds() : array<string|int, int>
Return values
array<string|int, int> —list of integers that each represent a storage page id
setEnableFieldsToBeIgnored()
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.
public
setEnableFieldsToBeIgnored(array<string|int, string> $enableFieldsToBeIgnored) : $this
Parameters
- $enableFieldsToBeIgnored : array<string|int, string>
Tags
Return values
$this —fluent interface
setIgnoreEnableFields()
Sets a flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
public
setIgnoreEnableFields(bool $ignoreEnableFields) : $this
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.
Parameters
- $ignoreEnableFields : bool
Tags
Return values
$this —fluent interface
setIncludeDeleted()
Sets the flag if the query should return objects that are deleted.
public
setIncludeDeleted(bool $includeDeleted) : $this
Parameters
- $includeDeleted : bool
Return values
$this —fluent interface
setLanguageAspect()
Overrides the main language aspect, defined in the main Context API
public
setLanguageAspect(LanguageAspect $languageAspect) : $this
Parameters
- $languageAspect : LanguageAspect
Return values
$this —fluent interface
setRespectStoragePage()
Sets the flag if the storage page should be respected for the query.
public
setRespectStoragePage(bool $respectStoragePage) : $this
Parameters
- $respectStoragePage : bool
-
If TRUE the storage page ID will be determined and the statement will be extended accordingly.
Return values
$this —fluent interface
setRespectSysLanguage()
Sets the flag if record language should be respected when querying.
public
setRespectSysLanguage(bool $respectSysLanguage) : $this
Other settings defines whether overlay should happen or not.
Parameters
- $respectSysLanguage : bool
-
TRUE if only record language should be respected when querying
Return values
$this —fluent interface
setStoragePageIds()
Sets the pid(s) of the storage page(s) that should be respected for the query.
public
setStoragePageIds(array<string|int, int> $storagePageIds) : $this
Parameters
- $storagePageIds : array<string|int, int>
-
If TRUE the storage page ID will be determined and the statement will be extended accordingly.
Return values
$this —fluent interface