[11.x] Added inverse() to Has* Relations

src/Illuminate/Database/Eloquent/Relations/Concerns/SupportsInverseRelations.php

@@ -3,13 +3,14 @@
 namespace Illuminate\Database\Eloquent\Relations\Concerns;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\RelationNotFoundException;
 
 trait SupportsInverseRelations
 {
  protected string|null $inverseRelationship = null;
 
  /**
- * Gets the name of the inverse relationship
+ * Gets the name of the inverse relationship.
  *
  * @return string|null
  */
@@ -19,13 +20,17 @@ public function getInverseRelationship()
  }
 
  /**
- * Links the related models back to the parent after the query has run
+ * Links the related models back to the parent after the query has run.
  *
  * @param string $relation
  * @return $this
  */
  public function inverse(string $relation)
  {
+ if (! $this->getModel()->isRelation($relation)) {
+ throw RelationNotFoundException::make($this->getModel(), $relation);
+ }
+
  if ($this->inverseRelationship === null && $relation) {
  $this->query->afterQuery(function ($result) {
  return $this->inverseRelationship
@@ -39,6 +44,18 @@ public function inverse(string $relation)
  return $this;
  }
 
+ /**
+ * Removes the inverse relationship for this query.
+ *
+ * @return $this
+ */
+ public function withoutInverse()
+ {
+ $this->inverseRelationship = null;
+
+ return $this;
+ }
+
  /**
  * @param \Illuminate\Database\Eloquent\Collection $models
  * @param \Illuminate\Database\Eloquent\Model|null $parent

src/Illuminate/Database/Eloquent/Relations/HasMany.php

@@ -13,11 +13,18 @@ class HasMany extends HasOneOrMany
  */
  public function one()
  {
- return HasOne::noConstraints(fn () => new HasOne(
- $this->getQuery(),
- $this->parent,
- $this->foreignKey,
- $this->localKey
+ return HasOne::noConstraints(fn () => tap(
+ new HasOne(
+ $this->getQuery(),
+ $this->parent,
+ $this->foreignKey,
+ $this->localKey
+ ),
+ function ($hasOne) {
+ if ($inverse = $this->getInverseRelationship()) {
+ $hasOne->inverse($inverse);
+ }
+ }
  ));
  }
 

src/Illuminate/Database/Eloquent/Relations/HasOne.php

@@ -119,9 +119,10 @@ public function addOneOfManyJoinSubQueryConstraints(JoinClause $join)
  */
  public function newRelatedInstanceFor(Model $parent)
  {
- return $this->related->newInstance()->setAttribute(
- $this->getForeignKeyName(), $parent->{$this->localKey}
- );
+ return tap($this->related->newInstance(), function ($instance) use ($parent) {
+ $instance->setAttribute($this->getForeignKeyName(), $parent->{$this->localKey});
+ $this->applyInverseRelationToModel($instance, $parent);
+ });
  }
 
  /**

src/Illuminate/Database/Eloquent/Relations/HasOneOrMany.php

@@ -6,11 +6,12 @@
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Concerns\InteractsWithDictionary;
+use Illuminate\Database\Eloquent\Relations\Concerns\SupportsInverseRelations;
 use Illuminate\Database\UniqueConstraintViolationException;
 
 abstract class HasOneOrMany extends Relation
 {
- use InteractsWithDictionary;
+ use InteractsWithDictionary, SupportsInverseRelations;
 
  /**
  * The foreign key of the parent model.
@@ -53,6 +54,7 @@ public function make(array $attributes = [])
  {
  return tap($this->related->newInstance($attributes), function ($instance) {
  $this->setForeignAttributesForCreate($instance);
+ $this->applyInverseRelationToModel($instance);
  });
  }
 
@@ -151,9 +153,13 @@ protected function matchOneOrMany(array $models, Collection $results, $relation,
  // matching very convenient and easy work. Then we'll just return them.
  foreach ($models as $model) {
  if (isset($dictionary[$key = $this->getDictionaryKey($model->getAttribute($this->localKey))])) {
- $model->setRelation(
- $relation, $this->getRelationValue($dictionary, $key, $type)
- );
+ $related = $this->getRelationValue($dictionary, $key, $type);
+ $model->setRelation($relation, $related);
+
+ // Apply the inverse relation if we have one
+ $type === 'one'
+ ? $this->applyInverseRelationToModel($related, $model)
+ : $this->applyInverseRelationToCollection($related, $model);
  }
  }
 
@@ -340,6 +346,8 @@ public function create(array $attributes = [])
  $this->setForeignAttributesForCreate($instance);
 
  $instance->save();
+
+ $this->applyInverseRelationToModel($instance);
  });
  }
 
@@ -364,7 +372,7 @@ public function forceCreate(array $attributes = [])
  {
  $attributes[$this->getForeignKeyName()] = $this->getParentKey();
 
- return $this->related->forceCreate($attributes);
+ return $this->applyInverseRelationToModel($this->related->forceCreate($attributes));
  }
 
  /**
@@ -415,6 +423,7 @@ public function createManyQuietly(iterable $records)
  protected function setForeignAttributesForCreate(Model $model)
  {
  $model->setAttribute($this->getForeignKeyName(), $this->getParentKey());
+ $this->applyInverseRelationToModel($model);
  }
 
  /**

src/Illuminate/Database/Eloquent/Relations/MorphMany.php

@@ -14,12 +14,19 @@ class MorphMany extends MorphOneOrMany
  */
  public function one()
  {
- return MorphOne::noConstraints(fn () => new MorphOne(
- $this->getQuery(),
- $this->getParent(),
- $this->morphType,
- $this->foreignKey,
- $this->localKey
+ return MorphOne::noConstraints(fn () => tap(
+ new MorphOne(
+ $this->getQuery(),
+ $this->getParent(),
+ $this->morphType,
+ $this->foreignKey,
+ $this->localKey
+ ),
+ function ($morphOne) {
+ if ($inverse = $this->getInverseRelationship()) {
+ $morphOne->inverse($inverse);
+ }
+ }
  ));
  }
 

src/Illuminate/Database/Eloquent/Relations/MorphOne.php

@@ -119,9 +119,12 @@ public function addOneOfManyJoinSubQueryConstraints(JoinClause $join)
  */
  public function newRelatedInstanceFor(Model $parent)
  {
- return $this->related->newInstance()
- ->setAttribute($this->getForeignKeyName(), $parent->{$this->localKey})
- ->setAttribute($this->getMorphType(), $this->morphClass);
+ return tap($this->related->newInstance(), function ($instance) use ($parent) {
+ $instance->setAttribute($this->getForeignKeyName(), $parent->{$this->localKey})
+ ->setAttribute($this->getMorphType(), $this->morphClass);
+
+ $this->applyInverseRelationToModel($instance, $parent);
+ });
  }
 
  /**

src/Illuminate/Database/Eloquent/Relations/MorphOneOrMany.php

@@ -78,7 +78,7 @@ public function forceCreate(array $attributes = [])
  $attributes[$this->getForeignKeyName()] = $this->getParentKey();
  $attributes[$this->getMorphType()] = $this->morphClass;
 
- return $this->related->forceCreate($attributes);
+ return $this->applyInverseRelationToModel($this->related->forceCreate($attributes));
  }
 
  /**
@@ -92,6 +92,8 @@ protected function setForeignAttributesForCreate(Model $model)
  $model->{$this->getForeignKeyName()} = $this->getParentKey();
 
  $model->{$this->getMorphType()} = $this->morphClass;
+
+ $this->applyInverseRelationToModel($model);
  }
 
  /**