‪TYPO3CMS  11.5
ColumnMap.php
Go to the documentation of this file.
1 <?php
2 
3 declare(strict_types=1);
4 
5 /*
6  * This file is part of the TYPO3 CMS project.
7  *
8  * It is free software; you can redistribute it and/or modify it under
9  * the terms of the GNU General Public License, either version 2
10  * of the License, or any later version.
11  *
12  * For the full copyright and license information, please read the
13  * LICENSE.txt file that was distributed with this source code.
14  *
15  * The TYPO3 project - inspiring people to share!
16  */
17 
19 
22 
28 {
32  public const ‪RELATION_NONE = 'RELATION_NONE';
33 
37  public const ‪RELATION_HAS_ONE = 'RELATION_HAS_ONE';
38 
42  public const ‪RELATION_HAS_MANY = 'RELATION_HAS_MANY';
43 
47  public const ‪RELATION_BELONGS_TO_MANY = 'RELATION_BELONGS_TO_MANY';
48 
52  public const ‪RELATION_HAS_AND_BELONGS_TO_MANY = 'RELATION_HAS_AND_BELONGS_TO_MANY';
53 
59  private ‪$propertyName;
60 
66  private ‪$columnName;
67 
74  private ‪$typeOfRelation;
75 
83  private ‪$childTableName;
84 
90  private ?string ‪$childTableDefaultSortings = null;
91 
100 
108  private ‪$relationTableName;
109 
117 
127 
136 
148 
156  private ‪$parentKeyFieldName;
157 
165  private ‪$parentTableFieldName;
166 
173  private ‪$childKeyFieldName;
174 
185 
190  private ‪$type;
191 
196  private ‪$internalType;
197 
204  public function ‪__construct(string ‪$columnName, string ‪$propertyName)
205  {
206  // @todo Enable aliases (tx_anotherextension_addedcolumn -> theAddedColumn)
207  $this->columnName = ‪$columnName;
208  $this->propertyName = ‪$propertyName;
209  }
210 
214  public function ‪setTypeOfRelation(string ‪$typeOfRelation): void
215  {
216  $this->typeOfRelation = ‪$typeOfRelation;
217  }
218 
222  public function ‪getTypeOfRelation(): string
223  {
225  }
226 
230  public function ‪getPropertyName(): string
231  {
232  return ‪$this->propertyName;
233  }
234 
238  public function ‪getColumnName(): string
239  {
240  return ‪$this->columnName;
241  }
242 
246  public function ‪setChildTableName(?string ‪$childTableName): void
247  {
248  $this->childTableName = ‪$childTableName;
249  }
250 
254  public function ‪getChildTableName(): ?string
255  {
257  }
258 
263  {
264  $this->childTableDefaultSortings = ‪$childTableDefaultSortings;
265  }
266 
267  public function ‪getChildTableDefaultSortings(): ?string
268  {
270  }
271 
276  {
277  $this->childSortByFieldName = ‪$childSortByFieldName;
278  }
279 
283  public function ‪getChildSortByFieldName(): ?string
284  {
286  }
287 
291  public function ‪setRelationTableName(?string ‪$relationTableName): void
292  {
293  $this->relationTableName = ‪$relationTableName;
294  }
295 
299  public function ‪getRelationTableName(): ?string
300  {
302  }
303 
308  {
309  $this->relationTablePageIdColumnName = ‪$relationTablePageIdColumnName;
310  }
311 
315  public function ‪getRelationTablePageIdColumnName(): ?string
316  {
318  }
319 
324  {
325  $this->relationTableMatchFields = ‪$relationTableMatchFields;
326  }
327 
331  public function ‪getRelationTableMatchFields(): ?array
332  {
334  }
335 
340  {
341  $this->relationTableInsertFields = ‪$relationTableInsertFields;
342  }
343 
347  public function ‪getRelationTableInsertFields(): ?array
348  {
350  }
351 
355  public function ‪setParentKeyFieldName(?string ‪$parentKeyFieldName): void
356  {
357  $this->parentKeyFieldName = ‪$parentKeyFieldName;
358  }
359 
363  public function ‪getParentKeyFieldName(): ?string
364  {
366  }
367 
372  {
373  $this->parentTableFieldName = ‪$parentTableFieldName;
374  }
375 
379  public function ‪getParentTableFieldName(): ?string
380  {
382  }
383 
387  public function ‪setChildKeyFieldName(string ‪$childKeyFieldName): void
388  {
389  $this->childKeyFieldName = ‪$childKeyFieldName;
390  }
391 
395  public function ‪getChildKeyFieldName(): ?string
396  {
398  }
399 
404  {
405  $this->dateTimeStorageFormat = ‪$dateTimeStorageFormat;
406  }
407 
411  public function ‪getDateTimeStorageFormat(): ?string
412  {
414  }
415 
420  {
421  $this->internalType = ‪$internalType;
422  }
423 
428  {
429  return ‪$this->internalType;
430  }
431 
435  public function ‪setType(‪TableColumnType ‪$type): void
436  {
437  $this->type = ‪$type;
438  }
439 
443  public function ‪getType(): ?TableColumnType
444  {
445  return ‪$this->type;
446  }
447 }
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\RELATION_BELONGS_TO_MANY
‪const RELATION_BELONGS_TO_MANY
Definition: ColumnMap.php:47
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$internalType
‪TableColumnSubType null $internalType
Definition: ColumnMap.php:180
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setParentKeyFieldName
‪setParentKeyFieldName(?string $parentKeyFieldName)
Definition: ColumnMap.php:339
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$parentKeyFieldName
‪string null $parentKeyFieldName
Definition: ColumnMap.php:145
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap
Definition: ColumnMap.php:28
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$typeOfRelation
‪string null $typeOfRelation
Definition: ColumnMap.php:71
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setChildTableDefaultSortings
‪setChildTableDefaultSortings(?string $childTableDefaultSortings)
Definition: ColumnMap.php:246
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getDateTimeStorageFormat
‪string null getDateTimeStorageFormat()
Definition: ColumnMap.php:395
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\RELATION_HAS_AND_BELONGS_TO_MANY
‪const RELATION_HAS_AND_BELONGS_TO_MANY
Definition: ColumnMap.php:52
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getChildTableDefaultSortings
‪getChildTableDefaultSortings()
Definition: ColumnMap.php:251
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setDateTimeStorageFormat
‪setDateTimeStorageFormat(?string $dateTimeStorageFormat)
Definition: ColumnMap.php:387
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getColumnName
‪string getColumnName()
Definition: ColumnMap.php:222
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setChildTableName
‪setChildTableName(?string $childTableName)
Definition: ColumnMap.php:230
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setTypeOfRelation
‪setTypeOfRelation(string $typeOfRelation)
Definition: ColumnMap.php:198
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\RELATION_HAS_MANY
‪const RELATION_HAS_MANY
Definition: ColumnMap.php:42
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getRelationTableInsertFields
‪array null getRelationTableInsertFields()
Definition: ColumnMap.php:331
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getRelationTableMatchFields
‪array null getRelationTableMatchFields()
Definition: ColumnMap.php:315
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\__construct
‪__construct(string $columnName, string $propertyName)
Definition: ColumnMap.php:188
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getChildSortByFieldName
‪string null getChildSortByFieldName()
Definition: ColumnMap.php:267
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\RELATION_HAS_ONE
‪const RELATION_HAS_ONE
Definition: ColumnMap.php:37
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$relationTableWhereStatement
‪string null $relationTableWhereStatement
Definition: ColumnMap.php:137
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$relationTableInsertFields
‪array null $relationTableInsertFields
Definition: ColumnMap.php:126
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getChildKeyFieldName
‪string null getChildKeyFieldName()
Definition: ColumnMap.php:379
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$type
‪TableColumnType null $type
Definition: ColumnMap.php:175
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\RELATION_NONE
‪const RELATION_NONE
Definition: ColumnMap.php:32
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getParentKeyFieldName
‪string null getParentKeyFieldName()
Definition: ColumnMap.php:347
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setType
‪setType(TableColumnType $type)
Definition: ColumnMap.php:419
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$childTableName
‪string null $childTableName
Definition: ColumnMap.php:79
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setRelationTablePageIdColumnName
‪setRelationTablePageIdColumnName(string $relationTablePageIdColumnName)
Definition: ColumnMap.php:291
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$childSortByFieldName
‪string null $childSortByFieldName
Definition: ColumnMap.php:94
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$relationTablePageIdColumnName
‪string null $relationTablePageIdColumnName
Definition: ColumnMap.php:109
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$parentTableFieldName
‪string null $parentTableFieldName
Definition: ColumnMap.php:153
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setInternalType
‪setInternalType(TableColumnSubType $internalType)
Definition: ColumnMap.php:403
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getType
‪TableColumnType null getType()
Definition: ColumnMap.php:427
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$dateTimeStorageFormat
‪string null $dateTimeStorageFormat
Definition: ColumnMap.php:170
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getParentTableFieldName
‪string null getParentTableFieldName()
Definition: ColumnMap.php:363
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$childTableDefaultSortings
‪string $childTableDefaultSortings
Definition: ColumnMap.php:86
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getPropertyName
‪string getPropertyName()
Definition: ColumnMap.php:214
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setChildKeyFieldName
‪setChildKeyFieldName(string $childKeyFieldName)
Definition: ColumnMap.php:371
‪TYPO3\CMS\Core\DataHandling\TableColumnSubType
Definition: TableColumnSubType.php:24
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$relationTableName
‪string null $relationTableName
Definition: ColumnMap.php:102
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$propertyName
‪string $propertyName
Definition: ColumnMap.php:58
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$childKeyFieldName
‪string null $childKeyFieldName
Definition: ColumnMap.php:160
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$columnName
‪string $columnName
Definition: ColumnMap.php:64
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper
Definition: ColumnMap.php:18
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getRelationTablePageIdColumnName
‪string null getRelationTablePageIdColumnName()
Definition: ColumnMap.php:299
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getChildTableName
‪string null getChildTableName()
Definition: ColumnMap.php:238
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setChildSortByFieldName
‪setChildSortByFieldName(?string $childSortByFieldName)
Definition: ColumnMap.php:259
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getTypeOfRelation
‪string getTypeOfRelation()
Definition: ColumnMap.php:206
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getInternalType
‪TableColumnSubType null getInternalType()
Definition: ColumnMap.php:411
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setRelationTableInsertFields
‪setRelationTableInsertFields(array $relationTableInsertFields)
Definition: ColumnMap.php:323
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getRelationTableName
‪string null getRelationTableName()
Definition: ColumnMap.php:283
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setParentTableFieldName
‪setParentTableFieldName(?string $parentTableFieldName)
Definition: ColumnMap.php:355
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\$relationTableMatchFields
‪array null $relationTableMatchFields
Definition: ColumnMap.php:118
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setRelationTableMatchFields
‪setRelationTableMatchFields(?array $relationTableMatchFields)
Definition: ColumnMap.php:307
‪TYPO3\CMS\Core\DataHandling\TableColumnType
Definition: TableColumnType.php:24
‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\setRelationTableName
‪setRelationTableName(?string $relationTableName)
Definition: ColumnMap.php:275