Typo3QuerySettings implements QuerySettingsInterface
Query settings, reflects the settings unique to TYPO3 CMS.
Table of Contents
Interfaces
- QuerySettingsInterface
- A query settings interface. This interface is NOT part of the TYPO3.Flow API.
Properties
- $configurationManager : ConfigurationManagerInterface
- $context : Context
- $enableFieldsToBeIgnored : array<string|int, mixed>
- 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
- $ignoreEnableFields : bool
- A flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
- $includeDeleted : bool
- Flag whether deleted records should be included in the result set.
- $languageAspect : LanguageAspect
- $respectStoragePage : bool
- Flag if the storage page should be respected for the query.
- $respectSysLanguage : bool
- Flag if the sys_language_uid should be respected (default is TRUE).
- $storagePageIds : array<string|int, mixed>
- the pid(s) of the storage page(s) that should be respected for the query.
Methods
- __construct() : mixed
- getEnableFieldsToBeIgnored() : array<string|int, mixed>
- 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
- Returns the language aspect
- getLanguageOverlayMode() : mixed
- getLanguageUid() : int
- 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, mixed>
- Returns the pid(s) of the storage page(s) that should be respected for the query.
- setEnableFieldsToBeIgnored() : QuerySettingsInterface
- 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() : QuerySettingsInterface
- Sets a flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
- setIncludeDeleted() : QuerySettingsInterface
- 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
- setLanguageOverlayMode() : QuerySettingsInterface
- setLanguageUid() : QuerySettingsInterface
- setRespectStoragePage() : QuerySettingsInterface
- Sets the flag if the storage page should be respected for the query.
- setRespectSysLanguage() : QuerySettingsInterface
- Sets the flag if record language should be respected when querying.
- setStoragePageIds() : QuerySettingsInterface
- Sets the pid(s) of the storage page(s) that should be respected for the query.
Properties
$configurationManager
protected
ConfigurationManagerInterface
$configurationManager
$context
protected
Context
$context
$enableFieldsToBeIgnored
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
protected
array<string|int, mixed>
$enableFieldsToBeIgnored
= []
$ignoreEnableFields
A flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
protected
bool
$ignoreEnableFields
= false
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.
$includeDeleted
Flag whether deleted records should be included in the result set.
protected
bool
$includeDeleted
= false
$languageAspect
protected
LanguageAspect
$languageAspect
$respectStoragePage
Flag if the storage page should be respected for the query.
protected
bool
$respectStoragePage
= true
$respectSysLanguage
Flag if the sys_language_uid should be respected (default is TRUE).
protected
bool
$respectSysLanguage
= true
$storagePageIds
the pid(s) of the storage page(s) that should be respected for the query.
protected
array<string|int, mixed>
$storagePageIds
= []
Methods
__construct()
public
__construct(Context $context, ConfigurationManagerInterface $configurationManager) : mixed
Parameters
- $context : Context
- $configurationManager : ConfigurationManagerInterface
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, mixed>
Tags
Return values
array<string|int, mixed>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()
Returns the language aspect
public
getLanguageAspect() : LanguageAspect
Return values
LanguageAspectgetLanguageOverlayMode()
public
getLanguageOverlayMode() : mixed
will be removed in TYPO3 13.0. Use ->getLanguageAspect()
Tags
Return values
mixed —TRUE, FALSE or "hideNonTranslated"
getLanguageUid()
public
getLanguageUid() : int
will be removed in TYPO3 13.0. Use ->getLanguageAspect()
Tags
Return values
intgetRespectStoragePage()
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 —TRUE if TYPO3 language settings are to be applied
getStoragePageIds()
Returns the pid(s) of the storage page(s) that should be respected for the query.
public
getStoragePageIds() : array<string|int, mixed>
Return values
array<string|int, mixed> —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, mixed> $enableFieldsToBeIgnored) : QuerySettingsInterface
Parameters
- $enableFieldsToBeIgnored : array<string|int, mixed>
Tags
Return values
QuerySettingsInterfacesetIgnoreEnableFields()
Sets a flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
public
setIgnoreEnableFields(bool $ignoreEnableFields) : QuerySettingsInterface
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
QuerySettingsInterfacesetIncludeDeleted()
Sets the flag if the query should return objects that are deleted.
public
setIncludeDeleted(bool $includeDeleted) : QuerySettingsInterface
Parameters
- $includeDeleted : bool
Return values
QuerySettingsInterfacesetLanguageAspect()
Overrides the main language aspect, defined in the main Context API
public
setLanguageAspect(LanguageAspect $languageAspect) : $this
Parameters
- $languageAspect : LanguageAspect
Return values
$this —to allow method chaining
setLanguageOverlayMode()
public
setLanguageOverlayMode([mixed $languageOverlayMode = false ]) : QuerySettingsInterface
will be removed in TYPO3 13.0. Use ->setLanguageAspect()
Parameters
- $languageOverlayMode : mixed = false
-
TRUE, FALSE or "hideNonTranslated"
Tags
Return values
QuerySettingsInterface —instance of $this to allow method chaining
setLanguageUid()
public
setLanguageUid(int $languageUid) : QuerySettingsInterface
will be removed in TYPO3 13.0. Use ->setLanguageAspect()
Parameters
- $languageUid : int
Tags
Return values
QuerySettingsInterface —instance of $this to allow method chaining
setRespectStoragePage()
Sets the flag if the storage page should be respected for the query.
public
setRespectStoragePage(bool $respectStoragePage) : QuerySettingsInterface
Parameters
- $respectStoragePage : bool
-
If TRUE the storage page ID will be determined and the statement will be extended accordingly.
Return values
QuerySettingsInterfacesetRespectSysLanguage()
Sets the flag if record language should be respected when querying.
public
setRespectSysLanguage(bool $respectSysLanguage) : QuerySettingsInterface
Parameters
- $respectSysLanguage : bool
-
TRUE if TYPO3 language settings are to be applied
Return values
QuerySettingsInterfacesetStoragePageIds()
Sets the pid(s) of the storage page(s) that should be respected for the query.
public
setStoragePageIds(array<string|int, mixed> $storagePageIds) : QuerySettingsInterface
Parameters
- $storagePageIds : array<string|int, mixed>
-
If given the storage page IDs will be determined and the statement will be extended accordingly.