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

Public Member Functions

 __construct ($columnName, $propertyName)
 
 setTypeOfRelation ($typeOfRelation)
 
string getTypeOfRelation ()
 
 setPropertyName ($propertyName)
 
string getPropertyName ()
 
 setColumnName ($columnName)
 
string getColumnName ()
 
 setChildTableName ($childTableName)
 
string getChildTableName ()
 
 setChildTableWhereStatement ($childTableWhereStatement)
 
string getChildTableWhereStatement ()
 
 setChildSortByFieldName ($childSortByFieldName)
 
string getChildSortByFieldName ()
 
 setRelationTableName ($relationTableName)
 
string getRelationTableName ()
 
 setRelationTablePageIdColumnName ($relationTablePageIdColumnName)
 
string getRelationTablePageIdColumnName ()
 
 setRelationTableMatchFields (array $relationTableMatchFields)
 
array getRelationTableMatchFields ()
 
 setRelationTableInsertFields (array $relationTableInsertFields)
 
array getRelationTableInsertFields ()
 
 setRelationTableWhereStatement ($relationTableWhereStatement)
 
string getRelationTableWhereStatement ()
 
 setParentKeyFieldName ($parentKeyFieldName)
 
string getParentKeyFieldName ()
 
 setParentTableFieldName ($parentTableFieldName)
 
string getParentTableFieldName ()
 
 setChildKeyFieldName ($childKeyFieldName)
 
string getChildKeyFieldName ()
 
 setDateTimeStorageFormat ($dateTimeStorageFormat)
 
string getDateTimeStorageFormat ()
 
 setInternalType ($internalType)
 
TYPO3 CMS Core DataHandling TableColumnSubType getInternalType ()
 
 setType ($type)
 
TYPO3 CMS Core DataHandling TableColumnType 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'
 
const RELATION_PARENT_FOREIGN_KEY = 'RELATION_PARENT_FOREIGN_KEY'
 
const RELATION_CHILD_FOREIGN_KEY = 'RELATION_CHILD_FOREIGN_KEY'
 
const RELATION_PARENT_CSV = 'RELATION_PARENT_CSV'
 
const RELATION_INTERMEDIATE_TABLE = 'RELATION_INTERMEDIATE_TABLE'
 
const STRATEGY_EAGER = 'eager'
 
const STRATEGY_LAZY_PROXY = 'proxy'
 
const STRATEGY_LAZY_STORAGE = 'storage'
 

Protected Attributes

string $propertyName
 
string $columnName
 
string $typeOfRelation
 
string $childClassName
 
string $childTableName
 
string $childTableWhereStatement
 
string $childSortByFieldName
 
string $relationTableName
 
string $relationTablePageIdColumnName
 
array $relationTableMatchFields
 
array $relationTableInsertFields
 
string $relationTableWhereStatement
 
string $parentKeyFieldName
 
string $parentTableFieldName
 
string $childKeyFieldName
 
string $dateTimeStorageFormat
 
TYPO3 CMS Core DataHandling TableColumnType $type
 
TYPO3 CMS Core DataHandling TableColumnSubType $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 21 of file ColumnMap.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructs a Column Map

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

Definition at line 159 of file ColumnMap.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setColumnName(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setPropertyName().

Member Function Documentation

◆ getChildKeyFieldName()

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

Definition at line 385 of file ColumnMap.php.

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

◆ getChildSortByFieldName()

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

◆ getChildTableName()

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

Definition at line 225 of file ColumnMap.php.

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

◆ getChildTableWhereStatement()

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

◆ getColumnName()

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

Definition at line 209 of file ColumnMap.php.

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

◆ getDateTimeStorageFormat()

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

◆ getInternalType()

TYPO3 CMS Core DataHandling TableColumnSubType TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getInternalType ( )
Returns
‪\TYPO3\CMS\Core\DataHandling\TableColumnSubType

Definition at line 417 of file ColumnMap.php.

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

◆ getParentKeyFieldName()

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

◆ getParentTableFieldName()

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

◆ getPropertyName()

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

◆ getRelationTableInsertFields()

array TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getRelationTableInsertFields ( )

◆ getRelationTableMatchFields()

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

◆ getRelationTableName()

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

◆ getRelationTablePageIdColumnName()

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

◆ getRelationTableWhereStatement()

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

◆ getType()

TYPO3 CMS Core DataHandling TableColumnType TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::getType ( )
Returns
‪\TYPO3\CMS\Core\DataHandling\TableColumnType

Definition at line 433 of file ColumnMap.php.

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

◆ getTypeOfRelation()

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

◆ setChildKeyFieldName()

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

◆ setChildSortByFieldName()

◆ setChildTableName()

◆ setChildTableWhereStatement()

◆ setColumnName()

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

◆ setDateTimeStorageFormat()

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

◆ setInternalType()

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

Definition at line 409 of file ColumnMap.php.

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

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

◆ setParentKeyFieldName()

◆ setParentTableFieldName()

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

◆ setPropertyName()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setPropertyName (   $propertyName)

◆ 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 (   $relationTableName)

◆ setRelationTablePageIdColumnName()

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

◆ setRelationTableWhereStatement()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::setRelationTableWhereStatement (   $relationTableWhereStatement)

◆ setType()

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

Definition at line 425 of file ColumnMap.php.

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

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

◆ setTypeOfRelation()

Member Data Documentation

◆ $childClassName

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$childClassName
protected

The name of the child's class

Definition at line 69 of file ColumnMap.php.

◆ $childKeyFieldName

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

◆ $childSortByFieldName

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

The name of the field the results from the child's table are sorted by

Definition at line 87 of file ColumnMap.php.

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

◆ $childTableName

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

◆ $childTableWhereStatement

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$childTableWhereStatement
protected

◆ $columnName

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

◆ $dateTimeStorageFormat

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

Alternative format for storing DataTime formats (instead of using unix-time stamps). Allowed values are 'date', 'datetime' and 'time'

Definition at line 143 of file ColumnMap.php.

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

◆ $internalType

TYPO3 CMS Core DataHandling TableColumnSubType TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$internalType
protected

◆ $parentKeyFieldName

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

◆ $parentTableFieldName

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

The name of the field holding the name of the table of the parent's records

Definition at line 129 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
protected

◆ $relationTableInsertFields

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

◆ $relationTableMatchFields

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

An array of field => value pairs to both insert and match against when writing/reading MM relations

Definition at line 105 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 TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$relationTableName
protected

◆ $relationTablePageIdColumnName

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

◆ $relationTableWhereStatement

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

◆ $type

TYPO3 CMS Core DataHandling TableColumnType TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::$type
protected

◆ $typeOfRelation

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

◆ RELATION_BELONGS_TO_MANY

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

◆ RELATION_CHILD_FOREIGN_KEY

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

Definition at line 36 of file ColumnMap.php.

◆ RELATION_HAS_AND_BELONGS_TO_MANY

◆ RELATION_HAS_MANY

◆ RELATION_HAS_ONE

◆ RELATION_INTERMEDIATE_TABLE

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

Definition at line 38 of file ColumnMap.php.

◆ RELATION_NONE

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

◆ RELATION_PARENT_CSV

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

Definition at line 37 of file ColumnMap.php.

◆ RELATION_PARENT_FOREIGN_KEY

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

Constants reflecting how the relation information is stored

Definition at line 35 of file ColumnMap.php.

◆ STRATEGY_EAGER

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

Constants reflecting the loading strategy

Definition at line 43 of file ColumnMap.php.

◆ STRATEGY_LAZY_PROXY

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

Definition at line 44 of file ColumnMap.php.

◆ STRATEGY_LAZY_STORAGE

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

Definition at line 45 of file ColumnMap.php.