TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\DataHandling\PlainDataResolver Class Reference

Public Member Functions

 __construct ($tableName, array $liveIds, $sortingStatement=null)
 
 setWorkspaceId ($workspaceId)
 
 setKeepLiveIds ($keepLiveIds)
 
 setKeepDeletePlaceholder ($keepDeletePlaceholder)
 
 setKeepMovePlaceholder ($keepMovePlaceholder)
 
 get ()
 
 processVersionOverlays (array $ids)
 
 processVersionMovePlaceholders (array $ids)
 
 processSorting (array $ids)
 
 applyLiveIds (array $ids)
 

Protected Member Functions

 reindex (array $ids)
 
 isWorkspaceEnabled ()
 
 isLocalizationEnabled ()
 
 intImplode ($delimiter, array $values)
 
 getDatabaseConnection ()
 

Protected Attributes

 $tableName
 
 $liveIds
 
 $sortingStatement
 
 $workspaceId
 
 $keepLiveIds = false
 
 $keepDeletePlaceholder = false
 
 $keepMovePlaceholder = true
 
 $resolvedIds
 

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 27 of file PlainDataResolver.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::__construct (   $tableName,
array  $liveIds,
  $sortingStatement = null 
)
Parameters
string$tableName
int[]$liveIds
NULL | string$sortingStatement

Definition at line 74 of file PlainDataResolver.php.

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

Member Function Documentation

◆ applyLiveIds()

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 276 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\getDatabaseConnection(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\intImplode(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\isWorkspaceEnabled().

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

◆ get()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::get ( )
Returns
int[]

Definition at line 130 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\$resolvedIds, 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().

◆ getDatabaseConnection()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::getDatabaseConnection ( )
protected
Returns

Definition at line 352 of file PlainDataResolver.php.

References $GLOBALS.

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

◆ intImplode()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::intImplode (   $delimiter,
array  $values 
)
protected

Implodes an array of casted integer values.

Parameters
string$delimiter
array$values
Returns
string

Definition at line 344 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\getDatabaseConnection().

Referenced by 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().

◆ isLocalizationEnabled()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::isLocalizationEnabled ( )
protected
Returns
bool

Definition at line 332 of file PlainDataResolver.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\isTableLocalizable().

◆ isWorkspaceEnabled()

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

Definition at line 324 of file PlainDataResolver.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\isTableWorkspaceEnabled().

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

◆ processSorting()

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 242 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\getDatabaseConnection(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\intImplode().

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

◆ processVersionMovePlaceholders()

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 201 of file PlainDataResolver.php.

References TYPO3\CMS\Core\DataHandling\PlainDataResolver\getDatabaseConnection(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\intImplode(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\isWorkspaceEnabled(), and TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER.

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

◆ processVersionOverlays()

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

Processes version overlays on the final result set.

Parameters
int[]$ids
Returns
int[]

Definition at line 161 of file PlainDataResolver.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, TYPO3\CMS\Core\DataHandling\PlainDataResolver\getDatabaseConnection(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\intImplode(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\isWorkspaceEnabled(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\processVersionMovePlaceholders(), and TYPO3\CMS\Core\DataHandling\PlainDataResolver\reindex().

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

◆ reindex()

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

Re-indexes the given IDs.

Parameters
int[]$ids
Returns
int[]

Definition at line 311 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().

◆ setKeepDeletePlaceholder()

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 109 of file PlainDataResolver.php.

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

◆ setKeepLiveIds()

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 97 of file PlainDataResolver.php.

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

◆ setKeepMovePlaceholder()

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 121 of file PlainDataResolver.php.

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

◆ setWorkspaceId()

TYPO3\CMS\Core\DataHandling\PlainDataResolver::setWorkspaceId (   $workspaceId)

Sets the target workspace ID the final result shall use.

Parameters
int$workspaceId

Definition at line 86 of file PlainDataResolver.php.

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

Member Data Documentation

◆ $keepDeletePlaceholder

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

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

Definition at line 52 of file PlainDataResolver.php.

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

◆ $keepMovePlaceholder

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

Definition at line 62 of file PlainDataResolver.php.

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

◆ $liveIds

TYPO3\CMS\Core\DataHandling\PlainDataResolver::$liveIds
protected

Definition at line 37 of file PlainDataResolver.php.

◆ $resolvedIds

TYPO3\CMS\Core\DataHandling\PlainDataResolver::$resolvedIds
protected

Definition at line 67 of file PlainDataResolver.php.

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

◆ $sortingStatement

TYPO3\CMS\Core\DataHandling\PlainDataResolver::$sortingStatement
protected

Definition at line 42 of file PlainDataResolver.php.

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

◆ $tableName

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

Definition at line 32 of file PlainDataResolver.php.

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

◆ $workspaceId

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

Definition at line 47 of file PlainDataResolver.php.

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