TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
DataMap Class Reference

Public Member Functions

 __construct ($className, $tableName, $recordType=null, array $subclasses=array())
 
 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 = array()
 
 $columnMaps = array()
 
 $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 (   $className,
  $tableName,
  $recordType = null,
array  $subclasses = array() 
)

Constructs this DataMap

Parameters
string$classNameThe class name
string$tableNameThe table name
string$recordTypeThe record type
array$subclassesThe subclasses

Definition at line 140 of file DataMap.php.

References DataMap\$className, DataMap\$recordType, DataMap\$subclasses, DataMap\$tableName, DataMap\setClassName(), DataMap\setRecordType(), DataMap\setSubclasses(), and DataMap\setTableName().

Member Function Documentation

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 ColumnMap\getPropertyName().

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 DataMap\$className.

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 ( )

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 DataMap\$creationDateColumnName.

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 DataMap\$creatorColumnName.

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 DataMap\$deletedFlagColumnName.

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 DataMap\$disabledFlagColumnName.

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 DataMap\$endTimeColumnName.

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 DataMap\$frontendUserGroupColumnName.

getIsStatic ( )
Returns
bool

Definition at line 549 of file DataMap.php.

References DataMap\$isStatic.

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 DataMap\$languageIdColumnName.

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 DataMap\$modificationDateColumnName.

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 DataMap\$pageIdColumnName.

getRecordType ( )

Returns the record type

Returns
string The record type

Definition at line 206 of file DataMap.php.

References DataMap\$recordType.

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 DataMap\$recordTypeColumnName.

getRootLevel ( )
Returns
bool

Definition at line 565 of file DataMap.php.

References DataMap\$rootLevel.

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 DataMap\$startTimeColumnName.

getSubclasses ( )

Returns the subclasses

Returns
array The subclasses

Definition at line 227 of file DataMap.php.

References DataMap\$subclasses.

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 DataMap\$tableName.

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 DataMap\$translationOriginColumnName.

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 DataMap\$translationOriginDiffSourceName.

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 (   $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 DataMap\$className.

Referenced by DataMap\__construct().

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 DataMap\$creationDateColumnName.

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 DataMap\$creatorColumnName.

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 DataMap\$deletedFlagColumnName.

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 DataMap\$disabledFlagColumnName.

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 DataMap\$endTimeColumnName.

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 DataMap\$frontendUserGroupColumnName.

setIsStatic (   $isStatic)
Parameters
bool$isStatic

Definition at line 541 of file DataMap.php.

References DataMap\$isStatic.

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 DataMap\$languageIdColumnName.

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 DataMap\$modificationDateColumnName.

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 DataMap\$pageIdColumnName.

setRecordType (   $recordType)

Sets the record type

Parameters
string$recordTypeThe record type
Returns
void

Definition at line 196 of file DataMap.php.

References DataMap\$recordType.

Referenced by DataMap\__construct().

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 DataMap\$recordTypeColumnName.

setRootLevel (   $rootLevel)
Parameters
bool$rootLevel

Definition at line 557 of file DataMap.php.

References DataMap\$rootLevel.

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 DataMap\$startTimeColumnName.

setSubclasses ( array  $subclasses)

Sets the subclasses

Parameters
array$subclassesAn array of subclasses
Returns
void

Definition at line 217 of file DataMap.php.

References DataMap\$subclasses.

Referenced by DataMap\__construct().

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 DataMap\$tableName.

Referenced by DataMap\__construct().

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 DataMap\$translationOriginColumnName.

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 DataMap\$translationOriginDiffSourceName.

Member Data Documentation

$className
protected

Definition at line 27 of file DataMap.php.

Referenced by DataMap\__construct(), DataMap\getClassName(), and DataMap\setClassName().

$columnMaps = array()
protected

Definition at line 55 of file DataMap.php.

$creationDateColumnName
protected

Definition at line 85 of file DataMap.php.

Referenced by DataMap\getCreationDateColumnName(), and DataMap\setCreationDateColumnName().

$creatorColumnName
protected

Definition at line 90 of file DataMap.php.

Referenced by DataMap\getCreatorColumnName(), and DataMap\setCreatorColumnName().

$deletedFlagColumnName
protected

Definition at line 95 of file DataMap.php.

Referenced by DataMap\getDeletedFlagColumnName(), and DataMap\setDeletedFlagColumnName().

$disabledFlagColumnName
protected

Definition at line 100 of file DataMap.php.

Referenced by DataMap\getDisabledFlagColumnName(), and DataMap\setDisabledFlagColumnName().

$endTimeColumnName
protected

Definition at line 110 of file DataMap.php.

Referenced by DataMap\getEndTimeColumnName(), and DataMap\setEndTimeColumnName().

$frontendUserGroupColumnName
protected

Definition at line 115 of file DataMap.php.

Referenced by DataMap\getFrontEndUserGroupColumnName(), and DataMap\setFrontEndUserGroupColumnName().

$isStatic = false
protected

Definition at line 125 of file DataMap.php.

Referenced by DataMap\getIsStatic(), and DataMap\setIsStatic().

$languageIdColumnName
protected

Definition at line 65 of file DataMap.php.

Referenced by DataMap\getLanguageIdColumnName(), and DataMap\setLanguageIdColumnName().

$modificationDateColumnName
protected

Definition at line 80 of file DataMap.php.

Referenced by DataMap\getModificationDateColumnName(), and DataMap\setModificationDateColumnName().

$pageIdColumnName
protected

Definition at line 60 of file DataMap.php.

Referenced by DataMap\getPageIdColumnName(), and DataMap\setPageIdColumnName().

$recordType
protected

Definition at line 41 of file DataMap.php.

Referenced by DataMap\__construct(), DataMap\getRecordType(), and DataMap\setRecordType().

$recordTypeColumnName
protected

Definition at line 120 of file DataMap.php.

Referenced by DataMap\getRecordTypeColumnName(), and DataMap\setRecordTypeColumnName().

$rootLevel = false
protected

Definition at line 130 of file DataMap.php.

Referenced by DataMap\getRootLevel(), and DataMap\setRootLevel().

$startTimeColumnName
protected

Definition at line 105 of file DataMap.php.

Referenced by DataMap\getStartTimeColumnName(), and DataMap\setStartTimeColumnName().

$subclasses = array()
protected

Definition at line 48 of file DataMap.php.

Referenced by DataMap\__construct(), DataMap\getSubclasses(), and DataMap\setSubclasses().

$tableName
protected

Definition at line 34 of file DataMap.php.

Referenced by DataMap\__construct(), DataMap\getTableName(), and DataMap\setTableName().

$translationOriginColumnName
protected

Definition at line 70 of file DataMap.php.

Referenced by DataMap\getTranslationOriginColumnName(), and DataMap\setTranslationOriginColumnName().

$translationOriginDiffSourceName
protected

Definition at line 75 of file DataMap.php.

Referenced by DataMap\getTranslationOriginDiffSourceName(), and DataMap\setTranslationOriginDiffSourceName().

Generated on Wed Nov 11 2015 01:52:35 for TYPO3 by   doxygen 1.8.3