Class Atk4\Data\Reference

`uses`	`DiContainerTrait, InitializerTrait, TrackableTrait`

Reference implements a link between one model and another. The basic components for a reference is ability to generate the destination model, which is returned through getModel() and that's pretty much it.

It's possible to extend the basic reference with more meaningful references.

Atk4\Data\Reference uses DiContainerTrait, InitializerTrait, TrackableTrait

Located at data/src/Reference.php

Methods
`public`	`__construct(string $link)`	#
`public`	`setOwner(Model $owner): $this`	#
`protected`	`assertReferenceValueNotNull(mixed $value): void`	#
`public`	`getOurFieldName(): string`	#
`final protected`	`getOurField(): Field`	#
`final protected`	`getOurFieldValue(Model $ourEntity): mixed`	#
`public`	`getTheirFieldName(Model $theirModel = null): string` Overriden by `Atk4\Data\Reference\HasMany::getTheirFieldName()`	#
`protected`	`onHookToOurModel<T is Model>( Model $model, string $spot, Closure(T, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed): mixed $fx, array<int, mixed> $args = [], int $priority = 5, ): int`	#
`protected`	`onHookToTheirModel( Model $model, string $spot, Closure(Model, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed): mixed $fx, array<int, mixed> $args = [], int $priority = 5, ): int`	#
`protected`	`init(): void` Overriden by `Atk4\Data\Reference\ContainsBase::init()` `Atk4\Data\Reference\HasOne::init()`	#
`public`	`getDesiredName(): string` Will use #ref-<link>. Will use #ref-.	#
`public`	`getOurModel(?Model $ourModel): Model`	#
`public`	`createTheirModel(array<string, mixed> $defaults = []): Model` Create destination model that is linked through this reference. Will apply necessary conditions. Create destination model that is linked through this reference. Will apply necessary conditions. IMPORTANT: the returned model must be a fresh clone or freshly built from a seed	#
`protected`	`initTableAlias(): void`	#
`protected`	`addToPersistence(Model $theirModel, array<string, mixed> $defaults = []): void`	#
`protected`	`getDefaultPersistence(Model $theirModel): Persistence\|false` Returns default persistence for theirModel. Returns default persistence for theirModel. Overriden by `Atk4\Data\Reference\ContainsOne::getDefaultPersistence()` `Atk4\Data\Reference\ContainsMany::getDefaultPersistence()`	#
`public`	`ref(Model $ourModel, array<string, mixed> $defaults = []): Model` Returns referenced model without any extra conditions. However other relationship types may override this to imply… Returns referenced model without any extra conditions. However other relationship types may override this to imply conditions. Overriden by `Atk4\Data\Reference\ContainsOne::ref()` `Atk4\Data\Reference\ContainsMany::ref()` `Atk4\Data\Reference\HasMany::ref()` `Atk4\Data\Reference\HasOne::ref()`	#
`public`	`refModel(Model $ourModel, array<string, mixed> $defaults = []): Model` Returns referenced model without any extra conditions. Ever when extended must always respond with Model that does not… Returns referenced model without any extra conditions. Ever when extended must always respond with Model that does not look into current record or scope.	#
`public`	`__debugInfo(): array<string, mixed>`	#
`public`	`getOwner(): Model` our model our model	#

Methods used from Atk4\Core\DiContainerTrait
`setDefaults(), setMissingProperty(), assertInstanceOf(), _fromSeedPrecheck(), fromSeed(), fromSeedUnsafe()`

Methods used from Atk4\Core\InitializerTrait
`isInitialized(), assertIsInitialized(), invokeInit()`

Methods used from Atk4\Core\TrackableTrait
`issetOwner(), unsetOwner(), destroy()`

Properties
`protected`	`string`	`$tableAlias`	#
`public`	`string`	`$link`	#
`public`	`Model\|(Closure(object, static, array<string, mixed>): Model)\|array<mixed>`	`$model`	#
`protected`	`?string`	`$ourField = null` This is an optional property which can be used by your implementation to store field-level relationship based on a… This is an optional property which can be used by your implementation to store field-level relationship based on a common field matching.	#
`protected`	`?string`	`$theirField = null` This is an optional property which can be used by your implementation to store field-level relationship based on a… This is an optional property which can be used by your implementation to store field-level relationship based on a common field matching.	#
`public`	`bool`	`$checkTheirType = true` Database our/their field types must always match, but DBAL types can be different in theory, set this to false when the… Database our/their field types must always match, but DBAL types can be different in theory, set this to false when the DBAL types are intentionally different.	#
`public`	`string\|null`	`$caption`	#

Properties used from Atk4\Core\InitializerTrait
`$_initialized`

Properties used from Atk4\Core\TrackableTrait
`$_owner, $shortName`

Namespaces

Classes

Exceptions

Class Atk4\Data\Reference

Overriden by

Overriden by

Overriden by

Overriden by