‪TYPO3CMS  ‪main
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\DataHandling\Localization\DataMapItem Class Reference

Public Member Functions

 __construct (string $tableName, $id, array $suggestedValues, array $persistedValues, array $configurationFieldNames)
 
 getTableName ()
 
int string getId ()
 
 getSuggestedValues ()
 
 getPersistedValues ()
 
 getConfigurationFieldNames ()
 
 getLanguageFieldName ()
 
 getParentFieldName ()
 
string null getSourceFieldName ()
 
 isNew ()
 
 getType ()
 
 isParentType ()
 
 isDirectChildType ()
 
 isGrandChildType ()
 
 getState ()
 
string int getLanguage ()
 
 setLanguage ($language)
 
string int getParent ()
 
 setParent ($parent)
 
string int getSource ()
 
 setSource ($source)
 
int string getIdForScope (string $scope)
 
DataMapItem[][] getDependencies ()
 
 setDependencies (array $dependencies)
 
DataMapItem[] findDependencies (string $scope)
 
string[] getApplicableScopes ()
 

Static Public Member Functions

static DataMapItem build (string $tableName, $id, array $suggestedValues, array $persistedValues, array $configurationFieldNames)
 

Public Attributes

const TYPE_PARENT = 'parent'
 
const TYPE_DIRECT_CHILD = 'directChild'
 
const TYPE_GRAND_CHILD = 'grandChild'
 
const SCOPE_PARENT = State::STATE_PARENT
 
const SCOPE_SOURCE = State::STATE_SOURCE
 
const SCOPE_EXCLUDE = 'exclude'
 

Protected Member Functions

 extractId (int|string $idValue)
 
 buildState ()
 

Protected Attributes

string $tableName
 
string int $id
 
array $suggestedValues
 
array $persistedValues
 
array $configurationFieldNames
 
bool $new
 
string $type
 
State null $state
 
string int $language
 
string int $parent
 
string int $source
 
DataMapItem[][] $dependencies = array( )
 

Detailed Description

Entity for data-map item.

Definition at line 25 of file DataMapItem.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::__construct ( string  $tableName,
  $id,
array  $suggestedValues,
array  $persistedValues,
array  $configurationFieldNames 
)
Parameters
string | int$id

Definition at line 118 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$configurationFieldNames, TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$id, TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$persistedValues, TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$suggestedValues, TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$tableName, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Member Function Documentation

◆ build()

static DataMapItem TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::build ( string  $tableName,
  $id,
array  $suggestedValues,
array  $persistedValues,
array  $configurationFieldNames 
)
static

Builds a data-map item. In addition to the constructor, the values for language, parent and source record pointers are assigned as well.

Parameters
string | int$id
Returns
‪DataMapItem

Definition at line 90 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$configurationFieldNames, TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$id, TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$persistedValues, TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$suggestedValues, and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$tableName.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\collectItems(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\fetchDependencies().

◆ buildState()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::buildState ( )
protected

Definition at line 366 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$state, TYPO3\CMS\Core\DataHandling\Localization\State\create(), TYPO3\CMS\Core\DataHandling\Localization\State\fromJSON(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\isGrandChildType(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\isNew(), TYPO3\CMS\Core\DataHandling\Localization\State\STATE_CUSTOM, TYPO3\CMS\Core\DataHandling\Localization\State\STATE_SOURCE, TYPO3\CMS\Core\DataHandling\Localization\State\update(), and TYPO3\CMS\Core\DataHandling\Localization\State\updateStates().

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getState().

◆ extractId()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::extractId ( int|string  $idValue)
protected

Extracts real id from provided id-value, which can either be a real integer value, a 'NEW...' id, or a combined identifier 'tt_content_13'.

Definition at line 352 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$id, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\setParent(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\setSource().

◆ findDependencies()

DataMapItem [] TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::findDependencies ( string  $scope)
Returns
‪DataMapItem[]

Definition at line 329 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\populateTranslationItem().

◆ getApplicableScopes()

string [] TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getApplicableScopes ( )
Returns
‪string[]

Definition at line 337 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getSourceFieldName().

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\sanitizeTranslationItem().

◆ getConfigurationFieldNames()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getConfigurationFieldNames ( )

Definition at line 172 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$configurationFieldNames.

◆ getDependencies()

DataMapItem [][] TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getDependencies ( )
Returns
‪DataMapItem[][]

Definition at line 313 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$dependencies.

◆ getId()

int string TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getId ( )

Gets the id of this data-map item.

Returns
‪int|string

Definition at line 148 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$id.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\addNextItem(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\finishTranslationItem(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\populateTranslationItem(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\resolvePersistedInlineRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\sanitizeTranslationItem(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeDirectRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeFieldValues(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeReferences(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeTranslationItem().

◆ getIdForScope()

int string TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getIdForScope ( string  $scope)
Parameters
string$scope
Returns
‪int|string

Definition at line 296 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getParent(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getSource().

◆ getLanguage()

string int TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getLanguage ( )
Returns
‪string|int

Definition at line 247 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$language.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeReferences().

◆ getLanguageFieldName()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getLanguageFieldName ( )

Definition at line 177 of file DataMapItem.php.

◆ getParent()

string int TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getParent ( )
Returns
‪string|int

Definition at line 263 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$parent.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getIdForScope().

◆ getParentFieldName()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getParentFieldName ( )

Definition at line 182 of file DataMapItem.php.

◆ getPersistedValues()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getPersistedValues ( )

Gets the persisted values that represent the persisted state of the record this data-map item is a surrogate for - does only contain relevant field values.

Definition at line 167 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$persistedValues.

◆ getSource()

string int TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getSource ( )
Returns
‪string|int

Definition at line 279 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$source.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getIdForScope().

◆ getSourceFieldName()

string null TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getSourceFieldName ( )
Returns
‪string|null

Definition at line 190 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getApplicableScopes().

◆ getState()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getState ( )

Definition at line 236 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$state, TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\buildState(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\isParentType().

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\finishTranslationItem(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\getFieldNamesForItemScope().

◆ getSuggestedValues()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getSuggestedValues ( )

Gets the suggested values that were initially submitted as the whole data-map to the DataHandler.

Definition at line 157 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$suggestedValues.

◆ getTableName()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getTableName ( )

Gets the current table name of this data-map item.

Definition at line 138 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$tableName.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\addNextItem(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\finishTranslationItem(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\getFieldNamesForItemScope(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\resolvePersistedInlineRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\resolveSuggestedInlineRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\sanitizeTranslationItem(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeDirectRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeFieldValues(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeReferences(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeTranslationItem().

◆ getType()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getType ( )

Definition at line 200 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$type.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\filterItemsByType(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\isDirectChildType(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\isGrandChildType(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\isParentType().

◆ isDirectChildType()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::isDirectChildType ( )

Definition at line 226 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getType().

◆ isGrandChildType()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::isGrandChildType ( )

Definition at line 231 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getType().

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\buildState().

◆ isNew()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::isNew ( )

Definition at line 195 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$new.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\buildState(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\resolvePersistedInlineRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeReferences(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeTranslationItem().

◆ isParentType()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::isParentType ( )

Definition at line 221 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getType().

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\finishTranslationItem(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getState().

◆ setDependencies()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::setDependencies ( array  $dependencies)
Parameters
DataMapItem[][]$dependencies

Definition at line 321 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$dependencies.

◆ setLanguage()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::setLanguage (   $language)
Parameters
string | int$language

Definition at line 255 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$language.

◆ setParent()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::setParent (   $parent)
Parameters
string | int$parent

Definition at line 271 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\extractId().

◆ setSource()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::setSource (   $source)
Parameters
string | int$source

Definition at line 287 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\extractId().

Member Data Documentation

◆ $configurationFieldNames

array TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$configurationFieldNames
protected

Definition at line 53 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\__construct(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\build(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getConfigurationFieldNames().

◆ $dependencies

DataMapItem [][] TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$dependencies = array( )
protected

Definition at line 81 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getDependencies(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\setDependencies().

◆ $id

string int TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$id
protected

Definition at line 41 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\__construct(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\build(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\extractId(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getId().

◆ $language

string int TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$language
protected

Definition at line 69 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getLanguage(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\setLanguage().

◆ $new

bool TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$new
protected

Definition at line 57 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\isNew().

◆ $parent

string int TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$parent
protected

Definition at line 73 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getParent().

◆ $persistedValues

array TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$persistedValues
protected

Definition at line 49 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\__construct(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\build(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getPersistedValues().

◆ $source

string int TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$source
protected

Definition at line 77 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getSource().

◆ $state

State null TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$state
protected

Definition at line 65 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\buildState(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getState().

◆ $suggestedValues

array TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$suggestedValues
protected

Definition at line 45 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\__construct(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\build(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getSuggestedValues().

◆ $tableName

string TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$tableName
protected

Definition at line 37 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\__construct(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\build(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getTableName().

◆ $type

string TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$type
protected

Definition at line 61 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getType().

◆ SCOPE_EXCLUDE

const TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::SCOPE_EXCLUDE = 'exclude'

Definition at line 33 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\getFieldNamesForItemScope(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\populateTranslationItem().

◆ SCOPE_PARENT

const TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::SCOPE_PARENT = State::STATE_PARENT

Definition at line 31 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\getFieldNamesForItemScope(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\populateTranslationItem().

◆ SCOPE_SOURCE

const TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::SCOPE_SOURCE = State::STATE_SOURCE

Definition at line 32 of file DataMapItem.php.

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\getFieldNamesForItemScope(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\populateTranslationItem().

◆ TYPE_DIRECT_CHILD

const TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::TYPE_DIRECT_CHILD = 'directChild'

Definition at line 28 of file DataMapItem.php.

◆ TYPE_GRAND_CHILD

const TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::TYPE_GRAND_CHILD = 'grandChild'

Definition at line 29 of file DataMapItem.php.

◆ TYPE_PARENT

const TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::TYPE_PARENT = 'parent'

Definition at line 27 of file DataMapItem.php.