Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add ability to filter by nested relation scopes #519

Merged
merged 1 commit into from
Oct 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/Filters/FiltersScope.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,21 @@ class FiltersScope implements Filter
{
public function __invoke(Builder $query, $values, string $property): Builder
{
$scope = Str::camel($property);
$propertyParts = Str::of($property)->explode('.');

$scope = Str::camel($propertyParts->pop());

$values = array_values(Arr::wrap($values));
$values = $this->resolveParameters($query, $values, $scope);

$relation = $propertyParts->implode('.');

if ($relation) {
return $query->whereHas($relation, function (Builder $query) use ($scope, $values) {
return $query->$scope(...$values);
});
}

return $query->$scope(...$values);
}

Expand Down
15 changes: 15 additions & 0 deletions tests/FilterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,21 @@ public function it_can_filter_results_by_scope()
$this->assertCount(1, $modelsResult);
}

/** @test */
public function it_can_filter_results_by_nested_relation_scope()
{
$testModel = TestModel::create(['name' => 'John Testing Doe']);

$testModel->relatedModels()->create(['name' => 'John\'s Post']);

$modelsResult = $this
->createQueryFromFilterRequest(['relatedModels.named' => 'John\'s Post'])
->allowedFilters(AllowedFilter::scope('relatedModels.named'))
->get();

$this->assertCount(1, $modelsResult);
}

/** @test */
public function it_can_filter_results_by_type_hinted_scope()
{
Expand Down
6 changes: 6 additions & 0 deletions tests/TestClasses/Models/RelatedModel.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Spatie\QueryBuilder\Tests\TestClasses\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
Expand All @@ -21,4 +22,9 @@ public function nestedRelatedModels(): HasMany
{
return $this->hasMany(NestedRelatedModel::class);
}

public function scopeNamed(Builder $query, string $name): Builder
{
return $query->where('name', $name);
}
}