DataMapItem

class \TYPO3\CMS\Core\DataHandling\Localization\DataMapItem

Entity for data-map item.

Table of Contents

Constants

SCOPE_EXCLUDE  : mixed = 'exclude'
SCOPE_PARENT  : mixed = \TYPO3\CMS\Core\DataHandling\Localization\State...
SCOPE_SOURCE  : mixed = \TYPO3\CMS\Core\DataHandling\Localization\State...
TYPE_DIRECT_CHILD  : mixed = 'directChild'
TYPE_GRAND_CHILD  : mixed = 'grandChild'
TYPE_PARENT  : mixed = 'parent'

Properties

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

Methods

__construct()  : mixed
build()  : DataMapItem
Builds a data-map item. In addition to the constructor, the values for language, parent and source record pointers are assigned as well.
findDependencies()  : DataMapItem[]
getApplicableScopes()  : string[]
getConfigurationFieldNames()  : array
getDependencies()  : DataMapItem[][]
getId()  : int|string
Gets the id of this data-map item.
getIdForScope()  : int|string
getLanguage()  : string|int
getLanguageFieldName()  : string
getParent()  : string|int
getParentFieldName()  : string
getPersistedValues()  : array
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.
getSource()  : string|int
getSourceFieldName()  : string|null
getState()  : State|null
getSuggestedValues()  : array
Gets the suggested values that were initially submitted as the whole data-map to the DataHandler.
getTableName()  : string
Gets the current table name of this data-map item.
getType()  : string
isDirectChildType()  : bool
isGrandChildType()  : bool
isNew()  : bool
isParentType()  : bool
setDependencies()  : mixed
setLanguage()  : mixed
setParent()  : mixed
setSource()  : mixed
buildState()  : State|null
extractId()  : int|string
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'.

Constants

SCOPE_EXCLUDE

public mixed SCOPE_EXCLUDE = 'exclude'

SCOPE_PARENT

public mixed SCOPE_PARENT = \TYPO3\CMS\Core\DataHandling\Localization\State::STATE_PARENT

SCOPE_SOURCE

public mixed SCOPE_SOURCE = \TYPO3\CMS\Core\DataHandling\Localization\State::STATE_SOURCE

TYPE_DIRECT_CHILD

public mixed TYPE_DIRECT_CHILD = 'directChild'

TYPE_GRAND_CHILD

public mixed TYPE_GRAND_CHILD = 'grandChild'

TYPE_PARENT

public mixed TYPE_PARENT = 'parent'

Properties

$configurationFieldNames

protected array $configurationFieldNames

$persistedValues

protected array $persistedValues

$suggestedValues

protected array $suggestedValues

Methods

__construct()

public __construct(string $tableName, string|int $id, array $suggestedValues, array $persistedValues, array $configurationFieldNames) : mixed

Parameters

$tableName : string
$id : string|int
$suggestedValues : array
$persistedValues : array
$configurationFieldNames : array

build()

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

public static build(string $tableName, string|int $id, array $suggestedValues, array $persistedValues, array $configurationFieldNames) : DataMapItem

Parameters

$tableName : string
$id : string|int
$suggestedValues : array
$persistedValues : array
$configurationFieldNames : array

Return values

DataMapItem

getApplicableScopes()

public getApplicableScopes() : string[]

Return values

string[]

getConfigurationFieldNames()

public getConfigurationFieldNames() : array

Return values

array

getId()

Gets the id of this data-map item.

public getId() : int|string

Return values

int|string

getIdForScope()

public getIdForScope(string $scope) : int|string

Parameters

$scope : string

Return values

int|string

getLanguage()

public getLanguage() : string|int

Return values

string|int

getLanguageFieldName()

public getLanguageFieldName() : string

Return values

string

getParent()

public getParent() : string|int

Return values

string|int

getParentFieldName()

public getParentFieldName() : string

Return values

string

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.

public getPersistedValues() : array

Return values

array

getSource()

public getSource() : string|int

Return values

string|int

getSourceFieldName()

public getSourceFieldName() : string|null

Return values

string|null

getSuggestedValues()

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

public getSuggestedValues() : array

Return values

array

getTableName()

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

public getTableName() : string

Return values

string

getType()

public getType() : string

Return values

string

isDirectChildType()

public isDirectChildType() : bool

Return values

bool

isGrandChildType()

public isGrandChildType() : bool

Return values

bool

isNew()

public isNew() : bool

Return values

bool

isParentType()

public isParentType() : bool

Return values

bool

setLanguage()

public setLanguage(string|int $language) : mixed

Parameters

$language : string|int

setParent()

public setParent(string|int $parent) : mixed

Parameters

$parent : string|int

setSource()

public setSource(string|int $source) : mixed

Parameters

$source : string|int

extractId()

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'.

protected extractId(int|string $idValue) : int|string

Parameters

$idValue : int|string

Return values

int|string
On this page