‪TYPO3CMS  9.5
Public Member Functions | List of all members
TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface:
TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings

Public Member Functions

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setRespectStoragePage ($respectStoragePage)
 
bool getRespectStoragePage ()
 
TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setStoragePageIds (array $storagePageIds)
 
array getStoragePageIds ()
 
TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setRespectSysLanguage ($respectSysLanguage)
 
bool getRespectSysLanguage ()
 
TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setLanguageOverlayMode ($languageOverlayMode)
 
mixed getLanguageOverlayMode ()
 
TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setLanguageMode ($languageMode)
 
string getLanguageMode ()
 
TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setLanguageUid ($languageUid)
 
int getLanguageUid ()
 
TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setIgnoreEnableFields ($ignoreEnableFields)
 
bool getIgnoreEnableFields ()
 
TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setEnableFieldsToBeIgnored ($enableFieldsToBeIgnored)
 
array getEnableFieldsToBeIgnored ()
 
TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface setIncludeDeleted ($includeDeleted)
 
bool getIncludeDeleted ()
 

Detailed Description

A query settings interface. This interface is NOT part of the TYPO3.Flow API.

Definition at line 20 of file QuerySettingsInterface.php.

Member Function Documentation

◆ getEnableFieldsToBeIgnored()

array TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::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.

Returns
‪array
See also
‪getIgnoreEnableFields()

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getVisibilityConstraintStatement().

◆ getIgnoreEnableFields()

bool TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getIgnoreEnableFields ( )

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.

Returns
‪bool
See also
‪getEnableFieldsToBeIgnored()

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getVisibilityConstraintStatement().

◆ getIncludeDeleted()

bool TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getIncludeDeleted ( )

Returns if the query should return objects that are deleted.

Returns
‪bool

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getVisibilityConstraintStatement().

◆ getLanguageMode()

string TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getLanguageMode ( )

Language Mode is NOT used when consistentTranslationOverlayHandling is enabled

Returns
‪string NULL, "content_fallback", "strict" or "ignore"

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\doLanguageAndWorkspaceOverlay().

◆ getLanguageOverlayMode()

mixed TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getLanguageOverlayMode ( )
Returns
‪mixed TRUE, FALSE or "hideNonTranslated"

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getLanguageStatement().

◆ getLanguageUid()

int TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getLanguageUid ( )
Returns
‪int

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\doLanguageAndWorkspaceOverlay(), and TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getLanguageStatement().

◆ getRespectStoragePage()

bool TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getRespectStoragePage ( )

Returns the state, if the storage page should be respected for the query.

Returns
‪bool TRUE, if the storage page should be respected; otherwise FALSE.

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getAdditionalWhereClause().

◆ getRespectSysLanguage()

bool TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getRespectSysLanguage ( )

Returns the state, if record language should be checked when querying

Returns
‪bool if TRUE record language is checked.

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getAdditionalWhereClause().

◆ getStoragePageIds()

array TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getStoragePageIds ( )

Returns the pid(s) of the storage page(s) that should be respected for the query.

Returns
‪array list of integers that each represent a storage page id

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getAdditionalWhereClause().

◆ setEnableFieldsToBeIgnored()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setEnableFieldsToBeIgnored (   $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. Adding a column name here effectively switches off filtering by this column. This setting is only taken into account if $this->ignoreEnableFields = TRUE.

Parameters
array$enableFieldsToBeIgnored
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
See also
‪setIgnoreEnableFields()

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

◆ setIgnoreEnableFields()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setIgnoreEnableFields (   $ignoreEnableFields)

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.

Parameters
bool$ignoreEnableFields
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
See also
‪setEnableFieldsToBeIgnored()

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

◆ setIncludeDeleted()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setIncludeDeleted (   $includeDeleted)

Sets the flag if the query should return objects that are deleted.

Parameters
bool$includeDeleted
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

◆ setLanguageMode()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setLanguageMode (   $languageMode)

Language Mode is NOT used when consistentTranslationOverlayHandling is enabled

Parameters
string$languageMode‪NULL, "content_fallback", "strict" or "ignore"
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

◆ setLanguageOverlayMode()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setLanguageOverlayMode (   $languageOverlayMode)
Parameters
mixed$languageOverlayMode‪TRUE, FALSE or "hideNonTranslated"
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

◆ setLanguageUid()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setLanguageUid (   $languageUid)
Parameters
int$languageUid
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

◆ setRespectStoragePage()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setRespectStoragePage (   $respectStoragePage)

Sets the flag if the storage page should be respected for the query.

Parameters
bool$respectStoragePage‪If TRUE the storage page ID will be determined and the statement will be extended accordingly.
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

◆ setRespectSysLanguage()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setRespectSysLanguage (   $respectSysLanguage)

Sets the flag if record language should be respected when querying. Other settings defines whether overlay should happen or not.

Parameters
bool$respectSysLanguage‪TRUE if only record language should be respected when querying
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.

◆ setStoragePageIds()

TYPO3 CMS Extbase Persistence Generic QuerySettingsInterface TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setStoragePageIds ( array  $storagePageIds)

Sets the pid(s) of the storage page(s) that should be respected for the query.

Parameters
array$storagePageIds‪If TRUE the storage page ID will be determined and the statement will be extended accordingly.
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining

Implemented in TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings.