Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fbsouzas/flery-builder
A Laravel query builder package.
https://github.com/fbsouzas/flery-builder
eloquent laravel laravel-framework query-builder querystrings
Last synced: about 1 month ago
JSON representation
A Laravel query builder package.
- Host: GitHub
- URL: https://github.com/fbsouzas/flery-builder
- Owner: fbsouzas
- License: mit
- Created: 2021-01-29T21:38:06.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-13T17:15:41.000Z (over 3 years ago)
- Last Synced: 2024-09-29T11:45:24.132Z (about 2 months ago)
- Topics: eloquent, laravel, laravel-framework, query-builder, querystrings
- Language: PHP
- Homepage:
- Size: 119 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.MD
Awesome Lists containing this project
README
# Flery-builder
A Laravel package to write, easy and flexible Eloquent query builder.
## Installation
```shell
composer install fbsouzas/flery-builder
```
## Usage
```php
apply($request->all())
->get();
// or
return FleryBuilder::to(User::class)
->apply([
'where' => [
'name' => 'Joe Doe',
],
])
->get();
```
You can use FleryBuilder combine with other Laravel query builder functions.
For example:
```php
apply($request->all())
->where(['name' => 'Joe Doe'])
->get();
// or
return FleryBuilder::to(User::class)
->apply($request->all())
->join('contacts', function ($join) {
$join->on('users.id', '=', 'contacts.user_id')
->where('contacts.user_id', '>', 5);
}))
->get();
// or
return FleryBuilder::to(User::class)
->apply($request->all())
->whereJsonContains('options->languages', ['en', 'br'])
->get();
// and etc.
```
## Examples
### Select
```php
// That will return only the user's first name.
GET /api/users?fields=first_name
// or
// That will return only the user's first name and last name.
GET /api/users?fields=first_name,last_name
```
### With
```php
// That will return the user and his contact information.
GET /api/users?with=contact
// or
// That will return the user and his contact information and posts.
GET /api/users?with=contact;posts
// or
// That will return the user and just his posts title.
GET /api/users?with=posts:id,title
```
### Like
```php
// That will return all users that have joe in their first names.
GET /api/users?search[first_name]=joe
```
### Order by
```php
// That will return a user's list ascendant ordered by the first name.
GET /api/users?sort=first_name
// or
// That will return a user's list descendant ordered by the first name.
GET /api/users?sort=-first_name
```
## Requirements
- This package needs PHP 7.4 or above.
## Testing
```shell
composer test
```
## Credits
- [Fábio Souza](https://github.com/fbsouzas)
*This package was inspired by [Spatie's Laravel Query Builder](https://github.com/spatie/laravel-query-builder)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.