Inheritance diagram for QuerySettingsInterface:

Public Member Functions
	setRespectStoragePage ($respectStoragePage)

	getRespectStoragePage ()

	setStoragePageIds (array $storagePageIds)

	getStoragePageIds ()

	setRespectSysLanguage ($respectSysLanguage)

	getRespectSysLanguage ()

	setLanguageOverlayMode ($languageOverlayMode)

	getLanguageOverlayMode ()

	setLanguageMode ($languageMode)

	getLanguageMode ()

	setLanguageUid ($languageUid)

	getLanguageUid ()

	setIgnoreEnableFields ($ignoreEnableFields)

	getIgnoreEnableFields ()

	setEnableFieldsToBeIgnored ($enableFieldsToBeIgnored)

	getEnableFieldsToBeIgnored ()

	setIncludeDeleted ($includeDeleted)

	getIncludeDeleted ()

	getUseQueryCache ()

	getUsePreparedStatement ()

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 ( )

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 Typo3QuerySettings.

Referenced by Typo3DbQueryParser\getVisibilityConstraintStatement().

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 Typo3QuerySettings.

Referenced by Typo3DbQueryParser\getVisibilityConstraintStatement().

getIncludeDeleted ( )

Returns if the query should return objects that are deleted.

Returns: bool

Implemented in Typo3QuerySettings.

Referenced by Typo3DbQueryParser\getVisibilityConstraintStatement().

getLanguageMode ( )

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

Implemented in Typo3QuerySettings.

getLanguageOverlayMode ( )

Returns: mixed TRUE, FALSE or "hideNonTranslated"

Implemented in Typo3QuerySettings.

getLanguageUid ( )

Returns: int

Implemented in Typo3QuerySettings.

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 Typo3QuerySettings.

Referenced by Typo3DbQueryParser\getAdditionalWhereClause().

getRespectSysLanguage ( )

Returns the state, if a language overlay should be performed when a translation is active.

Returns: bool TRUE, if a language overlay should be performed when a translation is active; otherwise FALSE.

Implemented in Typo3QuerySettings.

Referenced by Typo3DbQueryParser\getAdditionalWhereClause().

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 Typo3QuerySettings.

Referenced by Typo3DbQueryParser\getAdditionalWhereClause().

getUsePreparedStatement ( )

Returns: bool

Implemented in Typo3QuerySettings.

getUseQueryCache ( )

Returns: bool

Implemented in Typo3QuerySettings.

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: instance of $this to allow method chaining

See Also: setIgnoreEnableFields()

Implemented in Typo3QuerySettings.

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