README

在Laravel / Lumen上使用请求API响应简化查询构建器 / 构建优雅查询

此包具有根据请求进行过滤、排序和包含关系的功能。BITBuilder可以应用于Laravel的默认Eloquent构建器和查询构建器。查询参数名称遵循JSON API规范。

快速安装

composer require cacing69/bitbuilder

如何与Eloquent一起使用

use App\Models\User;
use Cacing69\BITBuilder\FactoryBuilder;
use Cacing69\BITBuilder\Filterable;
use Cacing69\BITBuilder\Sortable;
...
public function index(Request $request)
{
	$factory = new FactoryBuilder();

	$data = $factory->on(User::class)
			->addFilters([
				// do filter on db based on request ex : url?filter[id]=1 will generate query where user_id = 1
				Filterable::exact("id", "user_id"), // fill second parameter, if u want to make alias on request

				// do filter on db based on request ex : url?filter[foo]=lorem
				Filterable::like("foo", "column_foo", Filterable::LIKE_BEGIN) // generate query where column_foo like "lorem%"
				// OR Filterable::like("fist_name", "user_first_name", Filterable::LIKE_END) // generate query where column_foo like "%lorem"
				// OR Filterable::like("fist_name", "user_first_name", Filterable::LIKE_BEGIN_END) // generate query where column_foo like "%lorem%"
			])
			->addSorts([
				Sortable::field('id', 'user_id') // will allow to sort via request url?sort_by=id (DESC), url?sort_by=-id (ASC)
			])
			->defaultSort("user_id") // will sort user by user_id DESC, u can use -user_id to make sort by ASC
			->limit(20) // add limitation u can call force to show all data with method $obj->showAllData(true);
			->with("media") // call eloquent relation
			->where("user_blocked", 1) // add wehre clause on User
			->setCursor("last_id"); // optional if u want to cursor pagination
			->get(); // u can paginate also there -> paginate(20);
}

如何与查询构建器一起使用

use DB;
use Cacing69\BITBuilder\FactoryBuilder;
use Cacing69\BITBuilder\Filterable;
use Cacing69\BITBuilder\Sortable;
...
public function index(Request $request)
{
	$factory = new FactoryBuilder();

	$data = $factory->on(DB::table("t_user"))
			... // same as before
}

想要添加更多功能

您可以帮我修复此包的结构，因为我是为了必要的目的在很短的时间内制作了这个，任何PR都非常欢迎，谢谢

许可

MIT许可（MIT）。请参阅许可文件获取更多信息。