Skip to content
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
2 changes: 1 addition & 1 deletion src/Commands/FilterableDiscoverCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

use ReflectionClass;
use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Eloquent\Model;
Expand Down
2 changes: 1 addition & 1 deletion src/Engines/Contracts/Appliable.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Kettasoft\Filterable\Engines\Contracts;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;

interface Appliable
{
Expand Down
6 changes: 3 additions & 3 deletions src/Engines/Contracts/Executable.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

namespace Kettasoft\Filterable\Engines\Contracts;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;

interface Executable
{
/**
* Execute using the given query builder instance.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return \Illuminate\Database\Eloquent\Builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return \Illuminate\Contracts\Database\Eloquent\Builder
*/
public function execute(Builder $builder);
}
4 changes: 2 additions & 2 deletions src/Engines/Expression.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Kettasoft\Filterable\Engines;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Support\Payload;
use Kettasoft\Filterable\Engines\Foundation\Engine;
use Kettasoft\Filterable\Support\ConditionNormalizer;
Expand All @@ -22,7 +22,7 @@ class Expression extends Engine

/**
* Apply filters to the query.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return Builder
*/
public function execute(Builder $builder): Builder
Expand Down
2 changes: 1 addition & 1 deletion src/Engines/Foundation/Appliers/Applier.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Kettasoft\Filterable\Engines\Foundation\Appliers;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Engines\Contracts\Appliable;

abstract class Applier
Expand Down
2 changes: 1 addition & 1 deletion src/Engines/Foundation/Clause.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Kettasoft\Filterable\Engines\Foundation;

use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Contracts\Support\Arrayable;
use Kettasoft\Filterable\Engines\Foundation\Parsers\Dissector;
Expand Down
10 changes: 5 additions & 5 deletions src/Engines/Foundation/ClauseApplier.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Kettasoft\Filterable\Engines\Foundation;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Engines\Contracts\Appliable;

class ClauseApplier implements Appliable
Expand All @@ -15,8 +15,8 @@ public function __construct(protected Clause $clause) {}

/**
* Apply a Clause to the query builder.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return \Illuminate\Database\Eloquent\Builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return \Illuminate\Contracts\Database\Eloquent\Builder
*/
public function apply(Builder $builder): Builder
{
Expand All @@ -33,7 +33,7 @@ public function apply(Builder $builder): Builder

/**
* Apply a direct (non-relational) clause to the query.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return Builder
*/
protected function applyDirect(Builder $builder)
Expand All @@ -43,7 +43,7 @@ protected function applyDirect(Builder $builder)

/**
* Apply a relational clause to the query.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return Builder
*/
protected function applyRelational(Builder $builder)
Expand Down
4 changes: 2 additions & 2 deletions src/Engines/Foundation/Engine.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

use Illuminate\Support\Arr;
use Kettasoft\Filterable\Filterable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Foundation\Resources;
use Kettasoft\Filterable\Engines\Contracts\Skippable;
use Kettasoft\Filterable\Engines\Contracts\Executable;
Expand All @@ -30,7 +30,7 @@ abstract public function getEngineName(): string;

/**
* Apply filters to the query.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return Builder
*/
abstract public function execute(Builder $builder);
Expand Down
6 changes: 3 additions & 3 deletions src/Engines/Foundation/Executors/Executer.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

namespace Kettasoft\Filterable\Engines\Foundation\Executors;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Engines\Contracts\Executable;

trait Executer
{
/**
* Execute the given Executable instance with the provided query builder instance.
* @param \Kettasoft\Filterable\Engines\Contracts\Executable $executable
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return \Illuminate\Database\Eloquent\Builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return \Illuminate\Contracts\Database\Eloquent\Builder
*/
public static function execute(Executable $executable, Builder $builder)
{
Expand Down
4 changes: 2 additions & 2 deletions src/Engines/Invokable.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

use Illuminate\Support\Str;
use Kettasoft\Filterable\Filterable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Support\Payload;
use Illuminate\Support\Traits\ForwardsCalls;
use Kettasoft\Filterable\Engines\Foundation\Engine;
Expand Down Expand Up @@ -32,7 +32,7 @@ class Invokable extends Engine

/**
* Apply filters to the query.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return Builder
*/
public function execute(Builder $builder): Builder
Expand Down
4 changes: 2 additions & 2 deletions src/Engines/Ruleset.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Kettasoft\Filterable\Engines;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Support\Payload;
use Kettasoft\Filterable\Traits\FieldNormalizer;
use Kettasoft\Filterable\Engines\Foundation\Engine;
Expand All @@ -23,7 +23,7 @@ class Ruleset extends Engine

/**
* Apply filters to the query.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return Builder
*/
public function execute(Builder $builder): Builder
Expand Down
6 changes: 3 additions & 3 deletions src/Engines/Tree.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Kettasoft\Filterable\Engines;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Support\Payload;
use Kettasoft\Filterable\Support\TreeNode;
use Kettasoft\Filterable\Traits\FieldNormalizer;
Expand All @@ -23,7 +23,7 @@ class Tree extends Engine

/**
* Apply filters to the query.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @return Builder
*/
public function execute(Builder $builder): Builder
Expand All @@ -35,7 +35,7 @@ public function execute(Builder $builder): Builder

/**
* Apply tree node to the query builder.
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder $builder
* @param \Kettasoft\Filterable\Support\TreeNode $node
* @return Builder
*/
Expand Down
10 changes: 5 additions & 5 deletions src/Facades/Filterable.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
* Core Filtering Methods:
* @method static \Kettasoft\Filterable\Foundation\Resources getResources() Get Resources instance.
* @method static \Kettasoft\Filterable\Foundation\FilterableSettings settings() Get FilterableSettings instance.
* @method static \Kettasoft\Filterable\Foundation\Invoker|\Illuminate\Database\Eloquent\Builder apply(\Illuminate\Database\Eloquent\Builder|null $builder = null) Apply all filters.
* @method static \Kettasoft\Filterable\Foundation\Invoker|\Illuminate\Database\Eloquent\Builder filter(\Illuminate\Database\Eloquent\Builder|null $builder = null) Alias name for apply method.
* @method static \Kettasoft\Filterable\Foundation\Invoker|\Illuminate\Contracts\Database\Eloquent\Builder apply(\Illuminate\Contracts\Database\Eloquent\Builder|null $builder = null) Apply all filters.
* @method static \Kettasoft\Filterable\Foundation\Invoker|\Illuminate\Contracts\Database\Eloquent\Builder filter(\Illuminate\Contracts\Database\Eloquent\Builder|null $builder = null) Alias name for apply method.
* @method static \Kettasoft\Filterable\Filterable sorting(callable|string|\Kettasoft\Filterable\Foundation\Contracts\Sorting\Invokable $sorting) Define sorting rules for the current filterable instance.
* @method static \Kettasoft\Filterable\Filterable shouldReturnQueryBuilder() Should return Query Builder instance when invoke apply.
*
Expand Down Expand Up @@ -108,11 +108,11 @@
* @method static \Kettasoft\Filterable\Filterable setFieldsMap(mixed $fields, bool $override = true) Set fields wrapper.
*
* Builder Management:
* @method static \Illuminate\Database\Eloquent\Builder getBuilder() Get registered filter builder.
* @method static \Kettasoft\Filterable\Filterable setBuilder(\Illuminate\Database\Eloquent\Builder $builder) Set a new builder.
* @method static \Illuminate\Contracts\Database\Eloquent\Builder getBuilder() Get registered filter builder.
* @method static \Kettasoft\Filterable\Filterable setBuilder(\Illuminate\Contracts\Database\Eloquent\Builder $builder) Set a new builder.
*
* SQL Export:
* @method static string toSql(\Illuminate\Database\Eloquent\Builder|null $builder = null, mixed $withBindings = false) Get the SQL representation of the filtered query.
* @method static string toSql(\Illuminate\Contracts\Database\Eloquent\Builder|null $builder = null, mixed $withBindings = false) Get the SQL representation of the filtered query.
*
* @see \Kettasoft\Filterable\Filterable
*/
Expand Down
10 changes: 5 additions & 5 deletions src/Filterable.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
use Illuminate\Support\Facades\App;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Traits\Macroable;
use Illuminate\Database\Eloquent\Builder;
use Kettasoft\Filterable\Foundation\Invoker;
use Kettasoft\Filterable\Contracts\Commitable;
use Kettasoft\Filterable\Foundation\Resources;
use Kettasoft\Filterable\Contracts\Validatable;
use Kettasoft\Filterable\Contracts\Authorizable;
use Kettasoft\Filterable\Sanitization\Sanitizer;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Engines\Foundation\Clause;
use Kettasoft\Filterable\Engines\Foundation\Engine;
use Kettasoft\Filterable\Foundation\Sorting\Sorter;
Expand Down Expand Up @@ -493,7 +493,7 @@ public function shouldReturnQueryBuilder()

/**
* Alias name for @apply method.
* @param \Illuminate\Database\Eloquent\Builder|null $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder|null $builder
* @return Invoker|Builder
*/
public function filter(Builder|null $builder = null): Invoker|Builder
Expand All @@ -514,7 +514,7 @@ public static function aliases(array $aliases)

/**
* Initialize query builder instance.
* @param \Illuminate\Database\Eloquent\Builder|null $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder|null $builder
* @throws \Kettasoft\Filterable\Exceptions\MissingBuilderException
*/
private function initQueryBuilderInstance(Builder|null $builder = null)
Expand Down Expand Up @@ -614,7 +614,7 @@ public function unless(bool $condition, callable $callback)
/**
* Allow the query to pass through a custom pipeline of pipes (callables).
*
* @param array<callable(\Illuminate\Database\Eloquent\Builder, static): \Illuminate\Database\Eloquent\Builder> $pipes
* @param array<callable(\Illuminate\Contracts\Database\Eloquent\Builder, static): \Illuminate\Contracts\Database\Eloquent\Builder> $pipes
* @return static
* @link https://kettasoft.github.io/filterable/features/through
*/
Expand Down Expand Up @@ -933,7 +933,7 @@ public function autoSetAllowedFieldsFromModel(bool $override = false): static

/**
* Get the SQL representation of the filtered query.
* @param \Illuminate\Database\Eloquent\Builder|null $builder
* @param \Illuminate\Contracts\Database\Eloquent\Builder|null $builder
* @param mixed $withBindings
* @return string
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Foundation/Caching/CacheKeyGenerator.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Kettasoft\Filterable\Foundation\Caching;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Illuminate\Support\Str;

/**
Expand Down
2 changes: 1 addition & 1 deletion src/Foundation/Contracts/QueryBuilderInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
use Illuminate\Contracts\Database\Query\Builder as QueryBuilder;

/**
* @mixin \Illuminate\Database\Query\Builder|\Illuminate\Database\Eloquent\Builder
* @mixin \Illuminate\Database\Query\Builder|\Illuminate\Contracts\Database\Eloquent\Builder
*/
interface QueryBuilderInterface extends EloquentBuilder, QueryBuilder {}
4 changes: 2 additions & 2 deletions src/Foundation/Contracts/Sortable.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

namespace Kettasoft\Filterable\Foundation\Contracts;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;

interface Sortable
{
/**
* Apply sorting to the query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Contracts\Database\Eloquent\Builder $query
* @return Builder
*/
public function apply(Builder $query): Builder;
Expand Down
2 changes: 1 addition & 1 deletion src/Foundation/Invoker.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
use function Opis\Closure\{serialize, unserialize};
use Illuminate\Database\Query\Builder as QueryBuilder;
use Kettasoft\Filterable\Foundation\Profiler\Profiler;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Contracts\Database\Eloquent\Builder as EloquentBuilder;
use Kettasoft\Filterable\Foundation\Contracts\HasDynamicCalls;

use Kettasoft\Filterable\Foundation\Traits\HandleFluentReturn;
Expand Down
2 changes: 1 addition & 1 deletion src/Foundation/Profiler/Profiler.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
namespace Kettasoft\Filterable\Foundation\Profiler;

use Illuminate\Support\Facades\DB;
use Illuminate\Foundation\Application;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Events\QueryExecuted;
use Illuminate\Foundation\Application;
use Kettasoft\Filterable\Foundation\Profiler\Events\ProfilerEventDispatcher;
use Kettasoft\Filterable\Foundation\Profiler\Contracts\ProfilerStorageContract;
use Kettasoft\Filterable\Foundation\Profiler\Traits\HasProfilerEventDispatcher;
Expand Down
8 changes: 4 additions & 4 deletions src/Foundation/Sorting/Sorter.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Kettasoft\Filterable\Foundation\Sorting;

use Illuminate\Http\Request;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder;
use Kettasoft\Filterable\Engines\Contracts\Appliable;
use Kettasoft\Filterable\Foundation\Contracts\Sortable;

Expand Down Expand Up @@ -254,7 +254,7 @@ public function setNullsPosition(string|null $position = null): self
/**
* Apply sorting to the query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Contracts\Database\Eloquent\Builder $query
* @return Builder
*/
public function apply(Builder $query): Builder
Expand Down Expand Up @@ -298,7 +298,7 @@ public function apply(Builder $query): Builder
* Apply sorting aliases to the query.
*
* @param string $sortInput
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Contracts\Database\Eloquent\Builder $query
* @return void
*/
protected function applyAliases(array $fields, Builder $query): void
Expand All @@ -316,7 +316,7 @@ protected function applyAliases(array $fields, Builder $query): void
* Apply default sorting pattern to the query.
*
* @param array<int, array{0: string, 1: string}> $pattern
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Contracts\Database\Eloquent\Builder $query
* @return void
*/
protected function applyDefault(array $pattern, Builder $query): void
Expand Down
2 changes: 1 addition & 1 deletion src/Providers/AutoRegisterFilterableServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

use Illuminate\Support\ServiceProvider;
use Illuminate\Database\Eloquent\Builder;
use Kettasoft\Filterable\Contracts\FilterableContext;
use Kettasoft\Filterable\Support\FilterResolver;
use Kettasoft\Filterable\Contracts\FilterableContext;

class AutoRegisterFilterableServiceProvider extends ServiceProvider
{
Expand Down
Loading