TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
Typo3QuerySettings Class Reference
Inheritance diagram for Typo3QuerySettings:
QuerySettingsInterface

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 = array()
 
 $ignoreEnableFields = false
 
 $enableFieldsToBeIgnored = array()
 
 $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 25 of file Typo3QuerySettings.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()

Implements QuerySettingsInterface.

Definition at line 312 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$enableFieldsToBeIgnored.

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

Definition at line 284 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$ignoreEnableFields.

getIncludeDeleted ( )

Returns if the query should return objects that are deleted.

Returns
bool

Implements QuerySettingsInterface.

Definition at line 335 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$includeDeleted.

getLanguageMode ( )
Returns
string NULL, "content_fallback", "strict" or "ignore"

Implements QuerySettingsInterface.

Definition at line 235 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$languageMode.

getLanguageOverlayMode ( )
Returns
mixed TRUE, FALSE or "hideNonTranslated"

Implements QuerySettingsInterface.

Definition at line 216 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$languageOverlayMode.

getLanguageUid ( )
Returns
int

Implements QuerySettingsInterface.

Definition at line 254 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$languageUid.

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

Definition at line 155 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$respectStoragePage.

getRespectSysLanguage ( )
Returns
bool TRUE if TYPO3 language settings are to be applied

Implements QuerySettingsInterface.

Definition at line 197 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$respectSysLanguage.

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

Definition at line 178 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$storagePageIds.

getUsePreparedStatement ( )
Returns
bool

Implements QuerySettingsInterface.

Definition at line 353 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$usePreparedStatement.

getUseQueryCache ( )
Returns
bool

Implements QuerySettingsInterface.

Definition at line 371 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$useQueryCache.

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

Definition at line 299 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$enableFieldsToBeIgnored.

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

Definition at line 269 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$ignoreEnableFields.

setIncludeDeleted (   $includeDeleted)

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

Parameters
bool$includeDeleted
Returns
QuerySettingsInterface

Implements QuerySettingsInterface.

Definition at line 324 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$includeDeleted.

setLanguageMode (   $languageMode = '')
Parameters
string$languageModeNULL, "content_fallback", "strict" or "ignore"
Returns
QuerySettingsInterface instance of $this to allow method chaining

Implements QuerySettingsInterface.

Definition at line 226 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$languageMode.

setLanguageOverlayMode (   $languageOverlayMode = false)
Parameters
mixed$languageOverlayModeTRUE, FALSE or "hideNonTranslated"
Returns
QuerySettingsInterface instance of $this to allow method chaining

Implements QuerySettingsInterface.

Definition at line 207 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$languageOverlayMode.

setLanguageUid (   $languageUid)
Parameters
int$languageUid
Returns
QuerySettingsInterface instance of $this to allow method chaining

Implements QuerySettingsInterface.

Definition at line 245 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$languageUid.

setRespectStoragePage (   $respectStoragePage)

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

Parameters
bool$respectStoragePageIf TRUE the storage page ID will be determined and the statement will be extended accordingly.
Returns
QuerySettingsInterface

Implements QuerySettingsInterface.

Definition at line 144 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$respectStoragePage.

setRespectSysLanguage (   $respectSysLanguage)
Parameters
bool$respectSysLanguageTRUE if TYPO3 language settings are to be applied
Returns
QuerySettingsInterface

Implements QuerySettingsInterface.

Definition at line 188 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$respectSysLanguage.

setStoragePageIds ( array  $storagePageIds)

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

Parameters
array$storagePageIdsIf given the storage page IDs will be determined and the statement will be extended accordingly.
Returns
QuerySettingsInterface

Implements QuerySettingsInterface.

Definition at line 167 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$storagePageIds.

usePreparedStatement (   $usePreparedStatement)
Parameters
bool$usePreparedStatement
Returns
QuerySettingsInterface

Definition at line 344 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$usePreparedStatement.

useQueryCache (   $useQueryCache)
Parameters
bool$useQueryCache
Returns
QuerySettingsInterface

Definition at line 362 of file Typo3QuerySettings.php.

References Typo3QuerySettings\$useQueryCache.

Member Data Documentation

$enableFieldsToBeIgnored = array()
protected
$ignoreEnableFields = false
protected
$includeDeleted = false
protected
$languageMode = null
protected
$languageOverlayMode = true
protected
$languageUid = 0
protected
$respectStoragePage = true
protected
$respectSysLanguage = true
protected
$storagePageIds = array()
protected
$usePreparedStatement = false
protected
$useQueryCache = true
protected