<?php

[0] Fix | Delete

namespace Automattic\WooCommerce\StoreApi\Utilities;

[1] Fix | Delete

[2] Fix | Delete

/**

[3] Fix | Delete

* Pagination class.

[4] Fix | Delete

*/

[5] Fix | Delete

class Pagination {

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Add pagination headers to a response object.

[9] Fix | Delete

*

[10] Fix | Delete

* @param \WP_REST_Response $response Reference to the response object.

[11] Fix | Delete

* @param \WP_REST_Request $request The request object.

[12] Fix | Delete

* @param int $total_items Total items found.

[13] Fix | Delete

* @param int $total_pages Total pages found.

[14] Fix | Delete

* @return \WP_REST_Response

[15] Fix | Delete

*/

[16] Fix | Delete

public function add_headers( $response, $request, $total_items, $total_pages ) {

[17] Fix | Delete

$response->header( 'X-WP-Total', $total_items );

[18] Fix | Delete

$response->header( 'X-WP-TotalPages', $total_pages );

[19] Fix | Delete

[20] Fix | Delete

$current_page = $this->get_current_page( $request );

[21] Fix | Delete

$link_base = $this->get_link_base( $request );

[22] Fix | Delete

[23] Fix | Delete

if ( $current_page > 1 ) {

[24] Fix | Delete

$previous_page = $current_page - 1;

[25] Fix | Delete

if ( $previous_page > $total_pages ) {

[26] Fix | Delete

$previous_page = $total_pages;

[27] Fix | Delete

}

[28] Fix | Delete

$this->add_page_link( $response, 'prev', $previous_page, $link_base );

[29] Fix | Delete

}

[30] Fix | Delete

[31] Fix | Delete

if ( $total_pages > $current_page ) {

[32] Fix | Delete

$this->add_page_link( $response, 'next', ( $current_page + 1 ), $link_base );

[33] Fix | Delete

}

[34] Fix | Delete

[35] Fix | Delete

return $response;

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Get current page.

[40] Fix | Delete

*

[41] Fix | Delete

* @param \WP_REST_Request $request The request object.

[42] Fix | Delete

* @return int Get the page from the request object.

[43] Fix | Delete

*/

[44] Fix | Delete

protected function get_current_page( $request ) {

[45] Fix | Delete

return (int) $request->get_param( 'page' );

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Get base for links from the request object.

[50] Fix | Delete

*

[51] Fix | Delete

* @param \WP_REST_Request $request The request object.

[52] Fix | Delete

* @return string

[53] Fix | Delete

*/

[54] Fix | Delete

protected function get_link_base( $request ) {

[55] Fix | Delete

return esc_url( add_query_arg( $request->get_query_params(), rest_url( $request->get_route() ) ) );

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Add a page link.

[60] Fix | Delete

*

[61] Fix | Delete

* @param \WP_REST_Response $response Reference to the response object.

[62] Fix | Delete

* @param string $name Page link name. e.g. prev.

[63] Fix | Delete

* @param int $page Page number.

[64] Fix | Delete

* @param string $link_base Base URL.

[65] Fix | Delete

*/

[66] Fix | Delete

protected function add_page_link( &$response, $name, $page, $link_base ) {

[67] Fix | Delete

$response->link_header( $name, add_query_arg( 'page', $page, $link_base ) );

[68] Fix | Delete

}

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete