DataMap
A data map to map a single table configured in $TCA on a domain object.
only to be used within Extbase, not part of TYPO3 Core API.
Table of Contents
Properties
- $className : string
- The class name
- $columnMaps : array<string|int, mixed>
- An array of column maps configured in $TCA
- $creationDateColumnName : string
- $deletedFlagColumnName : string
- $disabledFlagColumnName : string
- $endTimeColumnName : string
- $frontendUserGroupColumnName : string
- $isStatic : bool
- $languageIdColumnName : string
- $modificationDateColumnName : string
- $pageIdColumnName : string
- $recordType : string|null
- The record type stored in the "type" field as configured in $TCA
- $recordTypeColumnName : string
- $rootLevel : bool
- $startTimeColumnName : string
- $subclasses : array<string|int, mixed>
- The subclasses of the current class
- $tableName : string
- The table name corresponding to the domain class configured in $TCA
- $translationOriginColumnName : string
- $translationOriginDiffSourceName : string
Methods
- __construct() : mixed
- Constructs this DataMap
- addColumnMap() : void
- Adds a given column map to the data map.
- getClassName() : string
- Returns the name of the class the column map represents
- getColumnMap() : ColumnMap|null
- Returns the column map corresponding to the given property name.
- getCreationDateColumnName() : string
- Returns the name of a column holding the creation date timestamp
- getDeletedFlagColumnName() : string|null
- Returns the name of a column indicating the 'deleted' state of the row
- getDisabledFlagColumnName() : string
- Returns the name of a column indicating the 'hidden' state of the row
- getEndTimeColumnName() : string
- Returns the name of a column holding the timestamp the record should not displayed afterwards
- getFrontEndUserGroupColumnName() : string
- Returns the name of a column holding the uid of the front-end user group which is allowed to edit this record
- getIsStatic() : bool
- getLanguageIdColumnName() : string
- Returns the name of a column holding the language id of the record.
- getModificationDateColumnName() : string
- Returns the name of a column holding the timestamp the record was modified
- getPageIdColumnName() : string
- Sets the name of a column holding the page id
- getRecordType() : string|null
- Returns the record type
- getRecordTypeColumnName() : string
- Sets the name of a column holding the record type
- getRootLevel() : bool
- getStartTimeColumnName() : string
- Returns the name of a column holding the timestamp the record should not displayed before
- getSubclasses() : array<string|int, mixed>
- Returns the subclasses
- getTableName() : string
- Returns the name of the table the column map represents
- getTranslationOriginColumnName() : string
- Returns the name of a column holding the the uid of the record which this record is a translation of.
- getTranslationOriginDiffSourceName() : string
- Returns the name of a column holding the diff data for the record which this record is a translation of.
- isPersistableProperty() : bool
- Returns TRUE if the property is persistable (configured in $TCA)
- setClassName() : mixed
- Sets the name of the class the column map represents
- setCreationDateColumnName() : mixed
- Sets the name of a column holding the creation date timestamp
- setDeletedFlagColumnName() : mixed
- Sets the name of a column indicating the 'deleted' state of the row
- setDisabledFlagColumnName() : mixed
- Sets the name of a column indicating the 'hidden' state of the row
- setEndTimeColumnName() : mixed
- Sets the name of a column holding the timestamp the record should not displayed afterwards
- setFrontEndUserGroupColumnName() : mixed
- Sets the name of a column holding the uid of the front-end user group which is allowed to edit this record
- setIsStatic() : mixed
- setLanguageIdColumnName() : mixed
- Sets the name of a column holding the language id of the record
- setModificationDateColumnName() : mixed
- Sets the name of a column holding the timestamp the record was modified
- setPageIdColumnName() : mixed
- Sets the name of a column holding the page id
- setRecordType() : mixed
- Sets the record type
- setRecordTypeColumnName() : mixed
- Sets the name of a column holding the record type
- setRootLevel() : mixed
- setStartTimeColumnName() : mixed
- Sets the name of a column holding the timestamp the record should not displayed before
- setSubclasses() : mixed
- Sets the subclasses
- setTableName() : mixed
- Sets the name of the table the column map represents
- setTranslationOriginColumnName() : mixed
- Sets the name of a column holding the the uid of the record which this record is a translation of.
- setTranslationOriginDiffSourceName() : mixed
- Sets the name of a column holding the the diff data for the record which this record is a translation of.
Properties
$className
The class name
protected
string
$className
$columnMaps
An array of column maps configured in $TCA
protected
array<string|int, mixed>
$columnMaps
= []
$creationDateColumnName
protected
string
$creationDateColumnName
$deletedFlagColumnName
protected
string
$deletedFlagColumnName
$disabledFlagColumnName
protected
string
$disabledFlagColumnName
$endTimeColumnName
protected
string
$endTimeColumnName
$frontendUserGroupColumnName
protected
string
$frontendUserGroupColumnName
$isStatic
protected
bool
$isStatic
= false
$languageIdColumnName
protected
string
$languageIdColumnName
$modificationDateColumnName
protected
string
$modificationDateColumnName
$pageIdColumnName
protected
string
$pageIdColumnName
$recordType
The record type stored in the "type" field as configured in $TCA
protected
string|null
$recordType
$recordTypeColumnName
protected
string
$recordTypeColumnName
$rootLevel
protected
bool
$rootLevel
= false
$startTimeColumnName
protected
string
$startTimeColumnName
$subclasses
The subclasses of the current class
protected
array<string|int, mixed>
$subclasses
= []
$tableName
The table name corresponding to the domain class configured in $TCA
protected
string
$tableName
$translationOriginColumnName
protected
string
$translationOriginColumnName
$translationOriginDiffSourceName
protected
string
$translationOriginDiffSourceName
Methods
__construct()
Constructs this DataMap
public
__construct(string $className, string $tableName[, string $recordType = null ][, array<string|int, mixed> $subclasses = [] ]) : mixed
Parameters
- $className : string
-
The class name
- $tableName : string
-
The table name
- $recordType : string = null
-
The record type
- $subclasses : array<string|int, mixed> = []
-
The subclasses
addColumnMap()
Adds a given column map to the data map.
public
addColumnMap(non-empty-string $propertyName, ColumnMap $columnMap) : void
Parameters
- $propertyName : non-empty-string
- $columnMap : ColumnMap
getClassName()
Returns the name of the class the column map represents
public
getClassName() : string
Return values
string —The class name
getColumnMap()
Returns the column map corresponding to the given property name.
public
getColumnMap(string $propertyName) : ColumnMap|null
Parameters
- $propertyName : string
Return values
ColumnMap|null —The column map or NULL if no corresponding column map was found.
getCreationDateColumnName()
Returns the name of a column holding the creation date timestamp
public
getCreationDateColumnName() : string
Return values
string —The field name
getDeletedFlagColumnName()
Returns the name of a column indicating the 'deleted' state of the row
public
getDeletedFlagColumnName() : string|null
Return values
string|null —The field name
getDisabledFlagColumnName()
Returns the name of a column indicating the 'hidden' state of the row
public
getDisabledFlagColumnName() : string
Return values
string —The field name
getEndTimeColumnName()
Returns the name of a column holding the timestamp the record should not displayed afterwards
public
getEndTimeColumnName() : string
Return values
string —The field name
getFrontEndUserGroupColumnName()
Returns the name of a column holding the uid of the front-end user group which is allowed to edit this record
public
getFrontEndUserGroupColumnName() : string
Return values
string —The field name
getIsStatic()
public
getIsStatic() : bool
Return values
boolgetLanguageIdColumnName()
Returns the name of a column holding the language id of the record.
public
getLanguageIdColumnName() : string
Return values
string —The field name
getModificationDateColumnName()
Returns the name of a column holding the timestamp the record was modified
public
getModificationDateColumnName() : string
Return values
string —The field name
getPageIdColumnName()
Sets the name of a column holding the page id
public
getPageIdColumnName() : string
Return values
string —The field name
getRecordType()
Returns the record type
public
getRecordType() : string|null
Return values
string|null —The record type
getRecordTypeColumnName()
Sets the name of a column holding the record type
public
getRecordTypeColumnName() : string
Return values
string —The field name
getRootLevel()
public
getRootLevel() : bool
Return values
boolgetStartTimeColumnName()
Returns the name of a column holding the timestamp the record should not displayed before
public
getStartTimeColumnName() : string
Return values
string —The field name
getSubclasses()
Returns the subclasses
public
getSubclasses() : array<string|int, mixed>
Return values
array<string|int, mixed> —The subclasses
getTableName()
Returns the name of the table the column map represents
public
getTableName() : string
Return values
string —The table name
getTranslationOriginColumnName()
Returns the name of a column holding the the uid of the record which this record is a translation of.
public
getTranslationOriginColumnName() : string
Return values
string —The field name
getTranslationOriginDiffSourceName()
Returns the name of a column holding the diff data for the record which this record is a translation of.
public
getTranslationOriginDiffSourceName() : string
Return values
string —The field name
isPersistableProperty()
Returns TRUE if the property is persistable (configured in $TCA)
public
isPersistableProperty(string $propertyName) : bool
Parameters
- $propertyName : string
-
The property name
Return values
bool —TRUE if the property is persistable (configured in $TCA)
setClassName()
Sets the name of the class the column map represents
public
setClassName(string $className) : mixed
Parameters
- $className : string
setCreationDateColumnName()
Sets the name of a column holding the creation date timestamp
public
setCreationDateColumnName(string $creationDateColumnName) : mixed
Parameters
- $creationDateColumnName : string
-
The field name
setDeletedFlagColumnName()
Sets the name of a column indicating the 'deleted' state of the row
public
setDeletedFlagColumnName(string $deletedFlagColumnName) : mixed
Parameters
- $deletedFlagColumnName : string
-
The field name
setDisabledFlagColumnName()
Sets the name of a column indicating the 'hidden' state of the row
public
setDisabledFlagColumnName(string $disabledFlagColumnName) : mixed
Parameters
- $disabledFlagColumnName : string
-
The field name
setEndTimeColumnName()
Sets the name of a column holding the timestamp the record should not displayed afterwards
public
setEndTimeColumnName(string $endTimeColumnName) : mixed
Parameters
- $endTimeColumnName : string
-
The field name
setFrontEndUserGroupColumnName()
Sets the name of a column holding the uid of the front-end user group which is allowed to edit this record
public
setFrontEndUserGroupColumnName(string $frontendUserGroupColumnName) : mixed
Parameters
- $frontendUserGroupColumnName : string
-
The field name
setIsStatic()
public
setIsStatic(bool $isStatic) : mixed
Parameters
- $isStatic : bool
setLanguageIdColumnName()
Sets the name of a column holding the language id of the record
public
setLanguageIdColumnName(string $languageIdColumnName) : mixed
Parameters
- $languageIdColumnName : string
-
The field name
setModificationDateColumnName()
Sets the name of a column holding the timestamp the record was modified
public
setModificationDateColumnName(string $modificationDateColumnName) : mixed
Parameters
- $modificationDateColumnName : string
-
The field name
setPageIdColumnName()
Sets the name of a column holding the page id
public
setPageIdColumnName(string $pageIdColumnName) : mixed
Parameters
- $pageIdColumnName : string
-
The field name
setRecordType()
Sets the record type
public
setRecordType(string|null $recordType) : mixed
Parameters
- $recordType : string|null
-
The record type
setRecordTypeColumnName()
Sets the name of a column holding the record type
public
setRecordTypeColumnName(string $recordTypeColumnName) : mixed
Parameters
- $recordTypeColumnName : string
-
The field name
setRootLevel()
public
setRootLevel(bool $rootLevel) : mixed
Parameters
- $rootLevel : bool
setStartTimeColumnName()
Sets the name of a column holding the timestamp the record should not displayed before
public
setStartTimeColumnName(string $startTimeColumnName) : mixed
Parameters
- $startTimeColumnName : string
-
The field name
setSubclasses()
Sets the subclasses
public
setSubclasses(array<string|int, mixed> $subclasses) : mixed
Parameters
- $subclasses : array<string|int, mixed>
-
An array of subclasses
setTableName()
Sets the name of the table the column map represents
public
setTableName(string $tableName) : mixed
Parameters
- $tableName : string
setTranslationOriginColumnName()
Sets the name of a column holding the the uid of the record which this record is a translation of.
public
setTranslationOriginColumnName(string $translationOriginColumnName) : mixed
Parameters
- $translationOriginColumnName : string
-
The field name
setTranslationOriginDiffSourceName()
Sets the name of a column holding the the diff data for the record which this record is a translation of.
public
setTranslationOriginDiffSourceName(string $translationOriginDiffSourceName) : mixed
Parameters
- $translationOriginDiffSourceName : string
-
The field name