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

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

Public Member Functions
	__construct (Context $context, ConfigurationManagerInterface $configurationManager)
	setRespectStoragePage (bool $respectStoragePage)
bool	getRespectStoragePage ()
	setStoragePageIds (array $storagePageIds)
array	getStoragePageIds ()
	setRespectSysLanguage (bool $respectSysLanguage)
bool	getRespectSysLanguage ()
	getLanguageAspect ()
	setLanguageAspect (LanguageAspect $languageAspect)
	setIgnoreEnableFields (bool $ignoreEnableFields)
	getIgnoreEnableFields ()
	setEnableFieldsToBeIgnored (array $enableFieldsToBeIgnored)
	getEnableFieldsToBeIgnored ()
	setIncludeDeleted (bool $includeDeleted)
	getIncludeDeleted ()

Protected Attributes
ConfigurationManagerInterface	$configurationManager
Context	$context
bool	$respectStoragePage = true
array	$storagePageIds = []
bool	$ignoreEnableFields = false
array	$enableFieldsToBeIgnored = []
bool	$includeDeleted = false
bool	$respectSysLanguage = true
LanguageAspect	$languageAspect

Detailed Description

Query settings, reflects the settings unique to TYPO3 CMS.

Definition at line 27 of file Typo3QuerySettings.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::__construct	(	Context	$context,
		ConfigurationManagerInterface	$configurationManager
	)

Definition at line 67 of file Typo3QuerySettings.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$configurationManager, and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\$context.

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.

See also

‪getIgnoreEnableFields()

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

Definition at line 193 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.

See also

‪getEnableFieldsToBeIgnored()

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

Definition at line 169 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.

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

Definition at line 210 of file Typo3QuerySettings.php.

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

getLanguageAspect()

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

(

)

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

Definition at line 137 of file Typo3QuerySettings.php.

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

getRespectStoragePage()

bool 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 94 of file Typo3QuerySettings.php.

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

getRespectSysLanguage()

bool 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 132 of file Typo3QuerySettings.php.

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

getStoragePageIds()

array 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 115 of file Typo3QuerySettings.php.

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

setEnableFieldsToBeIgnored()

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

(

array

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

See also

‪setIgnoreEnableFields()

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

Definition at line 181 of file Typo3QuerySettings.php.

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

setIgnoreEnableFields()

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

(

bool

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

See also

‪setEnableFieldsToBeIgnored()

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

Definition at line 155 of file Typo3QuerySettings.php.

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

setIncludeDeleted()

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

(

bool

$includeDeleted

)

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

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

Definition at line 201 of file Typo3QuerySettings.php.

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

setLanguageAspect()

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

(

LanguageAspect

$languageAspect

)

Overrides the main language aspect, defined in the main Context API

Returns

‪$this fluent interface

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

Definition at line 142 of file Typo3QuerySettings.php.

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

setRespectStoragePage()

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

(

bool

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

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

Definition at line 83 of file Typo3QuerySettings.php.

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

setRespectSysLanguage()

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

(

bool

$respectSysLanguage

)

Parameters

bool

$respectSysLanguage

‪TRUE if TYPO3 language settings are to be applied

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

Definition at line 123 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.

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

Definition at line 104 of file Typo3QuerySettings.php.

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

Member Data Documentation

$configurationManager

ConfigurationManagerInterface TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$configurationManager

protected

Definition at line 29 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\__construct().

$context

Context TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$context

protected

Definition at line 30 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\__construct().

$enableFieldsToBeIgnored

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

protected

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

Definition at line 53 of file Typo3QuerySettings.php.

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

$ignoreEnableFields

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

protected

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.

Definition at line 47 of file Typo3QuerySettings.php.

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

$includeDeleted

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

protected

Flag whether deleted records should be included in the result set.

Definition at line 58 of file Typo3QuerySettings.php.

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

$languageAspect

LanguageAspect TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings::$languageAspect

protected

Definition at line 65 of file Typo3QuerySettings.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\getLanguageAspect(), and TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings\setLanguageAspect().

$respectStoragePage

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

protected

Flag if the storage page should be respected for the query.

Definition at line 35 of file Typo3QuerySettings.php.

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

$respectSysLanguage

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

protected

Flag if the sys_language_uid should be respected (default is TRUE).

Definition at line 63 of file Typo3QuerySettings.php.

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

$storagePageIds

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

protected

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

Definition at line 40 of file Typo3QuerySettings.php.

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