70 lines (57 loc) · 4.18 KB

Laravel Query Builder Functions Index

This file is a clickable index of public package functions and common calls. Each documentation link jumps to the matching section in README.md.

Fluent API

Function	Call	Docs
`Query::for()`	`Query::for(User::class)`	README
`Query::extend()`	`Query::extend(Filter::class, ActiveUsersFilter::class)`	README
`schema()`	`->schema(UserSchema::class)`	README
`allowedFilters()`	`->allowedFilters(['email', AllowedFilter::partial('name')])`	README
`allowedSorts()`	`->allowedSorts(['name', 'created_at'])`	README
`allowedIncludes()`	`->allowedIncludes(['profile', 'roles.permissions'])`	README
`allowedFields()`	`->allowedFields(['id', 'name', 'email'])`	README
`tenantScoped()`	`->tenantScoped()`	README
`tenantScoped(false)`	`->tenantScoped(false)`	README
`tenantScoped(true, column)`	`->tenantScoped(true, 'account_id')`	README
`request()`	`->request(request())`	README
`cache()`	`->cache(60)`	README
`toEloquentBuilder()`	`->toEloquentBuilder()`	README
`get()`	`->get()`	README
`first()`	`->first()`	README
`paginate()`	`->paginate()`	README
`paginate(perPage)`	`->paginate(25)`	README

Filter Helpers

Function	Call	Docs
`AllowedFilter::exact()`	`AllowedFilter::exact('status')`	README
`AllowedFilter::partial()`	`AllowedFilter::partial('name')`	README
`AllowedFilter::scope()`	`AllowedFilter::scope('active')`	README
`AllowedFilter::custom()`	`AllowedFilter::custom('active', ActiveUsersFilter::class)`	README
`Filter::apply()`	`public function apply(Builder $query, mixed $value)`	README

Schema Methods

Function	Call	Docs
`filters()`	`public function filters(): array`	README
`sorts()`	`public function sorts(): array`	README
`includes()`	`public function includes(): array`	README
`fields()`	`public function fields(): array`	README
`filterOperators()`	`public function filterOperators(): array`	README
`customFilters()`	`public function customFilters(): array`	README

Legacy Trait API

Function	Call	Docs
`QueryBuild()`	`User::QueryBuild($request)`	README
`queryBuilder()`	`User::query()->queryBuilder($request)`	README
`paginateQuery()`	`User::query()->queryBuilder($request)->paginateQuery()`	README
`paginateTable()`	`User::query()->queryBuilder($request)->paginateTable()`	README

Exceptions

Function	Call	Docs
`errors()`	`$exception->errors()`	README

Engine API

Function	Call	Docs
`apply()`	`app(QueryBuilderEngine::class)->apply($builder, $request)`	README
`applyWithDefinition()`	`app(QueryBuilderEngine::class)->applyWithDefinition($builder, $request, $definition)`	README
`paginate()`	`app(QueryBuilderEngine::class)->paginate($builder, $request)`	README
`paginateTable()`	`app(QueryBuilderEngine::class)->paginateTable($builder, $request)`	README