Public Types
enum	Relation { HAS_AND_BELONGS_TO_MANY }

Public Member Functions
	__construct (string $columnName)

	setTypeOfRelation (ColumnMap\Relation $typeOfRelation)

	getTypeOfRelation ()

	getColumnName ()

	setChildTableName (?string $childTableName)

	getChildTableName ()

	setChildTableDefaultSortings (?string $childTableDefaultSortings)

	getChildTableDefaultSortings ()

	setChildSortByFieldName (?string $childSortByFieldName)

	getChildSortByFieldName ()

	setRelationTableName (?string $relationTableName)

	getRelationTableName ()

	setRelationTableMatchFields (?array $relationTableMatchFields)

	getRelationTableMatchFields ()

	setParentKeyFieldName (?string $parentKeyFieldName)

	getParentKeyFieldName ()

	setParentTableFieldName (?string $parentTableFieldName)

	getParentTableFieldName ()

	setChildKeyFieldName (string $childKeyFieldName)

	getChildKeyFieldName ()

	setDateTimeStorageFormat (?string $dateTimeStorageFormat)

	getDateTimeStorageFormat ()

	setType (TableColumnType $type)

	getType ()

Private Attributes
string	$columnName

ColumnMap Relation	$typeOfRelation = ColumnMap\Relation::NONE

string null	$childTableName

string	$childTableDefaultSortings = null

string null	$childSortByFieldName

string null	$relationTableName

array null	$relationTableMatchFields

string null	$parentKeyFieldName

string null	$parentTableFieldName

string null	$childKeyFieldName

string null	$dateTimeStorageFormat

TableColumnType	$type = TableColumnType::INPUT

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 26 of file ColumnMap.php.

Member Enumeration Documentation

◆ Relation

enum TYPO3::CMS::Extbase::Persistence::Generic::Mapper::ColumnMap::Relation

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

Enumerator
HAS_AND_BELONGS_TO_MANY

Definition at line 23 of file Relation.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructs a Column Map

Parameters

string $columnName ‪The column name

Definition at line 116 of file ColumnMap.php.

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

Member Function Documentation

◆ getChildKeyFieldName()

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

Definition at line 212 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getSource().

◆ getChildSortByFieldName()

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

Definition at line 162 of file ColumnMap.php.

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

◆ getChildTableDefaultSortings()

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

Definition at line 152 of file ColumnMap.php.

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

◆ getChildTableName()

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

Definition at line 142 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getSource().

◆ getColumnName()

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

Definition at line 132 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\convertPropertyNameToColumnName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\resolveRelationValuesOfField().

◆ getDateTimeStorageFormat()

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

Definition at line 222 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPlainValue(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\thawObjectProperty().

◆ getParentKeyFieldName()

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

Definition at line 192 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\propertyMapsByForeignKey().

◆ getParentTableFieldName()

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

Definition at line 202 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint().

◆ getRelationTableMatchFields()

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

Definition at line 182 of file ColumnMap.php.

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

◆ getRelationTableName()

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

Definition at line 172 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getSource().

◆ getType()

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

Definition at line 232 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setDateTimeStorageFormat().

◆ getTypeOfRelation()

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

Definition at line 127 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getEmptyRelationValue(), and TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\parseComparison().

◆ setChildKeyFieldName()

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

Definition at line 207 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setManyToManyRelation().

◆ setChildSortByFieldName()

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

Definition at line 157 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setManyToManyRelation(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToManyRelation(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToOneRelation().

◆ setChildTableDefaultSortings()

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

Definition at line 147 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToManyRelation().

◆ setChildTableName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setChildTableName ( ?string $childTableName )

Definition at line 137 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setManyToManyRelation(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToManyRelation(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToOneRelation().

◆ setDateTimeStorageFormat()

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

Definition at line 217 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setDateTimeStorageFormat().

◆ setParentKeyFieldName()

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

Definition at line 187 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setManyToManyRelation(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToManyRelation(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToOneRelation().

◆ setParentTableFieldName()

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

Definition at line 197 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToManyRelation(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToOneRelation().

◆ setRelationTableMatchFields()

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

Definition at line 177 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setManyToManyRelation(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToManyRelation(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToOneRelation().

◆ setRelationTableName()

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

Definition at line 167 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setManyToManyRelation().

◆ setType()

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

Definition at line 227 of file ColumnMap.php.

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

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

◆ setTypeOfRelation()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setTypeOfRelation ( ColumnMap\Relation $typeOfRelation )

Definition at line 122 of file ColumnMap.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setManyToManyRelation(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToManyRelation(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setOneToOneRelation(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMapFactory\setRelations().

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 97 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 57 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

The name of the fields with direction the results from the child's table are sorted by default

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

Definition at line 49 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getChildTableDefaultSortings(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setChildTableDefaultSortings().

◆ $childTableName

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

private

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

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

Definition at line 42 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getChildTableName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setChildTableName().

◆ $columnName

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

private

The column name

Definition at line 32 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\__construct(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getColumnName().

◆ $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 107 of file ColumnMap.php.

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

◆ $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 82 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 90 of file ColumnMap.php.

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

◆ $relationTableMatchFields

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

private

todo: Check if this property should support null. If not, set default value. An array of field => value pairs to both insert and match against when writing/reading MM relations

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

Definition at line 74 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getRelationTableMatchFields(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setRelationTableMatchFields().

◆ $relationTableName

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

private

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

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

Definition at line 65 of file ColumnMap.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getRelationTableName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setRelationTableName().

◆ $type

TableColumnType TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$type = TableColumnType::INPUT

private

Definition at line 109 of file ColumnMap.php.

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

◆ $typeOfRelation

ColumnMap Relation TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$typeOfRelation = ColumnMap\Relation::NONE

private

Definition at line 34 of file ColumnMap.php.

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Relation

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getChildKeyFieldName()

◆ getChildSortByFieldName()

◆ getChildTableDefaultSortings()

◆ getChildTableName()

◆ getColumnName()

◆ getDateTimeStorageFormat()

◆ getParentKeyFieldName()

◆ getParentTableFieldName()

◆ getRelationTableMatchFields()

◆ getRelationTableName()

◆ getType()

◆ getTypeOfRelation()

◆ setChildKeyFieldName()

◆ setChildSortByFieldName()

◆ setChildTableDefaultSortings()

◆ setChildTableName()

◆ setDateTimeStorageFormat()

◆ setParentKeyFieldName()

◆ setParentTableFieldName()

◆ setRelationTableMatchFields()

◆ setRelationTableName()

◆ setType()

◆ setTypeOfRelation()

Member Data Documentation

◆ $childKeyFieldName

◆ $childSortByFieldName

◆ $childTableDefaultSortings

◆ $childTableName

◆ $columnName

◆ $dateTimeStorageFormat

◆ $parentKeyFieldName

◆ $parentTableFieldName

◆ $relationTableMatchFields

◆ $relationTableName

◆ $type

◆ $typeOfRelation