Add withEmbeds property to control which relationships to load

Author: florianJacques

src/Eloquent/EmbedsRelations.php

@@ -4,13 +4,11 @@
 
 namespace MongoDB\Laravel\Eloquent;
 
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Str;
 use MongoDB\Laravel\Relations\EmbedsMany;
 use MongoDB\Laravel\Relations\EmbedsOne;
 use MongoDB\Laravel\Relations\EmbedsOneOrMany;
 
-use function array_keys;
 use function class_basename;
 use function debug_backtrace;
 use function is_a;
@@ -22,10 +20,17 @@
  */
 trait EmbedsRelations
 {
+    /**
+     * The embeds relations to load on every query.
+     *
+     * @var array
+     */
+    protected $withEmbeds = [];
+
     public static function bootEmbedsRelations(): void
     {
         static::retrieved(function (self $model) {
-            $model->withEmbedded();
+            $model->load($model->withEmbeds);
         });
     }
 
@@ -97,28 +102,6 @@ protected function embedsOne($related, $localKey = null, $foreignKey = null, $re
         return new EmbedsOne($query, $this, $instance, $localKey, $foreignKey, $relation);
     }
 
-    /**
-     * Load embedded relations on the model if they are not already loaded
-     *
-     * @param array|string $relations
-     *
-     * @return Model
-     */
-    public function withEmbedded($relations = [])
-    {
-        if (empty($relations)) {
-            $relations = [];
-
-            foreach (array_keys($this->getAttributes()) as $key) {
-                if ($this->isEmbeddedRelation($key)) {
-                    $relations[] = $key;
-                }
-            }
-        }
-
-        return $this->loadMissing($relations);
-    }
-
     /**
      * Determine if the given key is an embed relationship method on the model.
      *

tests/EmbeddedRelationsTest.php

@@ -11,6 +11,7 @@
 use MongoDB\BSON\ObjectId;
 use MongoDB\Laravel\Tests\Models\Address;
 use MongoDB\Laravel\Tests\Models\User;
+use MongoDB\Laravel\Tests\Models\UserWithEmbeds;
 
 use function array_merge;
 
@@ -20,6 +21,7 @@ public function tearDown(): void
     {
         Mockery::close();
         User::truncate();
+        UserWithEmbeds::truncate();
 
         parent::tearDown();
     }
@@ -975,11 +977,11 @@ public function testUnsetPropertyOnEmbed()
 
     public function testEmbedManyToArrayCast()
     {
-        $user = User::create(['name' => 'John Doe']);
+        $user = UserWithEmbeds::create(['name' => 'John Doe']);
         $user->addresses()->saveMany([new Address(['city' => 'London'])]);
 
         //Reload document
-        $user = User::where('name', 'John Doe')->first();
+        $user = UserWithEmbeds::where('name', 'John Doe')->first();
         $array = $user->toArray();
 
         $this->assertIsString($array['addresses'][0]['id']);

tests/Models/UserWithEmbeds.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Tests\Models;
+
+class UserWithEmbeds extends User
+{
+    protected $withEmbeds = ['addresses'];
+}