Easier encoding for paging links

[neomerx]

Easier encoding for paging links

[lindyhopchris]

@neomerx

Think the withPagingLinks method might work. How would you include other links (i.e. links that aren't paging related) in the same links object in the document that is encoded? E.g. if the document links object was to include self as a link as well as the paging links?

The other thing to bear in mind about paging links is they are not only limited to the top level (document) scope. For the spec:

To paginate the primary data, supply pagination links in the top-level links object. To paginate an included collection returned in a compound document, supply pagination links in the corresponding links object.

I think an example of the latter is providing pagination links in the links object on a has-many relationship. Would your paging links generator approach work for that too?

[neomerx]

How would you include other links

You can combine those methods. If a link key is used more than once the last Link value will be used

$encoder
    ->withPagingLinks([Link::FIRST, Link::FIRST, ...], $pageLinksGenerator)
    ->withLinks([...])
    ->encodeData(...);

The other thing to bear in mind about paging links is they are not only limited to the top level

Very good point. Similar kind of helper method is needed to be accessible from Schema (from method getRelationships in particular). I can't figure out syntax of that method however it should be similar to withPagingLinks. These links will be placed in links section of the relationship.

[lindyhopchris]

You can combine those methods

Ah yep, had missed that. Works nicely.

I can't figure out syntax of that method however it should be similar to withPagingLinks

Definitely makes sense to try to keep the method signatures as close as possible.

[neomerx]

That's another piece of paging puzzle

[lindyhopchris]

@neomerx what's the complication with that? I'd take that doc page with a pinch of salt as the example server response isn't JSON API, plus Ember Data v2.0 will be built to default to the JSON API spec.

[neomerx]

Ember drives me crazy 😄 I'be been spending past two days with Ember documentation, samples and videos. I just want to do a simple form with fields for attributes and combo/drop-down-list/select for one of the relationships with all data taken from backend.

Looking for paging was't my priority but that link was the only I found. And yes you right it's not relevant 😄

[neomerx]

Let's say we have data which were filtered and sorted before it's passed to Encoder. How can we look at those data and say which filtering and sorting parameters were applied? We can't. Thus it's a fundamentally wrong idea to generate URLs based on provided data. The party which sends data to encoder should compose proper URLs. The lib currently provides all the means for that.

I'm closing this open question.