TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Extbase\Persistence\Generic\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 ()
	setReturnRawQueryResult ($returnRawQueryResult)
	getReturnRawQueryResult ()
	getUseQueryCache ()
	getUsePreparedStatement ()

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! A query settings interface. This interface is NOT part of the FLOW3 API.

Definition at line 19 of file QuerySettingsInterface.php.

Member Function Documentation

getEnableFieldsToBeIgnored()

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\addVisibilityConstraintStatement().

getIgnoreEnableFields()

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

boolean

See also

getEnableFieldsToBeIgnored()

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

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

getIncludeDeleted()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getIncludeDeleted

(

)

Returns if the query should return objects that are deleted.

Returns

boolean

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

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

getLanguageMode()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getLanguageMode

(

)

Returns

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

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

getLanguageOverlayMode()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getLanguageOverlayMode

(

)

Returns

mixed TRUE, FALSE or "hideNonTranslated"

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

getLanguageUid()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getLanguageUid

(

)

Returns

integer

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

getRespectStoragePage()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getRespectStoragePage

(

)

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

Returns

boolean 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\addAdditionalWhereClause().

getRespectSysLanguage()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getRespectSysLanguage

(

)

Returns the state, if a and language overlay should be performed.

Returns

boolean TRUE, if a and language overlay should be performed; otherwise FALSE.

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

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

getReturnRawQueryResult()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getReturnRawQueryResult

(

)

Returns the state, if the QueryResult should be returned unmapped.

Returns

boolean TRUE, if the QueryResult should be returned unmapped; otherwise FALSE.

Deprecated:

since Extbase 6.2, will be removed two versions later. Please use argument in query->execute() instead.

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

getStoragePageIds()

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\addAdditionalWhereClause().

getUsePreparedStatement()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getUsePreparedStatement

(

)

Returns

bool

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

getUseQueryCache()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getUseQueryCache

(

)

Returns

bool

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

setEnableFieldsToBeIgnored()

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

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::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

boolean

$ignoreEnableFields

Returns

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::setIncludeDeleted

(

$includeDeleted

)

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

Parameters

boolean

$includeDeleted

Returns

instance of $this to allow method chaining

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

setLanguageMode()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setLanguageMode

(

$languageMode

)

Parameters

string

$languageMode

NULL, "content_fallback", "strict" or "ignore"

Returns

instance of $this to allow method chaining

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

setLanguageOverlayMode()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setLanguageOverlayMode

(

$languageOverlayMode

)

Parameters

mixed

$languageOverlayMode

TRUE, FALSE or "hideNonTranslated"

Returns

instance of $this to allow method chaining

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

setLanguageUid()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setLanguageUid

(

$languageUid

)

Parameters

integer

$languageUid

Returns

instance of $this to allow method chaining

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

setRespectStoragePage()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setRespectStoragePage

(

$respectStoragePage

)

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

Parameters

boolean

$respectStoragePage

If TRUE the storage page ID will be determined and the statement will be extended accordingly.

Returns

instance of $this to allow method chaining

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

setRespectSysLanguage()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setRespectSysLanguage

(

$respectSysLanguage

)

Sets the flag if a and language overlay should be performed.

Parameters

boolean

$respectSysLanguage

TRUE if a and language overlay should be performed.

Returns

instance of $this to allow method chaining

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

setReturnRawQueryResult()

TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setReturnRawQueryResult

(

$returnRawQueryResult

)

Sets the state, if the QueryResult should be returned unmapped.

Parameters

boolean

$returnRawQueryResult

TRUE, if the QueryResult should be returned unmapped; otherwise FALSE.

Returns

void

Deprecated:

since Extbase 6.2, will be removed two versions later. Please use argument in query->execute() instead.

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

setStoragePageIds()

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

instance of $this to allow method chaining

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