TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap Class Reference

Public Member Functions

 __construct ($className, $tableName, $recordType=null, array $subclasses=[])
 
 setClassName ($className)
 
 getClassName ()
 
 setTableName ($tableName)
 
 getTableName ()
 
 setRecordType ($recordType)
 
 getRecordType ()
 
 setSubclasses (array $subclasses)
 
 getSubclasses ()
 
 addColumnMap (ColumnMap $columnMap)
 
 getColumnMap ($propertyName)
 
 isPersistableProperty ($propertyName)
 
 setPageIdColumnName ($pageIdColumnName)
 
 getPageIdColumnName ()
 
 setLanguageIdColumnName ($languageIdColumnName)
 
 getLanguageIdColumnName ()
 
 setTranslationOriginColumnName ($translationOriginColumnName)
 
 getTranslationOriginColumnName ()
 
 setTranslationOriginDiffSourceName ($translationOriginDiffSourceName)
 
 getTranslationOriginDiffSourceName ()
 
 setModificationDateColumnName ($modificationDateColumnName)
 
 getModificationDateColumnName ()
 
 setCreationDateColumnName ($creationDateColumnName)
 
 getCreationDateColumnName ()
 
 setCreatorColumnName ($creatorColumnName)
 
 getCreatorColumnName ()
 
 setDeletedFlagColumnName ($deletedFlagColumnName)
 
 getDeletedFlagColumnName ()
 
 setDisabledFlagColumnName ($disabledFlagColumnName)
 
 getDisabledFlagColumnName ()
 
 setStartTimeColumnName ($startTimeColumnName)
 
 getStartTimeColumnName ()
 
 setEndTimeColumnName ($endTimeColumnName)
 
 getEndTimeColumnName ()
 
 setFrontEndUserGroupColumnName ($frontendUserGroupColumnName)
 
 getFrontEndUserGroupColumnName ()
 
 setRecordTypeColumnName ($recordTypeColumnName)
 
 getRecordTypeColumnName ()
 
 setIsStatic ($isStatic)
 
 getIsStatic ()
 
 setRootLevel ($rootLevel)
 
 getRootLevel ()
 

Protected Attributes

 $className
 
 $tableName
 
 $recordType
 
 $subclasses = []
 
 $columnMaps = []
 
 $pageIdColumnName
 
 $languageIdColumnName
 
 $translationOriginColumnName
 
 $translationOriginDiffSourceName
 
 $modificationDateColumnName
 
 $creationDateColumnName
 
 $creatorColumnName
 
 $deletedFlagColumnName
 
 $disabledFlagColumnName
 
 $startTimeColumnName
 
 $endTimeColumnName
 
 $frontendUserGroupColumnName
 
 $recordTypeColumnName
 
 $isStatic = false
 
 $rootLevel = false
 

Detailed Description

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

Definition at line 20 of file DataMap.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::__construct (   $className,
  $tableName,
  $recordType = null,
array  $subclasses = [] 
)

Member Function Documentation

◆ addColumnMap()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::addColumnMap ( ColumnMap  $columnMap)

Adds a given column map to the data map.

Parameters
\TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap$columnMapThe column map
Returns
void

Definition at line 238 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getPropertyName().

◆ getClassName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getClassName ( )

Returns the name of the class the column map represents

Returns
string The class name

Definition at line 164 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$className.

◆ getColumnMap()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getColumnMap (   $propertyName)

Returns the column map corresponding to the given property name.

Parameters
string$propertyName
Returns
|NULL The column map or NULL if no corresponding column map was found.

Definition at line 249 of file DataMap.php.

◆ getCreationDateColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getCreationDateColumnName ( )

Returns the name of a column holding the creation date timestamp

Returns
string The field name

Definition at line 386 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$creationDateColumnName.

◆ getCreatorColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getCreatorColumnName ( )

Returns the name of a column holding the uid of the back-end user who created this record

Returns
string The field name

Definition at line 407 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$creatorColumnName.

◆ getDeletedFlagColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getDeletedFlagColumnName ( )

Returns the name of a column indicating the 'deleted' state of the row

Returns
string The field name

Definition at line 428 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$deletedFlagColumnName.

◆ getDisabledFlagColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getDisabledFlagColumnName ( )

Returns the name of a column indicating the 'hidden' state of the row

Returns
string The field name

Definition at line 449 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$disabledFlagColumnName.

◆ getEndTimeColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getEndTimeColumnName ( )

Returns the name of a column holding the timestamp the record should not displayed afterwards

Returns
string The field name

Definition at line 491 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$endTimeColumnName.

◆ getFrontEndUserGroupColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getFrontEndUserGroupColumnName ( )

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

Returns
string The field name

Definition at line 512 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$frontendUserGroupColumnName.

◆ getIsStatic()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getIsStatic ( )
Returns
bool

Definition at line 549 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$isStatic.

◆ getLanguageIdColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getLanguageIdColumnName ( )

Returns the name of a column holding the language id of the record.

Returns
string The field name

Definition at line 302 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$languageIdColumnName.

◆ getModificationDateColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getModificationDateColumnName ( )

Returns the name of a column holding the timestamp the record was modified

Returns
string The field name

Definition at line 365 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$modificationDateColumnName.

◆ getPageIdColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getPageIdColumnName ( )

Sets the name of a column holding the page id

Returns
string The field name

Definition at line 281 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$pageIdColumnName.

◆ getRecordType()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getRecordType ( )

Returns the record type

Returns
string The record type

Definition at line 206 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$recordType.

◆ getRecordTypeColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getRecordTypeColumnName ( )

Sets the name of a column holding the record type

Returns
string The field name

Definition at line 533 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$recordTypeColumnName.

◆ getRootLevel()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getRootLevel ( )
Returns
bool

Definition at line 565 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$rootLevel.

◆ getStartTimeColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getStartTimeColumnName ( )

Returns the name of a column holding the timestamp the record should not displayed before

Returns
string The field name

Definition at line 470 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$startTimeColumnName.

◆ getSubclasses()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getSubclasses ( )

Returns the subclasses

Returns
array The subclasses

Definition at line 227 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$subclasses.

◆ getTableName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getTableName ( )

Returns the name of the table the column map represents

Returns
string The table name

Definition at line 185 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$tableName.

◆ getTranslationOriginColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getTranslationOriginColumnName ( )

Returns the name of a column holding the the uid of the record which this record is a translation of.

Returns
string The field name

Definition at line 323 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$translationOriginColumnName.

◆ getTranslationOriginDiffSourceName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::getTranslationOriginDiffSourceName ( )

Returns the name of a column holding the diff data for the record which this record is a translation of.

Returns
string The field name

Definition at line 344 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$translationOriginDiffSourceName.

◆ isPersistableProperty()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::isPersistableProperty (   $propertyName)

Returns TRUE if the property is persistable (configured in $TCA)

Parameters
string$propertyNameThe property name
Returns
bool TRUE if the property is persistable (configured in $TCA)

Definition at line 260 of file DataMap.php.

◆ setClassName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setClassName (   $className)

Sets the name of the class the colum map represents

Parameters
string$className
Returns
void

Definition at line 154 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$className.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\__construct().

◆ setCreationDateColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setCreationDateColumnName (   $creationDateColumnName)

Sets the name of a column holding the creation date timestamp

Parameters
string$creationDateColumnNameThe field name
Returns
void

Definition at line 376 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$creationDateColumnName.

◆ setCreatorColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setCreatorColumnName (   $creatorColumnName)

Sets the name of a column holding the uid of the back-end user who created this record

Parameters
string$creatorColumnNameThe field name
Returns
void

Definition at line 397 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$creatorColumnName.

◆ setDeletedFlagColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setDeletedFlagColumnName (   $deletedFlagColumnName)

Sets the name of a column indicating the 'deleted' state of the row

Parameters
string$deletedFlagColumnNameThe field name
Returns
void

Definition at line 418 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$deletedFlagColumnName.

◆ setDisabledFlagColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setDisabledFlagColumnName (   $disabledFlagColumnName)

Sets the name of a column indicating the 'hidden' state of the row

Parameters
string$disabledFlagColumnNameThe field name
Returns
void

Definition at line 439 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$disabledFlagColumnName.

◆ setEndTimeColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setEndTimeColumnName (   $endTimeColumnName)

Sets the name of a column holding the timestamp the record should not displayed afterwards

Parameters
string$endTimeColumnNameThe field name
Returns
void

Definition at line 481 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$endTimeColumnName.

◆ setFrontEndUserGroupColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setFrontEndUserGroupColumnName (   $frontendUserGroupColumnName)

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

Parameters
string$frontendUserGroupColumnNameThe field name
Returns
void

Definition at line 502 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$frontendUserGroupColumnName.

◆ setIsStatic()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setIsStatic (   $isStatic)
Parameters
bool$isStatic

Definition at line 541 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$isStatic.

◆ setLanguageIdColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setLanguageIdColumnName (   $languageIdColumnName)

Sets the name of a column holding the language id of the record

Parameters
string$languageIdColumnNameThe field name
Returns
void

Definition at line 292 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$languageIdColumnName.

◆ setModificationDateColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setModificationDateColumnName (   $modificationDateColumnName)

Sets the name of a column holding the timestamp the record was modified

Parameters
string$modificationDateColumnNameThe field name
Returns
void

Definition at line 355 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$modificationDateColumnName.

◆ setPageIdColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setPageIdColumnName (   $pageIdColumnName)

Sets the name of a column holding the page id

Parameters
string$pageIdColumnNameThe field name
Returns
void

Definition at line 271 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$pageIdColumnName.

◆ setRecordType()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setRecordType (   $recordType)

Sets the record type

Parameters
string$recordTypeThe record type
Returns
void

Definition at line 196 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$recordType.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\__construct().

◆ setRecordTypeColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setRecordTypeColumnName (   $recordTypeColumnName)

Sets the name of a column holding the record type

Parameters
string$recordTypeColumnNameThe field name
Returns
void

Definition at line 523 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$recordTypeColumnName.

◆ setRootLevel()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setRootLevel (   $rootLevel)
Parameters
bool$rootLevel

Definition at line 557 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$rootLevel.

◆ setStartTimeColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setStartTimeColumnName (   $startTimeColumnName)

Sets the name of a column holding the timestamp the record should not displayed before

Parameters
string$startTimeColumnNameThe field name
Returns
void

Definition at line 460 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$startTimeColumnName.

◆ setSubclasses()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setSubclasses ( array  $subclasses)

Sets the subclasses

Parameters
array$subclassesAn array of subclasses
Returns
void

Definition at line 217 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$subclasses.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\__construct().

◆ setTableName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setTableName (   $tableName)

Sets the name of the table the colum map represents

Parameters
string$tableName
Returns
void

Definition at line 175 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$tableName.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\__construct().

◆ setTranslationOriginColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setTranslationOriginColumnName (   $translationOriginColumnName)

Sets the name of a column holding the the uid of the record which this record is a translation of.

Parameters
string$translationOriginColumnNameThe field name
Returns
void

Definition at line 313 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$translationOriginColumnName.

◆ setTranslationOriginDiffSourceName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::setTranslationOriginDiffSourceName (   $translationOriginDiffSourceName)

Sets the name of a column holding the the diff data for the record which this record is a translation of.

Parameters
string$translationOriginDiffSourceNameThe field name
Returns
void

Definition at line 334 of file DataMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\$translationOriginDiffSourceName.

Member Data Documentation

◆ $className

◆ $columnMaps

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$columnMaps = []
protected

Definition at line 55 of file DataMap.php.

◆ $creationDateColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$creationDateColumnName
protected

◆ $creatorColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$creatorColumnName
protected

◆ $deletedFlagColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$deletedFlagColumnName
protected

◆ $disabledFlagColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$disabledFlagColumnName
protected

◆ $endTimeColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$endTimeColumnName
protected

◆ $frontendUserGroupColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$frontendUserGroupColumnName
protected

◆ $isStatic

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$isStatic = false
protected

◆ $languageIdColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$languageIdColumnName
protected

◆ $modificationDateColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$modificationDateColumnName
protected

◆ $pageIdColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$pageIdColumnName
protected

◆ $recordType

◆ $recordTypeColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$recordTypeColumnName
protected

◆ $rootLevel

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$rootLevel = false
protected

◆ $startTimeColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$startTimeColumnName
protected

◆ $subclasses

◆ $tableName

◆ $translationOriginColumnName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$translationOriginColumnName
protected

◆ $translationOriginDiffSourceName

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap::$translationOriginDiffSourceName
protected