Download the PHP package ahmadhsalim/eloquent-filter-resolver without Composer
On this page you can find all versions of the php package ahmadhsalim/eloquent-filter-resolver. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package eloquent-filter-resolver
Eloquent Filter Resolver
The Eloquent Filter Resolver is a package that allows you to resolve a filter string into an Eloquent query in Laravel. It provides a convenient way to filter Eloquent models based on various conditions and operators.
Installation
You can install the Eloquent Filter Resolver package via Composer. Run the following command:
Usage
To use the Eloquent Filter Resolver, follow the example below:
In the above example, we create an Eloquent query for the User
model and apply a filter using the Eloquent Filter Resolver. The filter string contains(name, "john") and eq(status, active)
filters the users whose names contain "john" and have an active status.
Supported Operators
The Eloquent Filter Resolver supports the following operators:
contains
: Performs a case-insensitive search using theLIKE
operator. UsesILIKE
forpgsql
driver. Usage:contains(field, value)
.eq
: Performs an equality comparison using the=
operator. Usage:eq(field, value)
.ne
: Performs a not-equal comparison using the!=
operator. Usage:ne(field, value)
.gt
: Performs a greater-than comparison using the>
operator. Usage:gt(field, value)
.gte
: Performs a greater-than-or-equal comparison using the>=
operator. Usage:gte(field, value)
.lt
: Performs a less-than comparison using the<
operator. Usage:lt(field, value)
.lte
: Performs a less-than-or-equal comparison using the<=
operator. Usage:lte(field, value)
.in
: Performs anIN
comparison for multiple values. Values can be separated by|
. Usage:in(field, "value1|value2|value3")
.notIn
: Performs aNOT IN
comparison for multiple values. Values can be separated by|
. Usage:notIn(field, "value1|value2|value3")
.
Value Formats
- Values can be enclosed in double quotes for strings. Example:
eq(name, "John Doe")
. - Values can have double quotes within the string by escaping them with a backslash (
\
). Example:eq(name, "John \"The Man\" Doe")
. - If a value contains commas, brackets, or spaces, it must be enclosed in double quotes. Example:
eq(name, "John Doe, Jr.")
.
Boolean and Null Values
- When the value is
"true"
or"false"
, it will be parsed as a boolean value. - When the value is
"null"
, it will be parsed asnull
.
Nested Brackets
The Eloquent Filter Resolver supports nested brackets to create complex filter expressions. For example:
In the above example, the filter condition checks if the name is "John" and the status is either "active" or "inactive".
Usage with Relations
The Eloquent Filter Resolver also supports filtering on related models using dot notation. For example:
In the above example, the filter condition checks if the related role
of the user
has a name equal to "admin".
Usage with Boolean and Null Values
Boolean and null values can be used in filter conditions as follows:
In the above example, the filter condition checks if the is_active
field is true and the deleted_at
field is null.
Contributing
Contributions to the Eloquent Filter Resolver package are welcome. If you find any issues or want to suggest improvements, please create a GitHub issue
License
The Eloquent Filter Resolver package is open-source software licensed under the MIT license.