class BelongsTo extends BelongsTo

Adapted from october\rain\database\relations\BelongsTo

Traits

Adapted from october\rain\database\relations\DeferOneOrMany

Properties

protected string $relationName

Methods

Builder
withDeferred($sessionKey)

Returns the model query with deferred bindings added

Expression
getWithDeferredQualifiedKeyName()

Returns the related "slave id" key in a database friendly format.

void
addDefinedConstraints()

Set the defined constraints on the relation query.

addDefinedConstraintsToRelation(Relation $relation, array $args = null)

Add relation based constraints.

addDefinedConstraintsToQuery(Builder $query, array $args = null)

Add query based constraints.

__construct(Builder $query, Model $child, $foreignKey, $ownerKey, $relationName)

No description

add(Model $model, $sessionKey = null)

Adds a model to this relationship type.

remove(Model $model, $sessionKey = null)

Removes a model from this relationship type.

setSimpleValue($value)

Helper for setting this relationship using various expected values. For example, $model->relation = $value;

getSimpleValue()

Helper for getting this relationship simple value, generally useful with form values.

string
getOtherKey()

Get the associated key of the relationship.

Details

in DeferOneOrMany at line 17
Builder withDeferred($sessionKey)

Returns the model query with deferred bindings added

Parameters

$sessionKey

Return Value

Builder

in DeferOneOrMany at line 125
protected Expression getWithDeferredQualifiedKeyName()

Returns the related "slave id" key in a database friendly format.

Return Value

Expression

in DefinedConstraints at line 20
void addDefinedConstraints()

Set the defined constraints on the relation query.

Return Value

void

in DefinedConstraints at line 35
addDefinedConstraintsToRelation(Relation $relation, array $args = null)

Add relation based constraints.

Parameters

Relation $relation
array $args

in DefinedConstraints at line 85
addDefinedConstraintsToQuery(Builder $query, array $args = null)

Add query based constraints.

Parameters

Builder $query
array $args

at line 22
__construct(Builder $query, Model $child, $foreignKey, $ownerKey, $relationName)

No description

Parameters

Builder $query
Model $child
$foreignKey
$ownerKey
$relationName

at line 34
add(Model $model, $sessionKey = null)

Adds a model to this relationship type.

Parameters

Model $model
$sessionKey

at line 47
remove(Model $model, $sessionKey = null)

Removes a model from this relationship type.

Parameters

Model $model
$sessionKey

at line 61
setSimpleValue($value)

Helper for setting this relationship using various expected values. For example, $model->relation = $value;

Parameters

$value

at line 93
getSimpleValue()

Helper for getting this relationship simple value, generally useful with form values.

at line 102
string getOtherKey()

Get the associated key of the relationship.

Return Value

string