Fix return type of FromQuery::query() (#3485)

SpartnerNL · Jan 4, 2022 · e3d9b7e · e3d9b7e
1 parent 6f171c8
commit e3d9b7e
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+- Fix return type of `FromQuery::query()`
+
 ## [3.1.35] - 2022-01-04
 
 ### Fixed

diff --git a/src/Concerns/FromQuery.php b/src/Concerns/FromQuery.php
@@ -2,12 +2,14 @@
 
 namespace Maatwebsite\Excel\Concerns;
 
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 
 interface FromQuery
 {
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query();
 }
diff --git a/tests/Data/Stubs/FromGroupUsersQueuedQueryExport.php b/tests/Data/Stubs/FromGroupUsersQueuedQueryExport.php
@@ -3,6 +3,8 @@
 namespace Maatwebsite\Excel\Tests\Data\Stubs;
 
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 use Maatwebsite\Excel\Concerns\Exportable;
 use Maatwebsite\Excel\Concerns\FromQuery;
@@ -15,7 +17,7 @@ class FromGroupUsersQueuedQueryExport implements FromQuery, WithCustomChunkSize,
     use Exportable;
 
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query()
     {

diff --git a/tests/Data/Stubs/FromNestedArraysQueryExport.php b/tests/Data/Stubs/FromNestedArraysQueryExport.php
@@ -2,6 +2,8 @@
 
 namespace Maatwebsite\Excel\Tests\Data\Stubs;
 
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 use Maatwebsite\Excel\Concerns\Exportable;
 use Maatwebsite\Excel\Concerns\FromQuery;
@@ -13,7 +15,7 @@ class FromNestedArraysQueryExport implements FromQuery, WithMapping
     use Exportable;
 
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query()
     {

diff --git a/tests/Data/Stubs/FromNonEloquentQueryExport.php b/tests/Data/Stubs/FromNonEloquentQueryExport.php
@@ -2,6 +2,8 @@
 
 namespace Maatwebsite\Excel\Tests\Data\Stubs;
 
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Facades\DB;
 use Maatwebsite\Excel\Concerns\Exportable;
@@ -13,7 +15,7 @@ class FromNonEloquentQueryExport implements FromQuery, WithCustomChunkSize
     use Exportable;
 
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query()
     {

diff --git a/tests/Data/Stubs/FromQueryWithCustomQuerySize.php b/tests/Data/Stubs/FromQueryWithCustomQuerySize.php
@@ -3,6 +3,8 @@
 namespace Maatwebsite\Excel\Tests\Data\Stubs;
 
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Facades\DB;
 use Maatwebsite\Excel\Concerns\Exportable;
@@ -16,7 +18,7 @@ class FromQueryWithCustomQuerySize implements FromQuery, WithCustomQuerySize, Wi
     use Exportable;
 
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query()
     {

diff --git a/tests/Data/Stubs/FromUsersQueryExport.php b/tests/Data/Stubs/FromUsersQueryExport.php
@@ -2,6 +2,8 @@
 
 namespace Maatwebsite\Excel\Tests\Data\Stubs;
 
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 use Maatwebsite\Excel\Concerns\Exportable;
 use Maatwebsite\Excel\Concerns\FromQuery;
@@ -13,7 +15,7 @@ class FromUsersQueryExport implements FromQuery, WithCustomChunkSize
     use Exportable;
 
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query()
     {

diff --git a/tests/Data/Stubs/FromUsersQueryExportWithEagerLoad.php b/tests/Data/Stubs/FromUsersQueryExportWithEagerLoad.php
@@ -2,6 +2,8 @@
 
 namespace Maatwebsite\Excel\Tests\Data\Stubs;
 
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 use Maatwebsite\Excel\Concerns\Exportable;
 use Maatwebsite\Excel\Concerns\FromQuery;
@@ -13,7 +15,7 @@ class FromUsersQueryExportWithEagerLoad implements FromQuery, WithMapping
     use Exportable;
 
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query()
     {

diff --git a/tests/Data/Stubs/FromUsersQueryExportWithMapping.php b/tests/Data/Stubs/FromUsersQueryExportWithMapping.php
@@ -2,6 +2,8 @@
 
 namespace Maatwebsite\Excel\Tests\Data\Stubs;
 
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 use Maatwebsite\Excel\Concerns\Exportable;
 use Maatwebsite\Excel\Concerns\FromQuery;
@@ -15,7 +17,7 @@ class FromUsersQueryExportWithMapping implements FromQuery, WithMapping, WithEve
     use Exportable;
 
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query()
     {

diff --git a/tests/Data/Stubs/FromUsersQueryExportWithPrepareRows.php b/tests/Data/Stubs/FromUsersQueryExportWithPrepareRows.php
@@ -2,6 +2,8 @@
 
 namespace Maatwebsite\Excel\Tests\Data\Stubs;
 
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Collection;
 use Maatwebsite\Excel\Concerns\Exportable;
@@ -14,7 +16,7 @@ class FromUsersQueryExportWithPrepareRows implements FromQuery, WithCustomChunkS
     use Exportable;
 
     /**
-     * @return Builder
+     * @return Builder|EloquentBuilder|Relation
      */
     public function query()
     {