Added page limit for orders and customers history

This commit is contained in:
max-baranikov 2021-07-07 16:42:41 +03:00 committed by GitHub
parent 27816dcddf
commit 132e53eaed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 120 additions and 0 deletions

View File

@ -65,6 +65,7 @@ class RetailcrmHistory
->setParams(array($filter, '{{page}}'))
->setDataKey('history')
->setLimit(100)
->setPageLimit(50)
->execute()
->getData();
@ -204,6 +205,7 @@ class RetailcrmHistory
->setParams(array($filter, '{{page}}'))
->setDataKey('history')
->setLimit(100)
->setPageLimit(50)
->execute()
->getData();

View File

@ -62,6 +62,11 @@ class RetailcrmApiPaginatedRequest
*/
private $limit;
/**
* @var int|null
*/
private $pageLimit;
/**
* @var array
*/
@ -140,6 +145,19 @@ class RetailcrmApiPaginatedRequest
return $this;
}
/**
* Sets page limit per call
*
* @param int $pageLimit
*
* @return RetailcrmApiPaginatedRequest
*/
public function setPageLimit($pageLimit)
{
$this->pageLimit = $pageLimit;
return $this;
}
/**
* Executes request
*
@ -162,6 +180,10 @@ class RetailcrmApiPaginatedRequest
$page = $response['pagination']['currentPage'] + 1;
}
if($this->pageLimit !== null && $page > $this->pageLimit) {
break;
}
time_nanosleep(0, 300000000);
} while ($response && (isset($response['pagination'])
&& $response['pagination']['currentPage'] < $response['pagination']['totalPageCount']));
@ -188,6 +210,7 @@ class RetailcrmApiPaginatedRequest
{
$this->method = '';
$this->limit = 100;
$this->pageLimit = null;
$this->data = array();
return $this;

View File

@ -0,0 +1,95 @@
<?php
class RetailcrmApiPaginatedRequestTest extends RetailcrmTestCase
{
private $apiMock;
public function setUp()
{
parent::setUp();
$this->apiMock = $this->getMockBuilder('RetailcrmProxy')
->disableOriginalConstructor()
->setMethods(
array(
'ordersHistory',
)
)
->getMock();
}
public function getPageLimits()
{
return array(
'Big history' => array(2, 3, 12, 6),
'Equal history' => array(2, 3, 6, 6),
'Small history' => array(2, 3, 3, 3),
);
}
/**
* @dataProvider getPageLimits
*/
public function testPageLimit($limit, $pageLimit, $totalCount, $expectedTotalCount)
{
$this->apiMock->expects($this->any())
->method('ordersHistory')
->willReturnOnConsecutiveCalls(...$this->getHistory($limit, $totalCount));
$request = new RetailcrmApiPaginatedRequest();
$history = $request
->setApi($this->apiMock)
->setMethod('ordersHistory')
->setParams(array(array(), '{{page}}'))
->setDataKey('history')
->setLimit($limit)
->setPageLimit($pageLimit)
->execute()
->getData();
$lastId = end($history)['id'];
$this->assertEquals($expectedTotalCount, count($history));
$this->assertEquals($expectedTotalCount, $lastId);
}
private function getHistory($limit, $totalCount)
{
$totalPageCount = ceil($totalCount / $limit);
$currentPage = 0;
while ($currentPage < $totalPageCount) {
$history = array();
$from = ($limit * $currentPage) + 1;
$to = ($limit * $currentPage) + $limit;
if ($to > $totalCount) {
$to = $totalCount;
}
foreach (range($from, $to) as $historyId) {
$history[] = array(
'id' => $historyId,
);
}
$currentPage++;
yield new RetailcrmApiResponse(
'200',
json_encode(
array(
'success' => true,
'history' => $history,
'pagination' => array(
'limit' => $limit,
'totalCount' => $totalCount,
'currentPage' => $currentPage,
'totalPageCount' => $totalPageCount
)
)
)
);
}
}
}