PassiveRelation

final readonly class \TYPO3\CMS\Core\Schema\PassiveRelation

A relation from another field / schema.

Examples:

  • A table "tx_myextension_author" has a passive relation FROM the table "tx_books" and its field "authors".
  • A TCA table of type inline has a passthrough field in the child table, and that's a PASSIVE relation FROM the parent table.

Table of Contents

Methods

__construct()  : mixed
__set_state()  : self
flexPointer()  : string|null
Sheet and field identifier ("<sheet>/<field>") if the relation originates from within a FlexForm data structure, null otherwise.
fromField()  : string|null
fromTable()  : string
isManyToMany()  : bool
manyToManyTable()  : string|null
toField()  : string|null
The field of this schema the relation points to: the "foreign_field" of an inline relation, or the local side field named in "MM_opposite_field" of an MM relation.

Methods

__construct()

public __construct(string $fromTable, string|null $fromField, string|null $flexPointer[, string|null $toField = null ][, string|null $manyToManyTable = null ]) : mixed

Parameters

$fromTable : string
$fromField : string|null
$flexPointer : string|null
$toField : string|null = null
$manyToManyTable : string|null = null

__set_state()

public static __set_state(array $state) : self

Parameters

$state : array

Return values

self

flexPointer()

Sheet and field identifier ("<sheet>/<field>") if the relation originates from within a FlexForm data structure, null otherwise.

public flexPointer() : string|null

Return values

string|null

fromField()

public fromField() : string|null

Return values

string|null

fromTable()

public fromTable() : string

Return values

string

isManyToMany()

public isManyToMany() : bool

Return values

bool

manyToManyTable()

public manyToManyTable() : string|null

Return values

string|null

toField()

The field of this schema the relation points to: the "foreign_field" of an inline relation, or the local side field named in "MM_opposite_field" of an MM relation.

public toField() : string|null

Return values

string|null
On this page