DataMap

Read onlyYes
FinalYes

A data map to map a single table configured in $TCA on a domain object.

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Table of Contents

Properties

$className  : string
$columnMaps  : array<string|int, mixed>
$creationDateColumnName  : string|null
$deletedFlagColumnName  : string|null
$disabledFlagColumnName  : string|null
$endTimeColumnName  : string|null
$frontendUserGroupColumnName  : string|null
$isStatic  : bool
$languageIdColumnName  : string|null
$modificationDateColumnName  : string|null
$recordType  : string|null
$recordTypeColumnName  : string|null
$rootLevel  : bool
$startTimeColumnName  : string|null
$subclasses  : array<string|int, mixed>
$tableName  : string
$translationOriginColumnName  : string|null
$translationOriginDiffSourceName  : string|null

Methods

__construct()  : mixed
getClassName()  : string
getColumnMap()  : ColumnMap|null
getCreationDateColumnName()  : string|null
getDeletedFlagColumnName()  : string|null
getDisabledFlagColumnName()  : string|null
getEndTimeColumnName()  : string|null
getFrontEndUserGroupColumnName()  : string|null
getIsStatic()  : bool
getLanguageIdColumnName()  : string|null
getModificationDateColumnName()  : string|null
getRecordType()  : string|null
getRecordTypeColumnName()  : string|null
getRootLevel()  : bool
getStartTimeColumnName()  : string|null
getSubclasses()  : array<string|int, mixed>
getTableName()  : string
getTranslationOriginColumnName()  : string|null
getTranslationOriginDiffSourceName()  : string|null
isPersistableProperty()  : bool

Properties

$columnMaps

public array<string|int, mixed> $columnMaps = []

$creationDateColumnName

public string|null $creationDateColumnName = null

$deletedFlagColumnName

public string|null $deletedFlagColumnName = null

$disabledFlagColumnName

public string|null $disabledFlagColumnName = null

$endTimeColumnName

public string|null $endTimeColumnName = null

$frontendUserGroupColumnName

public string|null $frontendUserGroupColumnName = null

$languageIdColumnName

public string|null $languageIdColumnName = null

$modificationDateColumnName

public string|null $modificationDateColumnName = null

$recordType

public string|null $recordType = null

$recordTypeColumnName

public string|null $recordTypeColumnName = null

$startTimeColumnName

public string|null $startTimeColumnName = null

$subclasses

public array<string|int, mixed> $subclasses = []

$translationOriginColumnName

public string|null $translationOriginColumnName = null

$translationOriginDiffSourceName

public string|null $translationOriginDiffSourceName = null

Methods

__construct()

public __construct(string $className, string $tableName[, string|null $recordType = null ][, array<string|int, mixed> $subclasses = [] ][, array<non-empty-string, ColumnMap> $columnMaps = [] ][, string|null $languageIdColumnName = null ][, string|null $translationOriginColumnName = null ][, string|null $translationOriginDiffSourceName = null ][, string|null $modificationDateColumnName = null ][, string|null $creationDateColumnName = null ][, string|null $deletedFlagColumnName = null ][, string|null $disabledFlagColumnName = null ][, string|null $startTimeColumnName = null ][, string|null $endTimeColumnName = null ][, string|null $frontendUserGroupColumnName = null ][, string|null $recordTypeColumnName = null ][, bool $isStatic = false ][, bool $rootLevel = false ]) : mixed
Parameters
$className : string

Name of the class this column map represents

$tableName : string

Name of the DB table this column map is located on

$recordType : string|null = null

The record type stored in the "type" field as configured in $TCA

$subclasses : array<string|int, mixed> = []

List of subclasses of the current class

$columnMaps : array<non-empty-string, ColumnMap> = []

List of TCA columns with their ColumnMap representation

$languageIdColumnName : string|null = null

Name of a column holding the language id of the record, often "sys_language_uid"

$translationOriginColumnName : string|null = null

Name of a column holding the uid of the record this record is a translation of, often "l10n_parent" or "l18n_parent"

$translationOriginDiffSourceName : string|null = null

Name of a column holding the diff data for the record this record is a translation of, often "l10n_diffsource" or "l10n_diffsource"

$modificationDateColumnName : string|null = null

Name of a column holding the timestamp the record was last modified, often "tstamp"

$creationDateColumnName : string|null = null

Name of a column holding the creation date timestamp, often "crdate"

$deletedFlagColumnName : string|null = null

Name of a column indicating the soft deleted state of the row, often "deleted"

$disabledFlagColumnName : string|null = null

Name of a column indicating the "hidden in frontend" state of the row, often "hidden" or "disabled"

$startTimeColumnName : string|null = null

Name of a column holding the timestamp the record should not be displayed before, often "starttime"

$endTimeColumnName : string|null = null

Name of a column holding the timestamp the record should not be displayed afterward, often "endtime"

$frontendUserGroupColumnName : string|null = null

Name of a column holding the uid of the front-end user group which is allowed to edit this record

$recordTypeColumnName : string|null = null

Name of a column holding the record type, example: "CType" in table "tt_content"

$isStatic : bool = false

True if TCA[$tableName]['ctrl']['is_static'] is true

$rootLevel : bool = false

Bool cast of TCA[$tableName]['ctrl']['rootLevel']

getClassName()

public getClassName() : string
Return values
string

getColumnMap()

public getColumnMap(string $propertyName) : ColumnMap|null
Parameters
$propertyName : string
Return values
ColumnMap|null

getCreationDateColumnName()

public getCreationDateColumnName() : string|null
Return values
string|null

getDeletedFlagColumnName()

public getDeletedFlagColumnName() : string|null
Return values
string|null

getDisabledFlagColumnName()

public getDisabledFlagColumnName() : string|null
Return values
string|null

getEndTimeColumnName()

public getEndTimeColumnName() : string|null
Return values
string|null

getFrontEndUserGroupColumnName()

public getFrontEndUserGroupColumnName() : string|null
Return values
string|null

getIsStatic()

public getIsStatic() : bool
Return values
bool

getLanguageIdColumnName()

public getLanguageIdColumnName() : string|null
Return values
string|null

getModificationDateColumnName()

public getModificationDateColumnName() : string|null
Return values
string|null

getRecordType()

public getRecordType() : string|null
Return values
string|null

getRecordTypeColumnName()

public getRecordTypeColumnName() : string|null
Return values
string|null

getRootLevel()

public getRootLevel() : bool
Return values
bool

getStartTimeColumnName()

public getStartTimeColumnName() : string|null
Return values
string|null

getSubclasses()

public getSubclasses() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTableName()

public getTableName() : string
Return values
string

getTranslationOriginColumnName()

public getTranslationOriginColumnName() : string|null
Return values
string|null

getTranslationOriginDiffSourceName()

public getTranslationOriginDiffSourceName() : string|null
Return values
string|null

isPersistableProperty()

public isPersistableProperty(string $propertyName) : bool
Parameters
$propertyName : string
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results