Skip to content

Commit 5541456

Browse files
lindyhopchrislindyhopchris
committed
[Refactor] Rename encoder params to query parameters
1 parent 9848151 commit 5541456

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+310
-309
lines changed

‎docs/basics/adapters.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ For example, this would create the following for a `posts` resource:
582582
namespace App\JsonApi\Posts;
583583

584584
use CloudCreativity\LaravelJsonApi\Adapter\AbstractResourceAdapter;
585-
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
585+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
586586
use CloudCreativity\LaravelJsonApi\Document\ResourceObject;
587587
use Illuminate\Support\Collection;
588588

@@ -624,7 +624,7 @@ class DummyClass extends AbstractResourceAdapter
624624
/**
625625
* @inheritDoc
626626
*/
627-
public function query(EncodingParametersInterface $parameters)
627+
public function query(QueryParametersInterface $parameters)
628628
{
629629
// TODO: Implement query() method.
630630
}

‎docs/features/media-types.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -370,14 +370,14 @@ data. For example:
370370
```php
371371
namespace App\JsonApi\Posts;
372372

373-
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
373+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
374374
use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;
375375

376376
class Adapter extends AbstractAdapter
377377
{
378378
// ...
379379

380-
public function create(array $document, EncodingParametersInterface $parameters)
380+
public function create(array $document, QueryParametersInterface $parameters)
381381
{
382382
if ($this->didDecode('application/json')) {
383383
$document = [

‎docs/fetching/pagination.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,10 +515,11 @@ For example:
515515

516516
```php
517517
use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PagingStrategyInterface;
518+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
518519

519520
class DateRangeStrategy implements PagingStrategyInterface
520521
{
521-
public function paginate($query, EncodingParametersInterface $pagingParameters)
522+
public function paginate($query, QueryParametersInterface $pagingParameters)
522523
{
523524
// ...paging logic here, that returns a JSON API page object.
524525
}

‎src/Adapter/AbstractRelationshipAdapter.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
namespace CloudCreativity\LaravelJsonApi\Adapter;
1919

2020
use CloudCreativity\LaravelJsonApi\Contracts\Adapter\RelationshipAdapterInterface;
21-
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
21+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
2222
use CloudCreativity\LaravelJsonApi\Contracts\Store\StoreAwareInterface;
2323
use CloudCreativity\LaravelJsonApi\Store\StoreAwareTrait;
2424

@@ -52,7 +52,7 @@ public function withFieldName($name)
5252
/**
5353
* @inheritdoc
5454
*/
55-
public function relationship($record, EncodingParametersInterface $parameters)
55+
public function relationship($record, QueryParametersInterface $parameters)
5656
{
5757
return $this->query($record, $parameters);
5858
}

‎src/Adapter/AbstractResourceAdapter.php‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
use CloudCreativity\LaravelJsonApi\Codec\ChecksMediaTypes;
2222
use CloudCreativity\LaravelJsonApi\Contracts\Adapter\RelationshipAdapterInterface;
2323
use CloudCreativity\LaravelJsonApi\Contracts\Adapter\ResourceAdapterInterface;
24-
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
24+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
2525
use CloudCreativity\LaravelJsonApi\Contracts\Queue\AsynchronousProcess;
2626
use CloudCreativity\LaravelJsonApi\Contracts\Store\StoreAwareInterface;
2727
use CloudCreativity\LaravelJsonApi\Document\ResourceObject;
@@ -86,7 +86,7 @@ abstract protected function destroy($record);
8686
/**
8787
* @inheritdoc
8888
*/
89-
public function create(array $document, EncodingParametersInterface $parameters)
89+
public function create(array $document, QueryParametersInterface $parameters)
9090
{
9191
$record = $this->createRecord(
9292
$resource = $this->deserialize($document)
@@ -98,15 +98,15 @@ public function create(array $document, EncodingParametersInterface $parameters)
9898
/**
9999
* @inheritDoc
100100
*/
101-
public function read($record, EncodingParametersInterface $parameters)
101+
public function read($record, QueryParametersInterface $parameters)
102102
{
103103
return $record;
104104
}
105105

106106
/**
107107
* @inheritdoc
108108
*/
109-
public function update($record, array $document, EncodingParametersInterface $parameters)
109+
public function update($record, array $document, QueryParametersInterface $parameters)
110110
{
111111
$resource = $this->deserialize($document, $record);
112112

@@ -116,7 +116,7 @@ public function update($record, array $document, EncodingParametersInterface $pa
116116
/**
117117
* @inheritDoc
118118
*/
119-
public function delete($record, EncodingParametersInterface $params)
119+
public function delete($record, QueryParametersInterface $params)
120120
{
121121
if ($result = $this->invoke('deleting', $record)) {
122122
return $result;
@@ -233,10 +233,10 @@ protected function methodForRelation($field)
233233
*
234234
* @param $record
235235
* @param ResourceObject $resource
236-
* @param EncodingParametersInterface $parameters
236+
* @param QueryParametersInterface $parameters
237237
* @return void
238238
*/
239-
protected function fill($record, ResourceObject $resource, EncodingParametersInterface $parameters)
239+
protected function fill($record, ResourceObject $resource, QueryParametersInterface $parameters)
240240
{
241241
$this->fillAttributes($record, $resource->getAttributes());
242242
$this->fillRelationships($record, $resource->getRelationships(), $parameters);
@@ -247,13 +247,13 @@ protected function fill($record, ResourceObject $resource, EncodingParametersInt
247247
*
248248
* @param $record
249249
* @param Collection $relationships
250-
* @param EncodingParametersInterface $parameters
250+
* @param QueryParametersInterface $parameters
251251
* @return void
252252
*/
253253
protected function fillRelationships(
254254
$record,
255255
Collection $relationships,
256-
EncodingParametersInterface $parameters
256+
QueryParametersInterface $parameters
257257
) {
258258
$relationships->filter(function ($value, $field) use ($record) {
259259
return $this->isFillableRelation($field, $record);
@@ -268,13 +268,13 @@ protected function fillRelationships(
268268
* @param $record
269269
* @param $field
270270
* @param array $relationship
271-
* @param EncodingParametersInterface $parameters
271+
* @param QueryParametersInterface $parameters
272272
*/
273273
protected function fillRelationship(
274274
$record,
275275
$field,
276276
array $relationship,
277-
EncodingParametersInterface $parameters
277+
QueryParametersInterface $parameters
278278
) {
279279
$relation = $this->getRelated($field);
280280

@@ -289,24 +289,24 @@ protected function fillRelationship(
289289
*
290290
* @param $record
291291
* @param ResourceObject $resource
292-
* @param EncodingParametersInterface $parameters
292+
* @param QueryParametersInterface $parameters
293293
*/
294-
protected function fillRelated($record, ResourceObject $resource, EncodingParametersInterface $parameters)
294+
protected function fillRelated($record, ResourceObject $resource, QueryParametersInterface $parameters)
295295
{
296296
// no-op
297297
}
298298

299299
/**
300300
* @param mixed $record
301301
* @param ResourceObject $resource
302-
* @param EncodingParametersInterface $parameters
302+
* @param QueryParametersInterface $parameters
303303
* @param bool $updating
304304
* @return AsynchronousProcess|mixed
305305
*/
306306
protected function fillAndPersist(
307307
$record,
308308
ResourceObject $resource,
309-
EncodingParametersInterface $parameters,
309+
QueryParametersInterface $parameters,
310310
$updating
311311
) {
312312
$this->fill($record, $resource, $parameters);

‎src/Broadcasting/BroadcastsData.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
namespace CloudCreativity\LaravelJsonApi\Broadcasting;
2020

2121
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\SerializerInterface;
22-
use CloudCreativity\LaravelJsonApi\Encoder\Parameters\EncodingParameters;
22+
use CloudCreativity\LaravelJsonApi\Http\Query\QueryParameters;
2323

2424
/**
2525
* Trait BroadcastsData
@@ -53,7 +53,7 @@ protected function broadcastEncoder()
5353
*/
5454
protected function serializeData($data, $includePaths = null, array $fieldsets = null)
5555
{
56-
$params = new EncodingParameters($includePaths ? (array) $includePaths : null, $fieldsets);
56+
$params = new QueryParameters($includePaths ? (array) $includePaths : null, $fieldsets);
5757

5858
return $this->broadcastEncoder()->serializeData($data, $params);
5959
}

‎src/Client/AbstractClient.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
namespace CloudCreativity\LaravelJsonApi\Client;
1919

2020
use CloudCreativity\LaravelJsonApi\Contracts\Client\ClientInterface;
21-
use CloudCreativity\LaravelJsonApi\Encoder\Parameters\EncodingParameters;
21+
use CloudCreativity\LaravelJsonApi\Http\Query\QueryParameters;
2222
use CloudCreativity\LaravelJsonApi\Exceptions\ClientException;
23-
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
23+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
2424
use Neomerx\JsonApi\Contracts\Schema\SchemaContainerInterface;
2525
use Neomerx\JsonApi\Http\Headers\MediaType;
2626
use Psr\Http\Message\ResponseInterface;
@@ -464,13 +464,13 @@ protected function jsonApiHeaders($body = false)
464464
}
465465

466466
/**
467-
* @param EncodingParametersInterface|array $parameters
467+
* @param QueryParametersInterface|array $parameters
468468
* @return array
469469
*/
470470
protected function queryParameters($parameters)
471471
{
472-
if ($parameters instanceof EncodingParametersInterface) {
473-
return EncodingParameters::cast($parameters)->toArray();
472+
if ($parameters instanceof QueryParametersInterface) {
473+
return QueryParameters::cast($parameters)->toArray();
474474
}
475475

476476
return $parameters;

‎src/Client/ClientSerializer.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
namespace CloudCreativity\LaravelJsonApi\Client;
1919

20-
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
20+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
2121
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\SerializerInterface;
2222
use CloudCreativity\LaravelJsonApi\Factories\Factory;
2323
use Illuminate\Support\Collection;
@@ -282,7 +282,7 @@ protected function doesRemoveLinks()
282282
}
283283

284284
/**
285-
* @return EncodingParametersInterface
285+
* @return QueryParametersInterface
286286
*/
287287
protected function createEncodingParameters()
288288
{

‎src/Contracts/Adapter/HasManyAdapterInterface.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
namespace CloudCreativity\LaravelJsonApi\Contracts\Adapter;
1919

20-
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
20+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
2121

2222
interface HasManyAdapterInterface extends RelationshipAdapterInterface
2323
{
@@ -31,11 +31,11 @@ interface HasManyAdapterInterface extends RelationshipAdapterInterface
3131
* @param mixed $record
3232
* @param array $relationship
3333
* The JSON API relationship object.
34-
* @param EncodingParametersInterface $parameters
34+
* @param QueryParametersInterface $parameters
3535
* @return object
3636
* the updated domain record.
3737
*/
38-
public function add($record, array $relationship, EncodingParametersInterface $parameters);
38+
public function add($record, array $relationship, QueryParametersInterface $parameters);
3939

4040
/**
4141
* Remove data from a domain record's relationship using data from the supplied relationship object.
@@ -47,10 +47,10 @@ public function add($record, array $relationship, EncodingParametersInterface $p
4747
* @param mixed $record
4848
* @param array $relationship
4949
* The JSON API relationship object.
50-
* @param EncodingParametersInterface $parameters
50+
* @param QueryParametersInterface $parameters
5151
* @return object
5252
* the updated domain record.
5353
*/
54-
public function remove($record, array $relationship, EncodingParametersInterface $parameters);
54+
public function remove($record, array $relationship, QueryParametersInterface $parameters);
5555

5656
}

‎src/Contracts/Adapter/RelationshipAdapterInterface.php‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
namespace CloudCreativity\LaravelJsonApi\Contracts\Adapter;
1919

20-
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
20+
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
2121

2222
interface RelationshipAdapterInterface
2323
{
@@ -37,10 +37,10 @@ public function withFieldName($field);
3737
* This method would be invoked providing the post that is being queried as the `$record` argument.
3838
*
3939
* @param mixed $record
40-
* @param EncodingParametersInterface $parameters
40+
* @param QueryParametersInterface $parameters
4141
* @return mixed
4242
*/
43-
public function query($record, EncodingParametersInterface $parameters);
43+
public function query($record, QueryParametersInterface $parameters);
4444

4545
/**
4646
* Query relationship data for the specified domain record.
@@ -49,10 +49,10 @@ public function query($record, EncodingParametersInterface $parameters);
4949
* This method would be invoked providing the post that is being queried as the `$record` argument.
5050
*
5151
* @param mixed $record
52-
* @param EncodingParametersInterface $parameters
52+
* @param QueryParametersInterface $parameters
5353
* @return mixed
5454
*/
55-
public function relationship($record, EncodingParametersInterface $parameters);
55+
public function relationship($record, QueryParametersInterface $parameters);
5656

5757
/**
5858
* Update a domain record's relationship when filling a resource's relationships.
@@ -66,22 +66,22 @@ public function relationship($record, EncodingParametersInterface $parameters);
6666
* @param mixed $record
6767
* @param array $relationship
6868
* The JSON API relationship object.
69-
* @param EncodingParametersInterface $parameters
69+
* @param QueryParametersInterface $parameters
7070
* @return object
7171
* the updated domain record.
7272
*/
73-
public function update($record, array $relationship, EncodingParametersInterface $parameters);
73+
public function update($record, array $relationship, QueryParametersInterface $parameters);
7474

7575
/**
7676
* Replace a domain record's relationship with data from the supplied relationship object.
7777
*
7878
* @param mixed $record
7979
* @param array $relationship
8080
* The JSON API relationship object.
81-
* @param EncodingParametersInterface $parameters
81+
* @param QueryParametersInterface $parameters
8282
* @return object
8383
* the updated domain record.
8484
*/
85-
public function replace($record, array $relationship, EncodingParametersInterface $parameters);
85+
public function replace($record, array $relationship, QueryParametersInterface $parameters);
8686

8787
}

0 commit comments

Comments
 (0)