ColumnMap
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.
Table of Contents
Constants
- RELATION_BELONGS_TO_MANY = 'RELATION_BELONGS_TO_MANY'
- RELATION_HAS_AND_BELONGS_TO_MANY = 'RELATION_HAS_AND_BELONGS_TO_MANY'
- RELATION_HAS_MANY = 'RELATION_HAS_MANY'
- RELATION_HAS_ONE = 'RELATION_HAS_ONE'
- RELATION_NONE = 'RELATION_NONE'
Methods
- __construct() : mixed
- Constructs a Column Map
- getChildKeyFieldName() : string|null
- getChildSortByFieldName() : string|null
- getChildTableDefaultSortings() : string|null
- getChildTableName() : string|null
- getColumnName() : string
- getDateTimeStorageFormat() : string|null
- getInternalType() : TableColumnSubType|null
- getParentKeyFieldName() : string|null
- getParentTableFieldName() : string|null
- getPropertyName() : string
- getRelationTableInsertFields() : array<string|int, mixed>|null
- getRelationTableMatchFields() : array<string|int, mixed>|null
- getRelationTableName() : string|null
- getRelationTablePageIdColumnName() : string|null
- getType() : TableColumnType|null
- getTypeOfRelation() : string
- setChildKeyFieldName() : void
- setChildSortByFieldName() : void
- setChildTableDefaultSortings() : void
- setChildTableName() : void
- setDateTimeStorageFormat() : void
- setInternalType() : void
- setParentKeyFieldName() : void
- setParentTableFieldName() : void
- setRelationTableInsertFields() : void
- setRelationTableMatchFields() : void
- setRelationTableName() : void
- setRelationTablePageIdColumnName() : void
- setType() : void
- setTypeOfRelation() : void
Constants
RELATION_BELONGS_TO_MANY
public
string
RELATION_BELONGS_TO_MANY
= 'RELATION_BELONGS_TO_MANY'
RELATION_HAS_AND_BELONGS_TO_MANY
public
string
RELATION_HAS_AND_BELONGS_TO_MANY
= 'RELATION_HAS_AND_BELONGS_TO_MANY'
RELATION_HAS_MANY
public
string
RELATION_HAS_MANY
= 'RELATION_HAS_MANY'
RELATION_HAS_ONE
public
string
RELATION_HAS_ONE
= 'RELATION_HAS_ONE'
RELATION_NONE
public
string
RELATION_NONE
= 'RELATION_NONE'
Methods
__construct()
Constructs a Column Map
public
__construct(string $columnName, string $propertyName) : mixed
Parameters
- $columnName : string
-
The column name
- $propertyName : string
-
The property name
getChildKeyFieldName()
public
getChildKeyFieldName() : string|null
Return values
string|nullgetChildSortByFieldName()
public
getChildSortByFieldName() : string|null
Return values
string|nullgetChildTableDefaultSortings()
public
getChildTableDefaultSortings() : string|null
Return values
string|nullgetChildTableName()
public
getChildTableName() : string|null
Return values
string|nullgetColumnName()
public
getColumnName() : string
Return values
stringgetDateTimeStorageFormat()
public
getDateTimeStorageFormat() : string|null
Return values
string|nullgetInternalType()
public
getInternalType() : TableColumnSubType|null
Return values
TableColumnSubType|nullgetParentKeyFieldName()
public
getParentKeyFieldName() : string|null
Return values
string|nullgetParentTableFieldName()
public
getParentTableFieldName() : string|null
Return values
string|nullgetPropertyName()
public
getPropertyName() : string
Return values
stringgetRelationTableInsertFields()
public
getRelationTableInsertFields() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetRelationTableMatchFields()
public
getRelationTableMatchFields() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetRelationTableName()
public
getRelationTableName() : string|null
Return values
string|nullgetRelationTablePageIdColumnName()
public
getRelationTablePageIdColumnName() : string|null
Return values
string|nullgetType()
public
getType() : TableColumnType|null
Return values
TableColumnType|nullgetTypeOfRelation()
public
getTypeOfRelation() : string
Return values
stringsetChildKeyFieldName()
public
setChildKeyFieldName(string $childKeyFieldName) : void
Parameters
- $childKeyFieldName : string
setChildSortByFieldName()
public
setChildSortByFieldName(string|null $childSortByFieldName) : void
Parameters
- $childSortByFieldName : string|null
setChildTableDefaultSortings()
public
setChildTableDefaultSortings(string|null $childTableDefaultSortings) : void
Parameters
- $childTableDefaultSortings : string|null
setChildTableName()
public
setChildTableName(string|null $childTableName) : void
Parameters
- $childTableName : string|null
setDateTimeStorageFormat()
public
setDateTimeStorageFormat(string|null $dateTimeStorageFormat) : void
Parameters
- $dateTimeStorageFormat : string|null
setInternalType()
public
setInternalType(TableColumnSubType $internalType) : void
Parameters
- $internalType : TableColumnSubType
setParentKeyFieldName()
public
setParentKeyFieldName(string|null $parentKeyFieldName) : void
Parameters
- $parentKeyFieldName : string|null
setParentTableFieldName()
public
setParentTableFieldName(string|null $parentTableFieldName) : void
Parameters
- $parentTableFieldName : string|null
setRelationTableInsertFields()
public
setRelationTableInsertFields(array<string|int, mixed> $relationTableInsertFields) : void
Parameters
- $relationTableInsertFields : array<string|int, mixed>
setRelationTableMatchFields()
public
setRelationTableMatchFields(array<string|int, mixed>|null $relationTableMatchFields) : void
Parameters
- $relationTableMatchFields : array<string|int, mixed>|null
setRelationTableName()
public
setRelationTableName(string|null $relationTableName) : void
Parameters
- $relationTableName : string|null
setRelationTablePageIdColumnName()
public
setRelationTablePageIdColumnName(string $relationTablePageIdColumnName) : void
Parameters
- $relationTablePageIdColumnName : string
setType()
public
setType(TableColumnType $type) : void
Parameters
- $type : TableColumnType
setTypeOfRelation()
public
setTypeOfRelation(string $typeOfRelation) : void
Parameters
- $typeOfRelation : string