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

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

Public Member Functions
$this	setRespectStoragePage (bool $respectStoragePage)
bool	getRespectStoragePage ()
$this	setStoragePageIds (array $storagePageIds)
int[]	getStoragePageIds ()
$this	setRespectSysLanguage (bool $respectSysLanguage)
bool	getRespectSysLanguage ()
$this	setIgnoreEnableFields (bool $ignoreEnableFields)
	getIgnoreEnableFields ()
$this	setEnableFieldsToBeIgnored (array $enableFieldsToBeIgnored)
string[]	getEnableFieldsToBeIgnored ()
$this	setIncludeDeleted (bool $includeDeleted)
	getIncludeDeleted ()
	getLanguageAspect ()
$this	setLanguageAspect (LanguageAspect $languageAspect)

Detailed Description

A query settings interface. This interface is NOT part of the TYPO3.Flow API.

Definition at line 25 of file QuerySettingsInterface.php.

Member Function Documentation

getEnableFieldsToBeIgnored()

string [] 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

‪string[]

See also

‪getIgnoreEnableFields()

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

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

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.

See also

‪getEnableFieldsToBeIgnored()

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

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

getIncludeDeleted()

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

(

)

Returns if the query should return objects that are deleted.

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

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

getLanguageAspect()

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

(

)

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getLanguageStatement(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery(), TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\overlayLanguageAndWorkspace(), and TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\overlayLanguageAndWorkspaceForSingleRecord().

getRespectStoragePage()

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

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

getRespectSysLanguage()

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

(

)

Returns the state, if record language should be checked when querying

Returns

‪bool if TRUE record language is checked.

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

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

getStoragePageIds()

int [] TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::getStoragePageIds

(

)

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

Returns

‪int[] 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\getAdditionalWhereClause().

setEnableFieldsToBeIgnored()

$this TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::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.

Parameters

string[]

$enableFieldsToBeIgnored

Returns

‪$this fluent interface

See also

‪setIgnoreEnableFields()

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint().

setIgnoreEnableFields()

$this TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::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.

Parameters

bool

$ignoreEnableFields

Returns

‪$this fluent interface

See also

‪setEnableFieldsToBeIgnored()

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint().

setIncludeDeleted()

$this TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setIncludeDeleted

(

bool

$includeDeleted

)

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

Parameters

bool

$includeDeleted

Returns

‪$this fluent interface

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

setLanguageAspect()

$this TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::setLanguageAspect

(

LanguageAspect

$languageAspect

)

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

Returns

‪$this fluent interface

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery().

setRespectStoragePage()

$this TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface::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.

Returns

‪$this fluent interface

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery(), and TYPO3Tests\ParentChildTranslation\Domain\Repository\MainRepository\initializeObject().

setRespectSysLanguage()

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

(

bool

$respectSysLanguage

)

Sets the flag if record language should be respected when querying. Other settings defines whether overlay should happen or not.

Parameters

bool

$respectSysLanguage

‪TRUE if only record language should be respected when querying

Returns

‪$this fluent interface

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery().

setStoragePageIds()

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

int[]

$storagePageIds

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

Returns

‪$this fluent interface

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