TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings:

Public Member Functions
	setRespectStoragePage ($respectStoragePage)
	getRespectStoragePage ()
	setStoragePageIds (array $storagePageIds)
	getStoragePageIds ()
	setRespectSysLanguage ($respectSysLanguage)
	getRespectSysLanguage ()
	setLanguageOverlayMode ($languageOverlayMode=false)
	getLanguageOverlayMode ()
	setLanguageMode ($languageMode='')
	getLanguageMode ()
	setLanguageUid ($languageUid)
	getLanguageUid ()
	setIgnoreEnableFields ($ignoreEnableFields)
	getIgnoreEnableFields ()
	setEnableFieldsToBeIgnored ($enableFieldsToBeIgnored)
	getEnableFieldsToBeIgnored ()
	setIncludeDeleted ($includeDeleted)
	getIncludeDeleted ()
	usePreparedStatement ($usePreparedStatement)
	getUsePreparedStatement ()
	useQueryCache ($useQueryCache)
	getUseQueryCache ()

Protected Attributes
	$respectStoragePage = true
	$storagePageIds = []
	$ignoreEnableFields = false
	$enableFieldsToBeIgnored = []
	$includeDeleted = false
	$respectSysLanguage = true
	$languageOverlayMode = true
	$languageMode = null
	$languageUid = 0
	$usePreparedStatement = false
	$useQueryCache = true

Detailed Description

Query settings. This class is NOT part of the TYPO3.Flow API. It reflects the settings unique to TYPO3 CMS.

Definition at line 27 of file Typo3QuerySettings.php.

Member Function Documentation

getEnableFieldsToBeIgnored()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::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()

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 314 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$enableFieldsToBeIgnored.

getIgnoreEnableFields()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::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()

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 286 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$ignoreEnableFields.

getIncludeDeleted()

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

(

)

Returns if the query should return objects that are deleted.

Returns

bool

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 337 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$includeDeleted.

getLanguageMode()

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

(

)

Returns

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

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 237 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$languageMode.

getLanguageOverlayMode()

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

(

)

Returns

mixed TRUE, FALSE or "hideNonTranslated"

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 218 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$languageOverlayMode.

getLanguageUid()

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

(

)

Returns

int

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 256 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$languageUid.

getRespectStoragePage()

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

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 157 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$respectStoragePage.

getRespectSysLanguage()

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

(

)

Returns

bool TRUE if TYPO3 language settings are to be applied

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 199 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$respectSysLanguage.

getStoragePageIds()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::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

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 180 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$storagePageIds.

getUsePreparedStatement()

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

(

)

Returns

bool

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 355 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$usePreparedStatement.

getUseQueryCache()

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

(

)

Returns

bool

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 373 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$useQueryCache.

setEnableFieldsToBeIgnored()

TYPO3\CMS\Extbase\Persistence\Generic\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

QuerySettingsInterface

See also

setIgnoreEnableFields()

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 301 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$enableFieldsToBeIgnored.

setIgnoreEnableFields()

TYPO3\CMS\Extbase\Persistence\Generic\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

Returns

QuerySettingsInterface

See also

setEnableFieldsToBeIgnored()

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 271 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$ignoreEnableFields.

setIncludeDeleted()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::setIncludeDeleted

(

$includeDeleted

)

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

Parameters

bool

$includeDeleted

Returns

QuerySettingsInterface

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 326 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$includeDeleted.

setLanguageMode()

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

(

$languageMode = ''

)

Parameters

string

$languageMode

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

Returns

QuerySettingsInterface instance of $this to allow method chaining

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 228 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$languageMode.

setLanguageOverlayMode()

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

(

$languageOverlayMode = false

)

Parameters

mixed

$languageOverlayMode

TRUE, FALSE or "hideNonTranslated"

Returns

QuerySettingsInterface instance of $this to allow method chaining

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 209 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$languageOverlayMode.

setLanguageUid()

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

(

$languageUid

)

Parameters

int

$languageUid

Returns

QuerySettingsInterface instance of $this to allow method chaining

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 247 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$languageUid.

setRespectStoragePage()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::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

QuerySettingsInterface

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 146 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$respectStoragePage.

setRespectSysLanguage()

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

(

$respectSysLanguage

)

Parameters

bool

$respectSysLanguage

TRUE if TYPO3 language settings are to be applied

Returns

QuerySettingsInterface

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 190 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$respectSysLanguage.

setStoragePageIds()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::setStoragePageIds

(

array

$storagePageIds

)

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

Parameters

array

$storagePageIds

If given the storage page IDs will be determined and the statement will be extended accordingly.

Returns

QuerySettingsInterface

Implements TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface.

Definition at line 169 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$storagePageIds.

usePreparedStatement()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::usePreparedStatement

(

$usePreparedStatement

)

Parameters

bool

$usePreparedStatement

Returns

QuerySettingsInterface

Definition at line 346 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$usePreparedStatement.

useQueryCache()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::useQueryCache

(

$useQueryCache

)

Parameters

bool

$useQueryCache

Returns

QuerySettingsInterface

Definition at line 364 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$useQueryCache.

Member Data Documentation

$enableFieldsToBeIgnored

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$enableFieldsToBeIgnored = []

protected

Definition at line 58 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getEnableFieldsToBeIgnored(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setEnableFieldsToBeIgnored().

$ignoreEnableFields

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$ignoreEnableFields = false

protected

Definition at line 50 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getIgnoreEnableFields(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setIgnoreEnableFields().

$includeDeleted

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$includeDeleted = false

protected

Definition at line 65 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getIncludeDeleted(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setIncludeDeleted().

$languageMode

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$languageMode = null

protected

Definition at line 86 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getLanguageMode(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setLanguageMode().

$languageOverlayMode

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$languageOverlayMode = true

protected

Definition at line 79 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getLanguageOverlayMode(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setLanguageOverlayMode().

$languageUid

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$languageUid = 0

protected

Definition at line 93 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getLanguageUid(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setLanguageUid().

$respectStoragePage

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$respectStoragePage = true

protected

Definition at line 34 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getRespectStoragePage(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setRespectStoragePage().

$respectSysLanguage

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$respectSysLanguage = true

protected

Definition at line 72 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getRespectSysLanguage(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setRespectSysLanguage().

$storagePageIds

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$storagePageIds = []

protected

Definition at line 41 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getStoragePageIds(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setStoragePageIds().

$usePreparedStatement

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$usePreparedStatement = false

protected

Definition at line 100 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getUsePreparedStatement(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\usePreparedStatement().

$useQueryCache

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$useQueryCache = true

protected

Definition at line 107 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getUseQueryCache(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\useQueryCache().