ColumnMap

Read onlyYes
FinalYes

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

Internal

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

Table of Contents

Properties

$childKeyFieldName  : string|null
$childSortByFieldName  : string|null
$childTableDefaultSortings  : string|null
$childTableName  : string|null
$columnName  : string
$dateTimeStorageFormat  : string|null
$parentKeyFieldName  : string|null
$parentTableFieldName  : string|null
$relationTableMatchFields  : array<string|int, mixed>
$relationTableName  : string|null
$type  : TableColumnType
$typeOfRelation  : Relation|null

Methods

__construct()  : mixed
getChildKeyFieldName()  : string|null
getChildSortByFieldName()  : string|null
getChildTableDefaultSortings()  : string|null
getChildTableName()  : string|null
getColumnName()  : string
getDateTimeStorageFormat()  : string|null
getParentKeyFieldName()  : string|null
getParentTableFieldName()  : string|null
getRelationTableMatchFields()  : array<string|int, mixed>
getRelationTableName()  : string|null
getType()  : TableColumnType
getTypeOfRelation()  : Relation

Properties

$childKeyFieldName

public string|null $childKeyFieldName = null

$childSortByFieldName

public string|null $childSortByFieldName = null

$childTableDefaultSortings

public string|null $childTableDefaultSortings = null

$childTableName

public string|null $childTableName = null

$dateTimeStorageFormat

public string|null $dateTimeStorageFormat = null

$parentKeyFieldName

public string|null $parentKeyFieldName = null

$parentTableFieldName

public string|null $parentTableFieldName = null

$relationTableMatchFields

public array<string|int, mixed> $relationTableMatchFields = []

$relationTableName

public string|null $relationTableName = null

Methods

__construct()

public __construct(string $columnName, TableColumnType $type[, string|null $dateTimeStorageFormat = null ][, Relation|null $typeOfRelation = Relation::NONE ][, string|null $childTableName = null ][, string|null $relationTableName = null ][, array<string|int, mixed> $relationTableMatchFields = [] ][, string|null $parentKeyFieldName = null ][, string|null $parentTableFieldName = null ][, string|null $childKeyFieldName = null ][, string|null $childSortByFieldName = null ][, string|null $childTableDefaultSortings = null ]) : mixed
Parameters
$columnName : string

Name of the DB column

$type : TableColumnType

TCA column type like "input", "inline"

$dateTimeStorageFormat : string|null = null

Alternative DataTime format instead of using unix timestamps. Allowed: "date", "datetime", "time"

$typeOfRelation : Relation|null = Relation::NONE

Extbase "Relation" enum if any

$childTableName : string|null = null

TCA "foreign_table" if any, @todo: Does not consider group "allowed" for multi table relations

$relationTableName : string|null = null

TCA "MM" if any

$relationTableMatchFields : array<string|int, mixed> = []

TCA "MM_match_fields" if any in MM, TCA "foreign_match_fields" if any

$parentKeyFieldName : string|null = null

TCA "uid_local" or "uid_foreign" with TCA "MM" depending on "opposite", TCA "foreign_field" with TCA "foreign_table" relations

$parentTableFieldName : string|null = null

TCA "foreign_table_field" with TCA "foreign_table" relations

$childKeyFieldName : string|null = null

TCA "uid_local" or "uid_foreign" with TCA "MM" depending on "opposite"

$childSortByFieldName : string|null = null

Name of the field results from child's table are sorted by: TCA "sorting" or "sorting_foreign" with TCA "MM" depending on TCA "opposite" situation, TCA "foreign_sortby" with TCA "foreign_table"

$childTableDefaultSortings : string|null = null

name of the fields with direction results from child's table are sorted by default: TCA "foreign_default_sortby" with TCA "foreign_table"

getChildKeyFieldName()

public getChildKeyFieldName() : string|null
Return values
string|null

getChildSortByFieldName()

public getChildSortByFieldName() : string|null
Return values
string|null

getChildTableDefaultSortings()

public getChildTableDefaultSortings() : string|null
Return values
string|null

getChildTableName()

public getChildTableName() : string|null
Return values
string|null

getColumnName()

public getColumnName() : string
Return values
string

getDateTimeStorageFormat()

public getDateTimeStorageFormat() : string|null
Return values
string|null

getParentKeyFieldName()

public getParentKeyFieldName() : string|null
Return values
string|null

getParentTableFieldName()

public getParentTableFieldName() : string|null
Return values
string|null

getRelationTableMatchFields()

public getRelationTableMatchFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRelationTableName()

public getRelationTableName() : string|null
Return values
string|null 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results