composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-13 07:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Allow params "limit" and "page" in REST-API

Browse Source 
PR #25, code author Dennis Lassiter, many thanks !
This commit is contained in:
Dennis Lassiter
2019-02-08 21:48:52 -05:00
committed by Pierre Goiffon
parent 6eb3a243df
commit fd55bdf9a8
2 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
application/applicationextension.inc.php
View File

@@ -825,6 +825,10 @@ class RestResult
* Result: the requested operation cannot be performed because it can cause data (integrity) loss
*/
const UNSAFE = 12;
/**
* Result: the request page number is not valid. It must be an integer greater than 0
*/
const INVALID_PAGE = 13;
/**
* Result: the operation could not be performed, see the message for troubleshooting
*/
@@ -1091,10 +1095,12 @@ class RestUtils
*
* @param string $sClass Name of the class
* @param mixed $key Either search criteria (substructure), or an object or an OQL string.
* @param int $limit The limit of results to return
* @param int $offset The offset of results to return
* @return DBObjectSet The search result set
* @throws Exception If the input structure is not valid
*/
public static function GetObjectSetFromKey($sClass, $key)
public static function GetObjectSetFromKey($sClass, $key, $limit = 0, $offset = 0)
{
if (is_object($key))
{
@@ -1128,7 +1134,7 @@ class RestUtils
{
throw new Exception("Wrong format for key");
}
$oObjectSet = new DBObjectSet($oSearch);
$oObjectSet = new DBObjectSet($oSearch, array(), array(), null, $limit, $offset);
return $oObjectSet;
}

21
core/restservices.class.inc.php
View File

@@ -436,8 +436,10 @@ class CoreServices implements iRestServiceProvider
$key = RestUtils::GetMandatoryParam($aParams, 'key');
$aShowFields = RestUtils::GetFieldList($sClass, $aParams, 'output_fields');
$bExtendedOutput = (RestUtils::GetOptionalParam($aParams, 'output_fields', '*') == '*+');
$limit = (int) RestUtils::GetOptionalParam($aParams, 'limit', 0);
$page = (int) RestUtils::GetOptionalParam($aParams, 'page', 1);
$oObjectSet = RestUtils::GetObjectSetFromKey($sClass, $key);
$oObjectSet = RestUtils::GetObjectSetFromKey($sClass, $key, $limit, self::getOffsetFromLimitAndPage($limit, $page));
$sTargetClass = $oObjectSet->GetFilter()->GetClass();
if (UserRights::IsActionAllowed($sTargetClass, UR_ACTION_READ) != UR_ALLOWED_YES)
@@ -450,6 +452,11 @@ class CoreServices implements iRestServiceProvider
$oResult->code = RestResult::UNAUTHORIZED;
$oResult->message = "The current user does not have enough permissions for exporting data of class $sTargetClass";
}
elseif ($page < 1)
{
$oResult->code = RestResult::INVALID_PAGE;
$oResult->message = "The request page number is not valid. It must be an integer greater than 0";
}
else
{
while ($oObject = $oObjectSet->Fetch())
@@ -774,4 +781,16 @@ class CoreServices implements iRestServiceProvider
$oResult->message = $sRes;
}
}
/**
* Returns the Offset for a given page number
*
* @param int $limit
* @param int $page
* @return int
*/
protected static function getOffsetFromLimitAndPage($limit, $page)
{
return $limit * max(0, $page - 1);
}
}