TYPO3\CMS\Core\DataHandling\PlainDataResolver Class Reference

Public Member Functions
	__construct ($tableName, array $liveIds, array $sortingStatement=null)
	setWorkspaceId ($workspaceId)
PlainDataResolver	setKeepLiveIds ($keepLiveIds)
PlainDataResolver	setKeepDeletePlaceholder ($keepDeletePlaceholder)
PlainDataResolver	setKeepMovePlaceholder ($keepMovePlaceholder)
int[]	get ()
int[]	processVersionOverlays (array $ids)
int[]	processVersionMovePlaceholders (array $ids)
int[]	processSorting (array $ids)
int[]	applyLiveIds (array $ids)

Protected Member Functions
int[]	reindex (array $ids)
	sanitizeIds (array $ids)
bool	isWorkspaceEnabled ()

Protected Attributes
string	$tableName
int[]	$liveIds
array null	$sortingStatement
int	$workspaceId
bool	$keepLiveIds = false
bool	$keepDeletePlaceholder = false
bool	$keepMovePlaceholder = true

Detailed Description

Plain data resolving.

This component resolves data constraints for given IDs of a particular table on a plain/raw database level. Thus, workspaces placeholders and overlay related resorting is applied automatically.

Definition at line 33 of file PlainDataResolver.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::__construct	(		$tableName,
		array	$liveIds,
		array	$sortingStatement = null
	)

Parameters

string	$tableName
int[]	$liveIds
array | null	$sortingStatement

Definition at line 68 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\$sortingStatement, TYPO3\CMS\Core\DataHandling\PlainDataResolver\$tableName, TYPO3\CMS\Core\DataHandling\PlainDataResolver\reindex(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\sanitizeIds().

Member Function Documentation

applyLiveIds()

int [] TYPO3\CMS\Core\DataHandling\PlainDataResolver::applyLiveIds

(

array

$ids

)

Applies live IDs to the final result set, if the current table is enabled for workspaces and the keepLiveIds class member is enabled.

Parameters

int[]

$ids

Returns

‪int[]

Definition at line 320 of file PlainDataResolver.php.

References TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Core\DataHandling\PlainDataResolver\isWorkspaceEnabled(), TYPO3\CMS\Core\Database\Connection\PARAM_INT_ARRAY, and TYPO3\CMS\Core\DataHandling\PlainDataResolver\sanitizeIds().

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\get().

get()

int [] TYPO3\CMS\Core\DataHandling\PlainDataResolver::get

(

)

Returns

‪int[]

Definition at line 124 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\applyLiveIds(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\processSorting(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionOverlays(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\reindex().

Referenced by TYPO3\CMS\Core\Database\RelationHandler\readForeignField(), and TYPO3\CMS\Core\Database\RelationHandler\readList().

isWorkspaceEnabled()

bool TYPO3\CMS\Core\DataHandling\PlainDataResolver::isWorkspaceEnabled ( )

protected

Returns

‪bool

Definition at line 388 of file PlainDataResolver.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\applyLiveIds(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionMovePlaceholders(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionOverlays().

processSorting()

int [] TYPO3\CMS\Core\DataHandling\PlainDataResolver::processSorting

(

array

$ids

)

Processes sorting of the final result set, if a sorting statement (table column/expression) is given.

Parameters

int[]

$ids

Returns

‪int[]

Definition at line 263 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\$sortingStatement, and TYPO3\CMS\Core\DataHandling\PlainDataResolver\sanitizeIds().

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\get().

processVersionMovePlaceholders()

int [] TYPO3\CMS\Core\DataHandling\PlainDataResolver::processVersionMovePlaceholders

(

array

$ids

)

Processes and resolves move placeholders on the final result set.

Parameters

int[]

$ids

Returns

‪int[]

Definition at line 206 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\isWorkspaceEnabled(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Database\Connection\PARAM_INT_ARRAY, and TYPO3\CMS\Core\DataHandling\PlainDataResolver\sanitizeIds().

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionOverlays().

processVersionOverlays()

int [] TYPO3\CMS\Core\DataHandling\PlainDataResolver::processVersionOverlays

(

array

$ids

)

Processes version overlays on the final result set.

Parameters

int[]

$ids

Returns

‪int[]

Definition at line 151 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\isWorkspaceEnabled(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Database\Connection\PARAM_INT_ARRAY, TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionMovePlaceholders(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\reindex(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\sanitizeIds().

Referenced by TYPO3\CMS\Core\Database\RelationHandler\convertItemArray(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\get().

reindex()

int [] TYPO3\CMS\Core\DataHandling\PlainDataResolver::reindex ( array  $ids )

protected

Re-indexes the given IDs.

Parameters

int[]

$ids

Returns

‪int[]

Definition at line 365 of file PlainDataResolver.php.

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\__construct(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\get(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionOverlays().

sanitizeIds()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::sanitizeIds ( array  $ids )

protected

Removes empty values (null, '0', 0, false).

Parameters

int[]

$ids

Definition at line 380 of file PlainDataResolver.php.

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\__construct(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\applyLiveIds(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\processSorting(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionMovePlaceholders(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionOverlays().

setKeepDeletePlaceholder()

PlainDataResolver TYPO3\CMS\Core\DataHandling\PlainDataResolver::setKeepDeletePlaceholder

(

$keepDeletePlaceholder

)

Sets whether delete placeholders shall be kept in the final result set.

Parameters

bool

$keepDeletePlaceholder

Returns

‪PlainDataResolver

Definition at line 103 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\$keepDeletePlaceholder.

Referenced by TYPO3\CMS\Core\Database\RelationHandler\convertItemArray().

setKeepLiveIds()

PlainDataResolver TYPO3\CMS\Core\DataHandling\PlainDataResolver::setKeepLiveIds

(

$keepLiveIds

)

Sets whether live IDs shall be kept in the final result set.

Parameters

bool

$keepLiveIds

Returns

‪PlainDataResolver

Definition at line 91 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\$keepLiveIds.

setKeepMovePlaceholder()

PlainDataResolver TYPO3\CMS\Core\DataHandling\PlainDataResolver::setKeepMovePlaceholder

(

$keepMovePlaceholder

)

Sets whether move placeholders shall be kept in case they cannot be substituted.

Parameters

bool

$keepMovePlaceholder

Returns

‪PlainDataResolver

Definition at line 115 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\$keepMovePlaceholder.

Referenced by TYPO3\CMS\Core\Database\RelationHandler\convertItemArray().

setWorkspaceId()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::setWorkspaceId

(

$workspaceId

)

Sets the target workspace ID the final result shall use.

Parameters

int

$workspaceId

Definition at line 80 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\$workspaceId.

Member Data Documentation

$keepDeletePlaceholder

bool TYPO3\CMS\Core\DataHandling\PlainDataResolver::$keepDeletePlaceholder = false

protected

Definition at line 57 of file PlainDataResolver.php.

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\setKeepDeletePlaceholder().

$keepLiveIds

bool TYPO3\CMS\Core\DataHandling\PlainDataResolver::$keepLiveIds = false

protected

Definition at line 53 of file PlainDataResolver.php.

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\setKeepLiveIds().

$keepMovePlaceholder

bool TYPO3\CMS\Core\DataHandling\PlainDataResolver::$keepMovePlaceholder = true

protected

Definition at line 61 of file PlainDataResolver.php.

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\setKeepMovePlaceholder().

$liveIds

int [] TYPO3\CMS\Core\DataHandling\PlainDataResolver::$liveIds

protected

Definition at line 41 of file PlainDataResolver.php.

$sortingStatement

array null TYPO3\CMS\Core\DataHandling\PlainDataResolver::$sortingStatement

protected

Definition at line 45 of file PlainDataResolver.php.

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\__construct(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\processSorting().

$tableName

string TYPO3\CMS\Core\DataHandling\PlainDataResolver::$tableName

protected

Definition at line 37 of file PlainDataResolver.php.

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\__construct().

$workspaceId

int TYPO3\CMS\Core\DataHandling\PlainDataResolver::$workspaceId

protected

Definition at line 49 of file PlainDataResolver.php.

Referenced by TYPO3\CMS\Core\DataHandling\PlainDataResolver\setWorkspaceId().