Skip to content

Commit c42c50c

Browse files
GautierDeleGautierDele
authored
Merge pull request #27 from Lomkit/feature/rename-params
♻️ removed params from functions name
2 parents ff3006b + 4061457 commit c42c50c

32 files changed

+72
-72
lines changed

‎src/Concerns/Resource/ConfiguresRestParameters.php

+14-14
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@
1010
trait ConfiguresRestParameters
1111
{
1212
/**
13-
* The exposed fields that could be provided
13+
* The fields that could be provided
1414
* @param RestRequest $request
1515
* @return array
1616
*/
17-
public function exposedFields(RestRequest $request): array {
17+
public function fields(RestRequest $request): array {
1818
return [];
1919
}
2020

21-
public function getNestedExposedFields(RestRequest $request, string $prefix = '', array $loadedRelations = []) {
21+
public function getNestedFields(RestRequest $request, string $prefix = '', array $loadedRelations = []) {
2222
if ($prefix !== '') {
2323
$prefix = $prefix.'.';
2424
}
2525

26-
$exposedFields = array_map(
27-
function ($exposedField) use ($prefix) {
28-
return $prefix.$exposedField;
26+
$fields = array_map(
27+
function ($field) use ($prefix) {
28+
return $prefix.$field;
2929
},
30-
$this->exposedFields($request)
30+
$this->fields($request)
3131
);
3232

3333
foreach (
@@ -39,8 +39,8 @@ function ($exposedField) use ($prefix) {
3939
) {
4040
$loadedRelations[] = $relation->relation;
4141
array_push(
42-
$exposedFields,
43-
...$relation->resource()->getNestedExposedFields($request, $prefix.$relation->relation,$loadedRelations),
42+
$fields,
43+
...$relation->resource()->getNestedFields($request, $prefix.$relation->relation,$loadedRelations),
4444
// We push the pivot fields if they exists
4545
...(
4646
collect(method_exists($relation, 'getPivotFields') ? $relation->getPivotFields() : [])
@@ -49,24 +49,24 @@ function ($exposedField) use ($prefix) {
4949
);
5050
}
5151

52-
return $exposedFields;
52+
return $fields;
5353
}
5454

5555
/**
56-
* The exposed scopes that could be provided
56+
* The scopes that could be provided
5757
* @param RestRequest $request
5858
* @return array
5959
*/
60-
public function exposedScopes(RestRequest $request): array {
60+
public function scopes(RestRequest $request): array {
6161
return [];
6262
}
6363

6464
/**
65-
* The exposed limits that could be provided
65+
* The limits that could be provided
6666
* @param RestRequest $request
6767
* @return array
6868
*/
69-
public function exposedLimits(RestRequest $request): array {
69+
public function limits(RestRequest $request): array {
7070
return [
7171
10,
7272
25,

‎src/Concerns/Resource/Relationable.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public function nestedRelations(RestRequest $request, string $prefix = '', array
5454
}
5555

5656
/**
57-
* The exposed relations that could be provided
57+
* The relations that could be provided
5858
* @param RestRequest $request
5959
* @return array
6060
*/

‎src/Console/stubs/resource.stub

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class {{ class }} extends RestResource
1818
* @param RestRequest $request
1919
* @return array
2020
*/
21-
public function exposedFields(\Lomkit\Rest\Http\Requests\RestRequest $request): array
21+
public function fields(\Lomkit\Rest\Http\Requests\RestRequest $request): array
2222
{
2323
return [
2424
'id'
@@ -40,7 +40,7 @@ class {{ class }} extends RestResource
4040
* @param RestRequest $request
4141
* @return array
4242
*/
43-
public function exposedScopes(\Lomkit\Rest\Http\Requests\RestRequest $request): array
43+
public function scopes(\Lomkit\Rest\Http\Requests\RestRequest $request): array
4444
{
4545
return [];
4646
}
@@ -50,7 +50,7 @@ class {{ class }} extends RestResource
5050
* @param RestRequest $request
5151
* @return array
5252
*/
53-
public function exposedLimits(\Lomkit\Rest\Http\Requests\RestRequest $request): array
53+
public function limits(\Lomkit\Rest\Http\Requests\RestRequest $request): array
5454
{
5555
return [
5656
10,

‎src/Console/stubs/user-resource.stub

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class User extends RestResource
1818
* @param RestRequest $request
1919
* @return array
2020
*/
21-
public function exposedFields(\Lomkit\Rest\Http\Requests\RestRequest $request)
21+
public function fields(\Lomkit\Rest\Http\Requests\RestRequest $request)
2222
{
2323
return [
2424
'id',
@@ -42,7 +42,7 @@ class User extends RestResource
4242
* @param RestRequest $request
4343
* @return array
4444
*/
45-
public function exposedScopes(\Lomkit\Rest\Http\Requests\RestRequest $request) {
45+
public function scopes(\Lomkit\Rest\Http\Requests\RestRequest $request) {
4646
return [];
4747
}
4848

@@ -51,7 +51,7 @@ class User extends RestResource
5151
* @param RestRequest $request
5252
* @return array
5353
*/
54-
public function exposedLimits(\Lomkit\Rest\Http\Requests\RestRequest $request) {
54+
public function limits(\Lomkit\Rest\Http\Requests\RestRequest $request) {
5555
return [
5656
10,
5757
25,

‎src/Http/Requests/MutateRequest.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public function mutateRules(Resource $resource, $prefix = 'mutate.*', $loadedRel
3737
$prefix.'.attributes' => [
3838
'prohibited_if:'.$prefix.'.operation,attach',
3939
'prohibited_if:'.$prefix.'.operation,detach',
40-
'array:'.Arr::join($resource->exposedFields($this), ',')
40+
'array:'.Arr::join($resource->fields($this), ',')
4141
],
4242
$prefix.'.key' => [
4343
'required_if:'.$prefix.'.operation,update',

‎src/Http/Requests/SearchRequest.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public function searchRules(Resource $resource, $prefix = '', $isRootSearchRules
4040
[$prefix.'instructions' => ['sometimes', 'array']],
4141
$this->instructionsRules($resource, $prefix.'instructions'),
4242
[
43-
'limit' => ['sometimes', 'integer', Rule::in($resource->exposedLimits($this))],
43+
'limit' => ['sometimes', 'integer', Rule::in($resource->limits($this))],
4444
'page' => ['sometimes', 'integer']
4545
],
4646
$isRootSearchRules ? ['includes' => ['sometimes', 'array']] : [],
@@ -53,7 +53,7 @@ public function filtersRules(Resource $resource, string $prefix, $isMaxDepth = f
5353
$rules = array_merge(
5454
[
5555
$prefix.'.*.field' => [
56-
Rule::in($resource->getNestedExposedFields($this)),
56+
Rule::in($resource->getNestedFields($this)),
5757
"required_without:$prefix.*.nested",
5858
'string'
5959
],
@@ -86,7 +86,7 @@ public function filtersRules(Resource $resource, string $prefix, $isMaxDepth = f
8686
protected function scopesRules(Resource $resource, string $prefix) {
8787
$rules = [
8888
$prefix.'.*.name' => [
89-
Rule::in($resource->exposedScopes($this)),
89+
Rule::in($resource->scopes($this)),
9090
'required',
9191
'string'
9292
],
@@ -126,7 +126,7 @@ protected function instructionsRules(Resource $resource, string $prefix) {
126126
protected function sortsRules(Resource $resource, string $prefix) {
127127
$rules = [
128128
$prefix.'.*.field' => [
129-
Rule::in($resource->exposedFields($this)),
129+
Rule::in($resource->fields($this)),
130130
'required',
131131
'string'
132132
],
@@ -142,7 +142,7 @@ protected function sortsRules(Resource $resource, string $prefix) {
142142
protected function selectsRules(Resource $resource, string $prefix) {
143143
$rules = [
144144
$prefix.'.*.field' => [
145-
Rule::in($resource->exposedFields($this)),
145+
Rule::in($resource->fields($this)),
146146
'required',
147147
'string'
148148
]

‎src/Http/Resource.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ public function jsonSerialize(): mixed
8787
return [
8888
'actions' => collect($this->actions($request))->map->jsonSerialize()->toArray(),
8989
'instructions' => collect($this->instructions($request))->map->jsonSerialize()->toArray(),
90-
'fields' => $this->exposedFields($request),
91-
'limits' => $this->exposedLimits($request),
92-
'scopes' => $this->exposedScopes($request),
90+
'fields' => $this->fields($request),
91+
'limits' => $this->limits($request),
92+
'scopes' => $this->scopes($request),
9393
'relations' => collect($this->relations($request))->map->jsonSerialize()->toArray(),
9494
'rules' => [
9595
'all' => $this->rules($request),

‎src/Http/Response.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public function modelToResponse(Model $model, Resource $resource, array $request
5353
array_merge(
5454
isset($requestArray['selects']) ?
5555
collect($requestArray['selects'])->pluck('field')->toArray() :
56-
$resource->exposedFields(app()->make(RestRequest::class)),
56+
$resource->fields(app()->make(RestRequest::class)),
5757
// Here we add the aggregates
5858
collect($requestArray['aggregates'] ?? [])
5959
->map(function ($aggregate) {

‎src/Rules/AggregateField.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ protected function buildValidationRules($attribute, $value)
8888

8989
return [
9090
$attribute.'.field' => \Illuminate\Validation\Rule::in(
91-
$relationResource->exposedFields(app()->make(RestRequest::class))
91+
$relationResource->fields(app()->make(RestRequest::class))
9292
)
9393
];
9494
}

‎tests/Feature/Controllers/AutomaticGatingTest.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ public function test_searching_automatic_gated_resource_with_belongs_to_many_rel
356356
->get()
357357
->map(function ($relation) use ($matchingModel, $pivotAccessor) {
358358
return collect($relation->only(
359-
array_merge((new BelongsToManyResource)->exposedFields(app()->make(RestRequest::class)), [$pivotAccessor])
359+
array_merge((new BelongsToManyResource)->fields(app()->make(RestRequest::class)), [$pivotAccessor])
360360
))
361361
->pipe(function ($relation) use ($matchingModel, $pivotAccessor) {
362362
$relation[$pivotAccessor] = collect($relation[$pivotAccessor]->toArray())

‎tests/Feature/Controllers/SearchIncludingMorphRelationshipsOperationsTest.php

+6-6
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public function test_getting_a_list_of_resources_including_morph_to_relation():
7171
new ModelResource,
7272
[
7373
[
74-
'morph_to_relation' => $matchingModel->morphToRelation->only((new MorphToResource)->exposedFields(app()->make(RestRequest::class))),
74+
'morph_to_relation' => $matchingModel->morphToRelation->only((new MorphToResource)->fields(app()->make(RestRequest::class))),
7575
],
7676
[
7777
'morph_to_relation' => null,
@@ -111,7 +111,7 @@ public function test_getting_a_list_of_resources_including_morph_one_relation():
111111
[
112112
[
113113
'morph_one_relation' => $matchingModel->morphOneRelation->only(
114-
(new MorphOneResource)->exposedFields(app()->make(RestRequest::class))
114+
(new MorphOneResource)->fields(app()->make(RestRequest::class))
115115
),
116116
],
117117
[
@@ -152,7 +152,7 @@ public function test_getting_a_list_of_resources_including_morph_one_of_many_rel
152152
[
153153
[
154154
'morph_one_of_many_relation' => $matchingModel->morphOneOfManyRelation->only(
155-
(new MorphOneOfManyResource)->exposedFields(app()->make(RestRequest::class))
155+
(new MorphOneOfManyResource)->fields(app()->make(RestRequest::class))
156156
),
157157
],
158158
[
@@ -199,7 +199,7 @@ public function test_getting_a_list_of_resources_including_morph_many_relation()
199199
->get()
200200
->map(function ($relation) {
201201
return $relation->only(
202-
(new MorphManyResource)->exposedFields(app()->make(RestRequest::class))
202+
(new MorphManyResource)->fields(app()->make(RestRequest::class))
203203
);
204204
})->toArray(),
205205
],
@@ -245,7 +245,7 @@ public function test_getting_a_list_of_resources_including_morph_to_many_relatio
245245
->get()
246246
->map(function ($relation) use ($matchingModel, $pivotAccessor) {
247247
return collect($relation->only(
248-
array_merge((new MorphToManyResource)->exposedFields(app()->make(RestRequest::class)), [$pivotAccessor])
248+
array_merge((new MorphToManyResource)->fields(app()->make(RestRequest::class)), [$pivotAccessor])
249249
))
250250
->pipe(function ($relation) use ($matchingModel, $pivotAccessor) {
251251
$relation[$pivotAccessor] = collect($relation[$pivotAccessor]->toArray())
@@ -299,7 +299,7 @@ public function test_getting_a_list_of_resources_including_morphed_by_many_relat
299299
->get()
300300
->map(function ($relation) use ($matchingModel, $pivotAccessor) {
301301
return collect($relation->only(
302-
array_merge((new MorphedByManyResource)->exposedFields(app()->make(RestRequest::class)), [$pivotAccessor])
302+
array_merge((new MorphedByManyResource)->fields(app()->make(RestRequest::class)), [$pivotAccessor])
303303
))
304304
->pipe(function ($relation) use ($matchingModel, $pivotAccessor) {
305305
$relation[$pivotAccessor] = collect($relation[$pivotAccessor]->toArray())

‎tests/Feature/Controllers/SearchIncludingRelationshipsOperationsTest.php

+7-7
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public function test_getting_a_list_of_resources_including_belongs_to_relation()
7575
new ModelResource,
7676
[
7777
[
78-
'belongs_to_relation' => $matchingModel->belongsToRelation->only((new BelongsToResource)->exposedFields(app()->make(RestRequest::class))),
78+
'belongs_to_relation' => $matchingModel->belongsToRelation->only((new BelongsToResource)->fields(app()->make(RestRequest::class))),
7979
],
8080
[
8181
'belongs_to_relation' => null,
@@ -116,11 +116,11 @@ public function test_getting_a_list_of_resources_including_belongs_to_has_many_r
116116
[
117117
'belongs_to_relation' => array_merge(
118118
$matchingModelBelongsToRelation
119-
->only((new BelongsToResource)->exposedFields(app()->make(RestRequest::class))),
119+
->only((new BelongsToResource)->fields(app()->make(RestRequest::class))),
120120
[
121121
'models' => $matchingModelBelongsToRelation->models
122122
->map(function($model) {
123-
return $model->only((new ModelResource)->exposedFields(app()->make(RestRequest::class)));
123+
return $model->only((new ModelResource)->fields(app()->make(RestRequest::class)));
124124
})
125125
->toArray(),
126126
]
@@ -164,7 +164,7 @@ public function test_getting_a_list_of_resources_including_has_one_relation(): v
164164
[
165165
[
166166
'has_one_relation' => $matchingModel->hasOneRelation->only(
167-
(new HasOneResource)->exposedFields(app()->make(RestRequest::class))
167+
(new HasOneResource)->fields(app()->make(RestRequest::class))
168168
),
169169
],
170170
[
@@ -205,7 +205,7 @@ public function test_getting_a_list_of_resources_including_has_one_of_many_relat
205205
[
206206
[
207207
'has_one_of_many_relation' => $matchingModel->hasOneOfManyRelation->only(
208-
(new HasOneOfManyResource)->exposedFields(app()->make(RestRequest::class))
208+
(new HasOneOfManyResource)->fields(app()->make(RestRequest::class))
209209
),
210210
],
211211
[
@@ -252,7 +252,7 @@ public function test_getting_a_list_of_resources_including_has_many_relation():
252252
->get()
253253
->map(function ($relation) {
254254
return $relation->only(
255-
(new HasManyResource)->exposedFields(app()->make(RestRequest::class))
255+
(new HasManyResource)->fields(app()->make(RestRequest::class))
256256
);
257257
})->toArray(),
258258
],
@@ -298,7 +298,7 @@ public function test_getting_a_list_of_resources_including_belongs_to_many_relat
298298
->get()
299299
->map(function ($relation) use ($matchingModel, $pivotAccessor) {
300300
return collect($relation->only(
301-
array_merge((new BelongsToManyResource)->exposedFields(app()->make(RestRequest::class)), [$pivotAccessor])
301+
array_merge((new BelongsToManyResource)->fields(app()->make(RestRequest::class)), [$pivotAccessor])
302302
))
303303
->pipe(function ($relation) use ($matchingModel, $pivotAccessor) {
304304
$relation[$pivotAccessor] = collect($relation[$pivotAccessor]->toArray())

‎tests/Feature/Controllers/SearchIncludingThroughRelationshipsOperationsTest.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public function test_getting_a_list_of_resources_including_has_one_through_relat
6262
new ModelResource,
6363
[
6464
[
65-
'has_one_through_relation' => $matchingModel->hasOneThroughRelation->only((new HasOneThroughResource())->exposedFields(app()->make(RestRequest::class))),
65+
'has_one_through_relation' => $matchingModel->hasOneThroughRelation->only((new HasOneThroughResource())->fields(app()->make(RestRequest::class))),
6666
],
6767
[
6868
'has_one_through_relation' => null,
@@ -105,7 +105,7 @@ public function test_getting_a_list_of_resources_including_has_many_through_rela
105105
[
106106
'has_many_through_relation' => $matchingModel->hasManyThroughRelation->map(function ($relation) {
107107
return $relation->only(
108-
(new HasManyThroughResource)->exposedFields(app()->make(RestRequest::class))
108+
(new HasManyThroughResource)->fields(app()->make(RestRequest::class))
109109
);
110110
})->toArray(),
111111
],

‎tests/Support/Rest/Resources/AutomaticGatingResource.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public function relations(RestRequest $request): array
3636
];
3737
}
3838

39-
public function exposedFields(RestRequest $request): array
39+
public function fields(RestRequest $request): array
4040
{
4141
return [
4242
'id',

‎tests/Support/Rest/Resources/BelongsToManyResource.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public function relations(RestRequest $request): array
1818
return [];
1919
}
2020

21-
public function exposedFields(RestRequest $request): array
21+
public function fields(RestRequest $request): array
2222
{
2323
return [
2424
'id',

‎tests/Support/Rest/Resources/BelongsToResource.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public function relations(RestRequest $request): array
2222
];
2323
}
2424

25-
public function exposedFields(RestRequest $request): array
25+
public function fields(RestRequest $request): array
2626
{
2727
return [
2828
'id',

‎tests/Support/Rest/Resources/HasManyResource.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public function relations(RestRequest $request): array
1818
return [];
1919
}
2020

21-
public function exposedFields(RestRequest $request): array
21+
public function fields(RestRequest $request): array
2222
{
2323
return [
2424
'id',

0 commit comments

Comments
 (0)