A navigation property, representing an association between two
entity types.
Unlike structural properties, navigation properties always point
to an EntityType. They may be single-valued or collection-valued,
may declare a partner on the target side, and may declare
referential constraints that tie foreign-key structural properties
to the principal key.
| Methods |
public
|
getTargetType(): EntityTypeInterface
The resolved target entity type of this navigation property.
The resolved target entity type of this navigation property.
Implemented by
|
#
|
public
|
isCollection(): bool
Whether this navigation property is collection-valued.
Whether this navigation property is collection-valued.
Implemented by
|
#
|
public
|
isNullable(): bool
Whether a null target is permitted for a single-valued
navigation property. Always false for collection-valued…
Whether a null target is permitted for a single-valued
navigation property. Always false for collection-valued
navigation properties.
Implemented by
|
#
|
public
|
getPartnerName(): ?string
The name of the partner navigation property on the target
entity type, or null when no partner is declared.
The name of the partner navigation property on the target
entity type, or null when no partner is declared.
The partner is not resolved to an object here because doing so
would introduce a circular reference between the two types.
Callers can resolve the name via the target type if needed.
Implemented by
|
#
|
public
|
isContainmentTarget(): bool
Whether this navigation property defines a containment
relationship, meaning the target entities are part of the
source…
Whether this navigation property defines a containment
relationship, meaning the target entities are part of the
source entity and have no independent identity outside of it.
Implemented by
|
#
|
public
|
getReferentialConstraints(): array<string, string>
The referential constraints declared on this navigation property,
mapping dependent structural property names to…
The referential constraints declared on this navigation property,
mapping dependent structural property names to principal property
names. Returns an empty array when none are declared.
The array key is the name of the dependent property on this
entity type; the value is the name of the referenced property
on the principal entity type.
Implemented by
|
#
|
public
|
getOnDeleteAction(): ?string
The on-delete action declared for this relationship, or null
when absent. Possible values per spec: "Cascade", "None",
…
The on-delete action declared for this relationship, or null
when absent. Possible values per spec: "Cascade", "None",
"SetNull", "SetDefault".
Implemented by
|
#
|