DataMapItem
Entity for data-map item.
Table of Contents
Constants
- SCOPE_EXCLUDE = 'exclude'
- SCOPE_PARENT = \TYPO3\CMS\Core\DataHandling\Localization\State::STATE_PARENT
- SCOPE_SOURCE = \TYPO3\CMS\Core\DataHandling\Localization\State::STATE_SOURCE
- TYPE_DIRECT_CHILD = 'directChild'
- TYPE_GRAND_CHILD = 'grandChild'
- TYPE_PARENT = 'parent'
Properties
- $configurationFieldNames : array<string|int, mixed>
- $dependencies : array<string|int, array<string|int, DataMapItem>>
- $id : string|int
- $language : string|int
- $new : bool
- $parent : string|int
- $persistedValues : array<string|int, mixed>
- $source : string|int
- $state : State|null
- $suggestedValues : array<string|int, mixed>
- $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() : array<string|int, DataMapItem>
- getApplicableScopes() : array<string|int, string>
- getConfigurationFieldNames() : array<string|int, mixed>
- getDependencies() : array<string|int, array<string|int, 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<string|int, mixed>
- 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<string|int, mixed>
- 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<string|int, mixed>
    $configurationFieldNames
    
    
    
    
    
    
$dependencies
        protected
            array<string|int, array<string|int, DataMapItem>>
    $dependencies
     = []
    
    
    
    
    
$id
        protected
            string|int
    $id
    
    
    
    
    
    
$language
        protected
            string|int
    $language
    
    
    
    
    
    
$new
        protected
            bool
    $new
    
    
    
    
    
    
$parent
        protected
            string|int
    $parent
    
    
    
    
    
    
$persistedValues
        protected
            array<string|int, mixed>
    $persistedValues
    
    
    
    
    
    
$source
        protected
            string|int
    $source
    
    
    
    
    
    
$state
        protected
            State|null
    $state
    
    
    
    
    
    
$suggestedValues
        protected
            array<string|int, mixed>
    $suggestedValues
    
    
    
    
    
    
$tableName
        protected
            string
    $tableName
    
    
    
    
    
    
$type
        protected
            string
    $type
    
    
    
    
    
    
Methods
__construct()
    public
                    __construct(string $tableName, string|int $id, array<string|int, mixed> $suggestedValues, array<string|int, mixed> $persistedValues, array<string|int, mixed> $configurationFieldNames) : mixed
    Parameters
- $tableName : string
- $id : string|int
- $suggestedValues : array<string|int, mixed>
- $persistedValues : array<string|int, mixed>
- $configurationFieldNames : array<string|int, mixed>
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<string|int, mixed> $suggestedValues, array<string|int, mixed> $persistedValues, array<string|int, mixed> $configurationFieldNames) : DataMapItem
    Parameters
- $tableName : string
- $id : string|int
- $suggestedValues : array<string|int, mixed>
- $persistedValues : array<string|int, mixed>
- $configurationFieldNames : array<string|int, mixed>
Return values
DataMapItemfindDependencies()
    public
                    findDependencies(string $scope) : array<string|int, DataMapItem>
    Parameters
- $scope : string
Return values
array<string|int, DataMapItem>getApplicableScopes()
    public
                    getApplicableScopes() : array<string|int, string>
    Return values
array<string|int, string>getConfigurationFieldNames()
    public
                    getConfigurationFieldNames() : array<string|int, mixed>
    Return values
array<string|int, mixed>getDependencies()
    public
                    getDependencies() : array<string|int, array<string|int, DataMapItem>>
    Return values
array<string|int, array<string|int, DataMapItem>>getId()
Gets the id of this data-map item.
    public
                    getId() : int|string
    Return values
int|stringgetIdForScope()
    public
                    getIdForScope(string $scope) : int|string
    Parameters
- $scope : string
Return values
int|stringgetLanguage()
    public
                    getLanguage() : string|int
    Return values
string|intgetLanguageFieldName()
    public
                    getLanguageFieldName() : string
    Return values
stringgetParent()
    public
                    getParent() : string|int
    Return values
string|intgetParentFieldName()
    public
                    getParentFieldName() : string
    Return values
stringgetPersistedValues()
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<string|int, mixed>
    Return values
array<string|int, mixed>getSource()
    public
                    getSource() : string|int
    Return values
string|intgetSourceFieldName()
    public
                    getSourceFieldName() : string|null
    Return values
string|nullgetState()
    public
                    getState() : State|null
    Return values
State|nullgetSuggestedValues()
Gets the suggested values that were initially submitted as the whole data-map to the DataHandler.
    public
                    getSuggestedValues() : array<string|int, mixed>
    Return values
array<string|int, mixed>getTableName()
Gets the current table name of this data-map item.
    public
                    getTableName() : string
    Return values
stringgetType()
    public
                    getType() : string
    Return values
stringisDirectChildType()
    public
                    isDirectChildType() : bool
    Return values
boolisGrandChildType()
    public
                    isGrandChildType() : bool
    Return values
boolisNew()
    public
                    isNew() : bool
    Return values
boolisParentType()
    public
                    isParentType() : bool
    Return values
boolsetDependencies()
    public
                    setDependencies(array<string|int, array<string|int, DataMapItem>> $dependencies) : mixed
    Parameters
- $dependencies : array<string|int, array<string|int, DataMapItem>>
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
buildState()
    protected
                    buildState() : State|null
    Return values
State|nullextractId()
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