Merge pull request #308 from lptn/fix-relation-return-type-after-orderBy

Fix MorphMany return type when orderBy used

stubs/Relation.stubphp

@@ -78,6 +78,26 @@ abstract class Relation
         return $this->query->get($columns);
     }
 
+    /**
+     * Add an "order by" clause for a timestamp to the query.
+     *
+     * Psalm note: ideally the type should be inferred from $this->query
+     *
+     * @param  string|\Illuminate\Database\Query\Expression  $column
+     * @return $this
+     */
+    public function latest($column = null) {}
+
+    /**
+     * Add an "order by" clause for a timestamp to the query.
+     *
+     * Psalm note: ideally the type should be inferred from $this->query
+     *
+     * @param  string|\Illuminate\Database\Query\Expression  $column
+     * @return $this
+     */
+    public function oldest($column = null) {}
+
     /**
      * Get the underlying query for the relation.
      *

tests/acceptance/EloquentRelationTypes.feature

@@ -222,16 +222,22 @@ Feature: Eloquent Relation types
     """
     final class Repository
     {
-      /**
-      * @psalm-return MorphMany<Comment>
-      */
+      /** @psalm-return MorphMany<Comment> */
       public function getCommentsRelation(Video $video): MorphMany {
         return $video->comments();
       }
 
-      /**
-      * @psalm-return Collection<int, Comment>
-      */
+      /** @psalm-return MorphMany<Comment> */
+      public function getLatestCommentsRelation(Video $video): MorphMany {
+        return $video->comments()->latest();
+      }
+
+      /** @psalm-return MorphMany<Comment> */
+      public function getOldestCommentsRelation(Video $video): MorphMany {
+        return $video->comments()->oldest();
+      }
+
+      /** @psalm-return Collection<int, Comment> */
       public function getComments(Video $video): Collection {
         return $video->comments;
       }