Improve phpdoc

Author: GromNaN

src/Eloquent/EmbedsRelations.php

@@ -3,6 +3,7 @@
 namespace MongoDB\Laravel\Eloquent;
 
 use Illuminate\Support\Str;
+use MongoDB\Laravel\Eloquent\Model as MongoDBModel;
 use MongoDB\Laravel\Relations\EmbedsMany;
 use MongoDB\Laravel\Relations\EmbedsOne;
 use ReflectionMethod;
@@ -21,11 +22,11 @@ trait EmbedsRelations
     /**
      * Define an embedded one-to-many relationship.
      *
-     * @param string $related
+     * @param class-string<MongoDBModel> $related
      * @param string $localKey
      * @param string $foreignKey
      * @param string $relation
-     * @return \MongoDB\Laravel\Relations\EmbedsMany
+     * @return EmbedsMany
      */
     protected function embedsMany($related, $localKey = null, $foreignKey = null, $relation = null)
     {
@@ -54,11 +55,11 @@ protected function embedsMany($related, $localKey = null, $foreignKey = null, $r
     /**
      * Define an embedded one-to-many relationship.
      *
-     * @param string $related
+     * @param class-string<MongoDBModel> $related
      * @param string $localKey
      * @param string $foreignKey
      * @param string $relation
-     * @return \MongoDB\Laravel\Relations\EmbedsOne
+     * @return EmbedsOne
      */
     protected function embedsOne($related, $localKey = null, $foreignKey = null, $relation = null)
     {
@@ -103,7 +104,7 @@ private function hasEmbeddedRelation(string $key): bool
 
         $returnType = (new ReflectionMethod($this, $method))->getReturnType();
 
-        return static::$embeddedCache[static::class][$key] = $returnType instanceof ReflectionNamedType
+        return self::$embeddedCache[static::class][$key] = $returnType instanceof ReflectionNamedType
             && in_array($returnType->getName(), [EmbedsOne::class, EmbedsMany::class], true);
     }
 }

src/Eloquent/HybridRelations.php

@@ -2,8 +2,10 @@
 
 namespace MongoDB\Laravel\Eloquent;
 
+use Illuminate\Database\Eloquent\Model as EloquentModel;
 use Illuminate\Database\Eloquent\Relations\MorphOne;
 use Illuminate\Support\Str;
+use MongoDB\Laravel\Eloquent\Model as MongoDBModel;
 use MongoDB\Laravel\Helpers\EloquentBuilder;
 use MongoDB\Laravel\Relations\BelongsTo;
 use MongoDB\Laravel\Relations\BelongsToMany;
@@ -21,15 +23,15 @@ trait HybridRelations
     /**
      * Define a one-to-one relationship.
      *
-     * @param string $related
+     * @param class-string<EloquentModel> $related
      * @param string $foreignKey
      * @param string $localKey
      * @return \Illuminate\Database\Eloquent\Relations\HasOne
      */
     public function hasOne($related, $foreignKey = null, $localKey = null)
     {
         // Check if it is a relation with an original model.
-        if (! is_subclass_of($related, Model::class)) {
+        if (! is_subclass_of($related, MongoDBModel::class)) {
             return parent::hasOne($related, $foreignKey, $localKey);
         }
 
@@ -45,7 +47,7 @@ public function hasOne($related, $foreignKey = null, $localKey = null)
     /**
      * Define a polymorphic one-to-one relationship.
      *
-     * @param string $related
+     * @param class-string<EloquentModel> $related
      * @param string $name
      * @param string $type
      * @param string $id
@@ -55,7 +57,7 @@ public function hasOne($related, $foreignKey = null, $localKey = null)
     public function morphOne($related, $name, $type = null, $id = null, $localKey = null)
     {
         // Check if it is a relation with an original model.
-        if (! is_subclass_of($related, Model::class)) {
+        if (! is_subclass_of($related, MongoDBModel::class)) {
             return parent::morphOne($related, $name, $type, $id, $localKey);
         }
 
@@ -71,15 +73,15 @@ public function morphOne($related, $name, $type = null, $id = null, $localKey =
     /**
      * Define a one-to-many relationship.
      *
-     * @param string $related
+     * @param class-string<EloquentModel> $related
      * @param string $foreignKey
      * @param string $localKey
      * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function hasMany($related, $foreignKey = null, $localKey = null)
     {
         // Check if it is a relation with an original model.
-        if (! is_subclass_of($related, Model::class)) {
+        if (! is_subclass_of($related, MongoDBModel::class)) {
             return parent::hasMany($related, $foreignKey, $localKey);
         }
 
@@ -95,7 +97,7 @@ public function hasMany($related, $foreignKey = null, $localKey = null)
     /**
      * Define a polymorphic one-to-many relationship.
      *
-     * @param string $related
+     * @param class-string<EloquentModel> $related
      * @param string $name
      * @param string $type
      * @param string $id
@@ -105,7 +107,7 @@ public function hasMany($related, $foreignKey = null, $localKey = null)
     public function morphMany($related, $name, $type = null, $id = null, $localKey = null)
     {
         // Check if it is a relation with an original model.
-        if (! is_subclass_of($related, Model::class)) {
+        if (! is_subclass_of($related, MongoDBModel::class)) {
             return parent::morphMany($related, $name, $type, $id, $localKey);
         }
 
@@ -126,7 +128,7 @@ public function morphMany($related, $name, $type = null, $id = null, $localKey =
     /**
      * Define an inverse one-to-one or many relationship.
      *
-     * @param string $related
+     * @param class-string<EloquentModel> $related
      * @param string $foreignKey
      * @param string $otherKey
      * @param string $relation
@@ -142,7 +144,7 @@ public function belongsTo($related, $foreignKey = null, $otherKey = null, $relat
         }
 
         // Check if it is a relation with an original model.
-        if (! is_subclass_of($related, Model::class)) {
+        if (! is_subclass_of($related, MongoDBModel::class)) {
             return parent::belongsTo($related, $foreignKey, $otherKey, $relation);
         }
 
@@ -211,7 +213,7 @@ public function morphTo($name = null, $type = null, $id = null, $ownerKey = null
     /**
      * Define a many-to-many relationship.
      *
-     * @param class-string<\Illuminate\Database\Eloquent\Model> $related
+     * @param class-string<EloquentModel> $related
      * @param string|null $collection
      * @param string|null $foreignKey
      * @param string|null $otherKey
@@ -237,7 +239,7 @@ public function belongsToMany(
         }
 
         // Check if it is a relation with an original model.
-        if (! is_subclass_of($related, Model::class)) {
+        if (! is_subclass_of($related, MongoDBModel::class)) {
             return parent::belongsToMany(
                 $related,
                 $collection,
@@ -306,7 +308,7 @@ protected function guessBelongsToManyRelation()
      */
     public function newEloquentBuilder($query)
     {
-        if (is_subclass_of($this, Model::class)) {
+        if (is_subclass_of($this, MongoDBModel::class)) {
             return new Builder($query);
         }