Optimize Model::isDocumentModel

Author: GromNaN

src/Eloquent/Model.php

@@ -8,6 +8,7 @@
 
 use function array_key_exists;
 use function class_uses_recursive;
+use function is_object;
 use function is_subclass_of;
 
 abstract class Model extends BaseModel
@@ -28,16 +29,36 @@ abstract class Model extends BaseModel
      */
     protected $keyType = 'string';
 
+    private static $documentModelClasses = [];
+
     /**
      * Indicates if the given model class is a MongoDB document model.
      * It must be a subclass of {@see BaseModel} and use the
      * {@see DocumentModel} trait.
      *
-     * @param class-string|object $related
+     * @param class-string|object $classOrObject
      */
-    public static function isDocumentModel(string|object $related): bool
+    public static function isDocumentModel(string|object $classOrObject): bool
     {
-        return is_subclass_of($related, BaseModel::class)
-            && array_key_exists(DocumentModel::class, class_uses_recursive($related));
+        if (is_object($classOrObject)) {
+            $classOrObject = $classOrObject::class;
+        }
+
+        if (array_key_exists($classOrObject, self::$documentModelClasses)) {
+            return self::$documentModelClasses[$classOrObject];
+        }
+
+        // We know all child classes of this class are document models.
+        if (is_subclass_of($classOrObject, self::class)) {
+            return self::$documentModelClasses[$classOrObject] = true;
+        }
+
+        // Document models must be subclasses of Laravel's base model class.
+        if (! is_subclass_of($classOrObject, BaseModel::class)) {
+            return self::$documentModelClasses[$classOrObject] = false;
+        }
+
+        // Document models must use the DocumentModel trait.
+        return self::$documentModelClasses[$classOrObject] = array_key_exists(DocumentModel::class, class_uses_recursive($classOrObject));
     }
 }

tests/Eloquent/ModelTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace MongoDB\Laravel\Tests\Eloquent;
+
+use Generator;
+use Illuminate\Database\Eloquent\Model as BaseModel;
+use MongoDB\Laravel\Auth\User;
+use MongoDB\Laravel\Eloquent\DocumentModel;
+use MongoDB\Laravel\Eloquent\Model;
+use MongoDB\Laravel\Tests\Models\Book;
+use MongoDB\Laravel\Tests\Models\Casting;
+use MongoDB\Laravel\Tests\Models\SqlBook;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+class ModelTest extends TestCase
+{
+    #[DataProvider('provideDocumentModelClasses')]
+    public function testIsDocumentModel(bool $expected, string|object $classOrObject): void
+    {
+        $this->assertSame($expected, Model::isDocumentModel($classOrObject));
+    }
+
+    public static function provideDocumentModelClasses(): Generator
+    {
+        // Test classes
+        yield [false, SqlBook::class];
+        yield [true, Casting::class];
+        yield [true, Book::class];
+
+        // Provided by the Laravel MongoDB package.
+        yield [true, User::class];
+
+        // Instances of objects
+        yield [false, new SqlBook()];
+        yield [true, new Book()];
+
+        // Anonymous classes
+        yield [
+            true,
+            new class extends Model {
+            },
+        ];
+        yield [
+            true,
+            new class extends BaseModel {
+                use DocumentModel;
+            },
+        ];
+        yield [
+            false,
+            new class {
+                use DocumentModel;
+            },
+        ];
+        yield [
+            false,
+            new class extends BaseModel {
+            },
+        ];
+    }
+}

tests/Models/CastObjectId.php

@@ -4,16 +4,11 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
-use Illuminate\Database\Eloquent\Model;
 use MongoDB\Laravel\Eloquent\Casts\ObjectId;
-use MongoDB\Laravel\Eloquent\DocumentModel;
+use MongoDB\Laravel\Eloquent\Model;
 
 class CastObjectId extends Model
 {
-    use DocumentModel;
-
-    protected $primaryKey = '_id';
-    protected $keyType = 'string';
     protected $connection = 'mongodb';
     protected static $unguarded = true;
     protected $casts            = [

tests/Models/Casting.php

@@ -4,16 +4,11 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
-use Illuminate\Database\Eloquent\Model;
 use MongoDB\Laravel\Eloquent\Casts\BinaryUuid;
-use MongoDB\Laravel\Eloquent\DocumentModel;
+use MongoDB\Laravel\Eloquent\Model;
 
 class Casting extends Model
 {
-    use DocumentModel;
-
-    protected $primaryKey = '_id';
-    protected $keyType = 'string';
     protected $connection = 'mongodb';
     protected string $collection = 'casting';