‪TYPO3CMS  11.5
TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap Class Reference

Public Member Functions

 __construct (string $columnName, string $propertyName)
 
 setTypeOfRelation (string $typeOfRelation)
 
string getTypeOfRelation ()
 
string getPropertyName ()
 
string getColumnName ()
 
 setChildTableName (?string $childTableName)
 
string null getChildTableName ()
 
 setChildTableDefaultSortings (?string $childTableDefaultSortings)
 
 getChildTableDefaultSortings ()
 
 setChildSortByFieldName (?string $childSortByFieldName)
 
string null getChildSortByFieldName ()
 
 setRelationTableName (?string $relationTableName)
 
string null getRelationTableName ()
 
 setRelationTablePageIdColumnName (string $relationTablePageIdColumnName)
 
string null getRelationTablePageIdColumnName ()
 
 setRelationTableMatchFields (?array $relationTableMatchFields)
 
array null getRelationTableMatchFields ()
 
 setRelationTableInsertFields (array $relationTableInsertFields)
 
array null getRelationTableInsertFields ()
 
 setParentKeyFieldName (?string $parentKeyFieldName)
 
string null getParentKeyFieldName ()
 
 setParentTableFieldName (?string $parentTableFieldName)
 
string null getParentTableFieldName ()
 
 setChildKeyFieldName (string $childKeyFieldName)
 
string null getChildKeyFieldName ()
 
 setDateTimeStorageFormat (?string $dateTimeStorageFormat)
 
string null getDateTimeStorageFormat ()
 
 setInternalType (TableColumnSubType $internalType)
 
TableColumnSubType null getInternalType ()
 
 setType (TableColumnType $type)
 
TableColumnType null getType ()
 

Public Attributes

const RELATION_NONE = 'RELATION_NONE'
 
const RELATION_HAS_ONE = 'RELATION_HAS_ONE'
 
const RELATION_HAS_MANY = 'RELATION_HAS_MANY'
 
const RELATION_BELONGS_TO_MANY = 'RELATION_BELONGS_TO_MANY'
 
const RELATION_HAS_AND_BELONGS_TO_MANY = 'RELATION_HAS_AND_BELONGS_TO_MANY'
 

Private Attributes

string $propertyName
 
string $columnName
 
string null $typeOfRelation
 
string null $childTableName
 
string $childTableDefaultSortings = null
 
string null $childSortByFieldName
 
string null $relationTableName
 
string null $relationTablePageIdColumnName
 
array null $relationTableMatchFields
 
array null $relationTableInsertFields
 
string null $relationTableWhereStatement
 
string null $parentKeyFieldName
 
string null $parentTableFieldName
 
string null $childKeyFieldName
 
string null $dateTimeStorageFormat
 
TableColumnType null $type
 
TableColumnSubType null $internalType
 

Detailed Description

A column map to map a column configured in $TCA on a property of a domain object.

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

Definition at line 27 of file ColumnMap.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::__construct ( string  $columnName,
string  $propertyName 
)

Constructs a Column Map

Parameters
string$columnName‪The column name
string$propertyName‪The property name

Definition at line 188 of file ColumnMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$columnName, and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$propertyName.

Member Function Documentation

◆ getChildKeyFieldName()

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getChildKeyFieldName ( )

◆ getChildSortByFieldName()

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getChildSortByFieldName ( )
Returns
‪string|null

Definition at line 267 of file ColumnMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$childSortByFieldName.

◆ getChildTableDefaultSortings()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getChildTableDefaultSortings ( )

◆ getChildTableName()

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getChildTableName ( )

◆ getColumnName()

◆ getDateTimeStorageFormat()

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getDateTimeStorageFormat ( )

◆ getInternalType()

TableColumnSubType null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getInternalType ( )
Returns
‪TableColumnSubType|null

Definition at line 411 of file ColumnMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$internalType.

◆ getParentKeyFieldName()

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getParentKeyFieldName ( )

◆ getParentTableFieldName()

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getParentTableFieldName ( )

◆ getPropertyName()

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getPropertyName ( )

◆ getRelationTableInsertFields()

array null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getRelationTableInsertFields ( )
Returns
‪array|null

Definition at line 331 of file ColumnMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$relationTableInsertFields.

◆ getRelationTableMatchFields()

array null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getRelationTableMatchFields ( )
Returns
‪array|null

Definition at line 315 of file ColumnMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$relationTableMatchFields.

◆ getRelationTableName()

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getRelationTableName ( )

◆ getRelationTablePageIdColumnName()

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getRelationTablePageIdColumnName ( )

◆ getType()

TableColumnType null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getType ( )
Returns
‪TableColumnType|null

Definition at line 427 of file ColumnMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$type.

◆ getTypeOfRelation()

◆ setChildKeyFieldName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setChildKeyFieldName ( string  $childKeyFieldName)

◆ setChildSortByFieldName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setChildSortByFieldName ( ?string  $childSortByFieldName)

◆ setChildTableDefaultSortings()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setChildTableDefaultSortings ( ?string  $childTableDefaultSortings)

◆ setChildTableName()

◆ setDateTimeStorageFormat()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setDateTimeStorageFormat ( ?string  $dateTimeStorageFormat)

◆ setInternalType()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setInternalType ( TableColumnSubType  $internalType)
Parameters
TableColumnSubType$internalType

Definition at line 403 of file ColumnMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$internalType.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory\setType().

◆ setParentKeyFieldName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setParentKeyFieldName ( ?string  $parentKeyFieldName)

◆ setParentTableFieldName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setParentTableFieldName ( ?string  $parentTableFieldName)

◆ setRelationTableInsertFields()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setRelationTableInsertFields ( array  $relationTableInsertFields)

◆ setRelationTableMatchFields()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setRelationTableMatchFields ( ?array  $relationTableMatchFields)

◆ setRelationTableName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setRelationTableName ( ?string  $relationTableName)

◆ setRelationTablePageIdColumnName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setRelationTablePageIdColumnName ( string  $relationTablePageIdColumnName)

◆ setType()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setType ( TableColumnType  $type)

◆ setTypeOfRelation()

Member Data Documentation

◆ $childKeyFieldName

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$childKeyFieldName
private

todo: Check if this property should support null. If not, set default value. The name of the field holding the children key

Definition at line 160 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getChildKeyFieldName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setChildKeyFieldName().

◆ $childSortByFieldName

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$childSortByFieldName
private

todo: Check if this property should support null. If not, set default value. The name of the field the results from the child's table are sorted by

See also
https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ColumnsConfig/Type/Inline/Properties/ForeignSortby.html

Definition at line 94 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getChildSortByFieldName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setChildSortByFieldName().

◆ $childTableDefaultSortings

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$childTableDefaultSortings = null
private

◆ $childTableName

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$childTableName
private

◆ $columnName

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$columnName
private

◆ $dateTimeStorageFormat

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$dateTimeStorageFormat
private

todo: Check if this property should support null. If not, set default value. Alternative format for storing DataTime formats (instead of using unix-time stamps). Allowed values are 'date', 'datetime' and 'time'

See also
https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ColumnsConfig/Type/Datetime/Properties/DbType.html

Definition at line 170 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getDateTimeStorageFormat(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setDateTimeStorageFormat().

◆ $internalType

TableColumnSubType null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$internalType
private

todo: Check if this property should support null. If not, set default value.

Definition at line 180 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getInternalType(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setInternalType().

◆ $parentKeyFieldName

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$parentKeyFieldName
private

todo: Check if this property should support null. If not, set default value. The name of the field holding the parents key

See also
https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ColumnsConfig/Type/Inline/Properties/ForeignField.html

Definition at line 145 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getParentKeyFieldName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setParentKeyFieldName().

◆ $parentTableFieldName

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$parentTableFieldName
private

todo: Check if this property should support null. If not, set default value. The name of the field holding the name of the table of the parent's records

See also
https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ColumnsConfig/Type/Inline/Properties/ForeignTableField.html

Definition at line 153 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getParentTableFieldName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setParentTableFieldName().

◆ $propertyName

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$propertyName
private

◆ $relationTableInsertFields

array null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$relationTableInsertFields
private

◆ $relationTableMatchFields

array null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$relationTableMatchFields
private

◆ $relationTableName

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$relationTableName
private

◆ $relationTablePageIdColumnName

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$relationTablePageIdColumnName
private

todo: Check if this property should support null. If not, set default value. The name of the column of the relation table holding the page id

Definition at line 109 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getRelationTablePageIdColumnName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setRelationTablePageIdColumnName().

◆ $relationTableWhereStatement

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$relationTableWhereStatement
private

todo: Check if this property should support null. If not, set default value.

todo: Check if this property should be dropped as it's not in use. Basically we have to answer the question if todo: MM_table_where should have any impact on Extbase at all. The where clause to narrow down the selected relation table records

See also
https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ColumnsConfig/Type/Group/Properties/Mm.html#confval-MM_insert_fields(type=%3Egroup)

Definition at line 137 of file ColumnMap.php.

◆ $type

TableColumnType null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$type
private

todo: Check if this property should support null. If not, set default value.

Definition at line 175 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getType(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setType().

◆ $typeOfRelation

string null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$typeOfRelation
private

todo: Check if this property should support null. If not, set default value. The type of relation

Definition at line 71 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getTypeOfRelation(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setTypeOfRelation().

◆ RELATION_BELONGS_TO_MANY

const TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::RELATION_BELONGS_TO_MANY = 'RELATION_BELONGS_TO_MANY'

Definition at line 47 of file ColumnMap.php.

◆ RELATION_HAS_AND_BELONGS_TO_MANY

◆ RELATION_HAS_MANY

◆ RELATION_HAS_ONE

◆ RELATION_NONE

const TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::RELATION_NONE = 'RELATION_NONE'