fix!: amend return type to self on query classes (#31)

Author: ennorehling

CHANGELOG.md

@@ -9,12 +9,12 @@ All notable changes to this project will be documented in this file. This projec
 
 - **BREAKING** Package now requires Laravel 11.
 - Minimum PHP version is now `8.2`.
+- Use `assert()` within fillable relation field classes rather as an optimisation.
 
-## Unreleased
-
-### Changed
+### Fixed
 
-- Use `assert()` within fillable relation field classes rather as an optimisation.
+- [#31](https://github.com/laravel-json-api/eloquent/pull/31) **BREAKING** Use `self` as return type on Eloquent query
+  classes. This is potentially breaking any of these classes have been extended.
 
 ## [3.1.0] - 2023-10-29
 

src/HasQueryParameters.php

@@ -21,7 +21,6 @@
 
 use Illuminate\Http\Request;
 use LaravelJsonApi\Contracts\Query\QueryParameters as QueryParametersContract;
-use LaravelJsonApi\Contracts\Store\Builder as BuilderContract;
 use LaravelJsonApi\Core\Query\Custom\ExtendedQueryParameters;
 
 trait HasQueryParameters
@@ -40,7 +39,7 @@ trait HasQueryParameters
     /**
      * @inheritDoc
      */
-    public function withRequest(Request $request): BuilderContract
+    public function withRequest(Request $request): self
     {
         $this->request = $request;
         $this->queryParameters = ExtendedQueryParameters::cast($request);
@@ -51,7 +50,7 @@ public function withRequest(Request $request): BuilderContract
     /**
      * @inheritDoc
      */
-    public function withQuery(QueryParametersContract $query): BuilderContract
+    public function withQuery(QueryParametersContract $query): self
     {
         $this->queryParameters = ExtendedQueryParameters::cast($query);
 
@@ -61,7 +60,7 @@ public function withQuery(QueryParametersContract $query): BuilderContract
     /**
      * @inheritDoc
      */
-    public function with($includePaths): BuilderContract
+    public function with($includePaths): self
     {
         $this->queryParameters->setIncludePaths($includePaths);
 
@@ -70,13 +69,12 @@ public function with($includePaths): BuilderContract
 
     /**
      * @param mixed $countable
-     * @return BuilderContract
+     * @return $this
      */
-    public function withCount($countable): BuilderContract
+    public function withCount($countable): self
     {
         $this->queryParameters->setCountable($countable);
 
         return $this;
     }
-
 }

src/QueryMorphTo.php

@@ -57,7 +57,7 @@ public function __construct(Model $model, MorphTo $relation)
     /**
      * @inheritDoc
      */
-    public function filter(?array $filters): QueryOneBuilder
+    public function filter(?array $filters): self
     {
         $this->queryParameters->setFilters($filters);
 

src/QueryMorphToMany.php

@@ -71,7 +71,7 @@ public function __construct(Schema $schema, Model $model, MorphToMany $relation)
     /**
      * @inheritDoc
      */
-    public function filter(?array $filters): QueryManyBuilder
+    public function filter(?array $filters): self
     {
         $this->queryParameters->setFilters($filters);
 
@@ -81,7 +81,7 @@ public function filter(?array $filters): QueryManyBuilder
     /**
      * @inheritDoc
      */
-    public function sort($fields): QueryManyBuilder
+    public function sort($fields): self
     {
         $this->queryParameters->setSortFields($fields);
 

src/QueryOne.php

@@ -106,7 +106,7 @@ public function query(): JsonApiBuilder
     /**
      * @inheritDoc
      */
-    public function filter(?array $filters): QueryOneBuilderContract
+    public function filter(?array $filters): self
     {
         $this->queryParameters->setFilters($filters);
 

src/QueryToMany.php

@@ -68,7 +68,7 @@ public function __construct(Schema $schema, Model $model, ToMany $relation)
     /**
      * @inheritDoc
      */
-    public function filter(?array $filters): QueryManyBuilder
+    public function filter(?array $filters): self
     {
         $this->queryParameters->setFilters($filters);
 
@@ -78,7 +78,7 @@ public function filter(?array $filters): QueryManyBuilder
     /**
      * @inheritDoc
      */
-    public function sort($fields): QueryManyBuilder
+    public function sort($fields): self
     {
         $this->queryParameters->setSortFields($fields);
 

src/QueryToOne.php

@@ -22,7 +22,6 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation as EloquentRelation;
 use LaravelJsonApi\Contracts\Store\QueryOneBuilder;
-use LaravelJsonApi\Contracts\Store\QueryOneBuilder as QueryOneBuilderContract;
 use LaravelJsonApi\Core\Query\Custom\ExtendedQueryParameters;
 use LaravelJsonApi\Eloquent\Fields\Relations\ToOne;
 use LaravelJsonApi\Eloquent\QueryBuilder\JsonApiBuilder;
@@ -59,7 +58,7 @@ public function __construct(Model $model, ToOne $relation)
     /**
      * @inheritDoc
      */
-    public function filter(?array $filters): QueryOneBuilderContract
+    public function filter(?array $filters): self
     {
         $this->queryParameters->setFilters($filters);