Skip to content

Commit f49fea9

Browse files
committed
feat: publish config file of query-builder package
1 parent 43dc283 commit f49fea9

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

config/query-builder.php

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php
2+
3+
return [
4+
5+
/*
6+
* By default the package will use the `include`, `filter`, `sort`
7+
* and `fields` query parameters as described in the readme.
8+
*
9+
* You can customize these query string parameters here.
10+
*/
11+
'parameters' => [
12+
'include' => 'include',
13+
14+
'filter' => 'filter',
15+
16+
'sort' => 'sort',
17+
18+
'fields' => 'fields',
19+
20+
'append' => 'append',
21+
],
22+
23+
/*
24+
* Related model counts are included using the relationship name suffixed with this string.
25+
* For example: GET /users?include=postsCount
26+
*/
27+
'count_suffix' => 'Count',
28+
29+
/*
30+
* Related model exists are included using the relationship name suffixed with this string.
31+
* For example: GET /users?include=postsExists
32+
*/
33+
'exists_suffix' => 'Exists',
34+
35+
/*
36+
* By default the package will throw an `InvalidFilterQuery` exception when a filter in the
37+
* URL is not allowed in the `allowedFilters()` method.
38+
*/
39+
'disable_invalid_filter_query_exception' => false,
40+
41+
/*
42+
* By default the package will throw an `InvalidSortQuery` exception when a sort in the
43+
* URL is not allowed in the `allowedSorts()` method.
44+
*/
45+
'disable_invalid_sort_query_exception' => false,
46+
];

0 commit comments

Comments
 (0)