Bug 19369

Summary: Add a helper function for translating pagination params into SQL::Abstract
Product: Koha Reporter: Tomás Cohen Arazi <tomascohen>
Component: REST APIAssignee: Tomás Cohen Arazi <tomascohen>
Status: CLOSED FIXED QA Contact:
Severity: enhancement    
Priority: P5 - low CC: lari.taskula, martin.renvoize, nick
Version: Main   
Hardware: All   
OS: All   
Change sponsored?: --- Patch complexity: ---
Documentation contact: Documentation submission:
Text to go in the release notes:
Version(s) released in:
Bug Depends on: 19234    
Bug Blocks: 18731, 19278, 19410    
Attachments: Bug 19369: Unit tests
Bug 19369: Add helper function for pagination attributes generation
Bug 19369: Unit tests
Bug 19369: Add helper function for pagination attributes generation
Bug 19369: Unit tests
Bug 19369: Add helper function for pagination attributes generation
Bug 19369: Unit tests
Bug 19369: Add helper function for pagination attributes generation

Description Tomás Cohen Arazi 2017-09-26 18:04:16 UTC
It would be handy to have a helper function in Koha::REST::Plugin::Pagination generating 'page' and 'rows' attributes out of the query params, to be used when listing objects on the REST api endpoints.
Comment 1 Tomás Cohen Arazi 2017-09-26 18:15:55 UTC Comment hidden (obsolete)
Comment 2 Tomás Cohen Arazi 2017-09-26 18:15:58 UTC Comment hidden (obsolete)
Comment 3 Tomás Cohen Arazi 2017-09-26 18:31:09 UTC
Created attachment 67381 [details] [review]
Bug 19369: Unit tests
Comment 4 Tomás Cohen Arazi 2017-09-26 18:31:15 UTC
Created attachment 67382 [details] [review]
Bug 19369: Add helper function for pagination attributes generation

This patch introduces a new helper function to the Koha::REST::Plugin::Pagination
plugin, called 'dbic_merge_pagination'.

This simple function adds SQL::Abstract pagination attributes ('page' and 'rows') to the
passed $filter hashref.

To test:
- Apply this patches
- Run:
  $ koha-shell kohadev
 k$ cd kohaclone
 k$ prove t/Koha/REST/Plugin/Pagination.t
=> SUCCESS: Tests pass!
- Sign off :-D

Sponsored-by: Camden County
Comment 5 Lari Taskula 2017-10-03 10:45:27 UTC
Created attachment 67544 [details] [review]
Bug 19369: Unit tests

Signed-off-by: Lari Taskula <lari.taskula@jns.fi>
Comment 6 Lari Taskula 2017-10-03 10:45:43 UTC
Created attachment 67545 [details] [review]
Bug 19369: Add helper function for pagination attributes generation

This patch introduces a new helper function to the Koha::REST::Plugin::Pagination
plugin, called 'dbic_merge_pagination'.

This simple function adds SQL::Abstract pagination attributes ('page' and 'rows') to the
passed $filter hashref.

To test:
- Apply this patches
- Run:
  $ koha-shell kohadev
 k$ cd kohaclone
 k$ prove t/Koha/REST/Plugin/Pagination.t
=> SUCCESS: Tests pass!
- Sign off :-D

Sponsored-by: Camden County

Signed-off-by: Lari Taskula <lari.taskula@jns.fi>
Comment 7 Kyle M Hall 2017-11-27 11:35:50 UTC
Created attachment 69363 [details] [review]
Bug 19369: Unit tests

Signed-off-by: Lari Taskula <lari.taskula@jns.fi>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Comment 8 Kyle M Hall 2017-11-27 11:35:56 UTC
Created attachment 69364 [details] [review]
Bug 19369: Add helper function for pagination attributes generation

This patch introduces a new helper function to the Koha::REST::Plugin::Pagination
plugin, called 'dbic_merge_pagination'.

This simple function adds SQL::Abstract pagination attributes ('page' and 'rows') to the
passed $filter hashref.

To test:
- Apply this patches
- Run:
  $ koha-shell kohadev
 k$ cd kohaclone
 k$ prove t/Koha/REST/Plugin/Pagination.t
=> SUCCESS: Tests pass!
- Sign off :-D

Sponsored-by: Camden County

Signed-off-by: Lari Taskula <lari.taskula@jns.fi>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Comment 9 Jonathan Druart 2017-12-11 20:47:37 UTC
Pushed to master for 18.05, thanks to everybody involved!
Comment 10 Nick Clemens 2017-12-20 11:40:59 UTC
Awesome work all! Enhancement, won't be backported to 17.11