TYPO3\CMS\Core\DataHandling\Localization\DataMapItem Class Reference

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

Static Public Member Functions
static	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 ($idValue)
	buildState ()

Protected Attributes
	$tableName
	$id
	$suggestedValues
	$persistedValues
	$configurationFieldNames
	$new
	$type
	$state
	$language
	$parent
	$source
	$dependencies = []

Detailed Description

Entity for data-map item.

Definition at line 24 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	$tableName
string | int	$id
array	$suggestedValues
array	$persistedValues
array	$configurationFieldNames

Definition at line 137 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 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	$tableName
string | int	$id
array	$suggestedValues
array	$persistedValues
array	$configurationFieldNames

Returns

object|DataMapItem

Definition at line 105 of file DataMapItem.php.

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

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

Returns

State|null

Definition at line 449 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, and TYPO3\CMS\Core\DataHandling\Localization\State\STATE_SOURCE.

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

extractId()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::extractId (   $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'.

Parameters

int | string

$idValue

Returns

int|string

Definition at line 433 of file DataMapItem.php.

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

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

findDependencies()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::findDependencies

(

string

$scope

)

Parameters

string

$scope

Returns

DataMapItem[]

Definition at line 407 of file DataMapItem.php.

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

getApplicableScopes()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getApplicableScopes

(

)

Returns

string[]

Definition at line 415 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

(

)

Returns

array

Definition at line 226 of file DataMapItem.php.

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

getDependencies()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getDependencies

(

)

Returns

DataMapItem[][]

Definition at line 390 of file DataMapItem.php.

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

getForTableName()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getForTableName

(

)

Gets the table name used to resolve any kind of translations.

Returns

string

Definition at line 182 of file DataMapItem.php.

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

getFromTableName()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getFromTableName

(

)

Gets the table name used to resolve the language parent record.

Returns

string

Definition at line 169 of file DataMapItem.php.

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

Referenced by TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\resolvePersistedInlineRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\resolveSuggestedInlineRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeDirectRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeFieldValues(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeInlineRelations(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeTranslationItem().

getId()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getId

(

)

Gets the id of this data-map item.

Returns

mixed

Definition at line 195 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\synchronizeInlineRelations(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeTranslationItem().

getIdForScope()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getIdForScope

(

$scope

)

Parameters

string

$scope

Returns

int|string

Definition at line 373 of file DataMapItem.php.

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

getLanguage()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getLanguage

(

)

Returns

string|int

Definition at line 324 of file DataMapItem.php.

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

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

getLanguageFieldName()

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

(

)

Returns

string

Definition at line 234 of file DataMapItem.php.

getParent()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getParent

(

)

Returns

string|int

Definition at line 340 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

(

)

Returns

string

Definition at line 242 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.

Returns

array

Definition at line 218 of file DataMapItem.php.

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

getSource()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getSource

(

)

Returns

string|int

Definition at line 356 of file DataMapItem.php.

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

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

getSourceFieldName()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::getSourceFieldName

(

)

Returns

string|null

Definition at line 250 of file DataMapItem.php.

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

getState()

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

(

)

Returns

State

Definition at line 313 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.

Returns

array

Definition at line 206 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.

Returns

string

Definition at line 159 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\sanitizeTranslationItem(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeDirectRelations(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeFieldValues(), TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeInlineRelations(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeTranslationItem().

getType()

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

(

)

Returns

string

Definition at line 266 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

(

)

Returns

bool

Definition at line 297 of file DataMapItem.php.

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

isGrandChildType()

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

(

)

Returns

bool

Definition at line 305 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

(

)

Returns

bool

Definition at line 258 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\synchronizeInlineRelations(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor\synchronizeTranslationItem().

isParentType()

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

(

)

Returns

bool

Definition at line 289 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 398 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 332 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 348 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$parent, and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\extractId().

setSource()

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::setSource

(

$source

)

Parameters

string | int

$source

Definition at line 364 of file DataMapItem.php.

References TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\$source, and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\extractId().

Member Data Documentation

$configurationFieldNames

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

protected

Definition at line 57 of file DataMapItem.php.

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

$dependencies

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$dependencies = []

protected

Definition at line 92 of file DataMapItem.php.

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

$id

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$id

protected

Definition at line 42 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

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$language

protected

Definition at line 77 of file DataMapItem.php.

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

$new

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

protected

Definition at line 62 of file DataMapItem.php.

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

$parent

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$parent

protected

Definition at line 82 of file DataMapItem.php.

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

$persistedValues

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

protected

Definition at line 52 of file DataMapItem.php.

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

$source

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$source

protected

Definition at line 87 of file DataMapItem.php.

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

$state

TYPO3\CMS\Core\DataHandling\Localization\DataMapItem::$state

protected

Definition at line 72 of file DataMapItem.php.

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

$suggestedValues

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

protected

Definition at line 47 of file DataMapItem.php.

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

$tableName

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\extractId(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getForTableName(), TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getFromTableName(), and TYPO3\CMS\Core\DataHandling\Localization\DataMapItem\getTableName().

$type

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

protected

Definition at line 67 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 32 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 30 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 31 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 27 of file DataMapItem.php.

TYPE_GRAND_CHILD

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

Definition at line 28 of file DataMapItem.php.

TYPE_PARENT

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

Definition at line 26 of file DataMapItem.php.