lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

REST API: replace the /category/ API by /categories/.

Browse Source 
Remove several /category/list/xxx endpoints because they are redundant
with the /categories/ endpoint whith the 'type' filter.
This commit is contained in:
Xebax 2016-06-14 18:57:00 +02:00
parent 396d31e18e
commit db77efc067
1 changed files with 11 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
htdocs/categories/class/api_category.class.php → htdocs/categories/class/api_categories.class.php
View File

@ -21,15 +21,12 @@
require_once DOL_DOCUMENT_ROOT.'/societe/class/client.class.php';
/**
* API class for category object
* API class for categories
*
* @smart-auto-routing false
* @access protected
* @class DolibarrApiAccess {@requires user,external}
*
*
*/
class CategoryApi extends DolibarrApi
class Categories extends DolibarrApi
{
/**
* @var array $FIELDS Mandatory fields, checked when create and update object
@ -55,16 +52,12 @@ class CategoryApi extends DolibarrApi
/**
* Constructor
*
* @url GET category/
*
*/
function __construct()
{
global $db, $conf;
$this->db = $db;
$this->category = new Categorie($this->db);
}
/**
@ -75,7 +68,6 @@ class CategoryApi extends DolibarrApi
* @param int $id ID of category
* @return array|mixed data without useless information
*
* @url GET category/{id}
* @throws RestException
*/
function get($id)
@ -108,9 +100,9 @@ class CategoryApi extends DolibarrApi
* @param int $page Page number
* @return array Array of category objects
*
* @url GET /category/list
* @throws RestException
*/
function getList($type='product', $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) {
function index($type, $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) {
global $db, $conf;
$obj_ret = array();
@ -122,7 +114,7 @@ class CategoryApi extends DolibarrApi
$sql = "SELECT s.rowid";
$sql.= " FROM ".MAIN_DB_PREFIX."categorie as s";
$sql.= ' WHERE s.entity IN ('.getEntity('categorie', 1).')';
$sql.= ' AND s.type='.array_search($type,CategoryApi::$TYPES);
$sql.= ' AND s.type='.array_search($type,Categories::$TYPES);
$nbtotalofrecords = 0;
if (empty($conf->global->MAIN_DISABLE_FULL_SCANLIST))
@ -165,7 +157,9 @@ class CategoryApi extends DolibarrApi
}
return $obj_ret;
}
/**
* TODO move to /members/, /products/ and /contacts/
* List categories of an entity
*
* Get a list of categories
@ -201,7 +195,7 @@ class CategoryApi extends DolibarrApi
$sql.= " FROM ".MAIN_DB_PREFIX."categorie as s";
$sql.= " , ".MAIN_DB_PREFIX."categorie_".$sub_type." as sub ";
$sql.= ' WHERE s.entity IN ('.getEntity('categorie', 1).')';
$sql.= ' AND s.type='.array_search($type,CategoryApi::$TYPES);
$sql.= ' AND s.type='.array_search($type,Categories::$TYPES);
$sql.= ' AND s.rowid = sub.fk_categorie';
$sql.= ' AND sub.'.$subcol_name.' = '.$item;
@ -248,36 +242,7 @@ class CategoryApi extends DolibarrApi
}
/**
* Get member categories list
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
* @param int $page Page number
* @return mixed
*
* @url GET /category/list/member
*/
function getListCategoryMember($sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) {
return $this->getList('member', $sortfield, $sortorder, $limit, $page);
}
/**
* Get customer categories list
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
* @param int $page Page number
*
* @return mixed
*
* @url GET /category/list/customer
*/
function getListCategoryCustomer($sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) {
return $this->getList('customer', $sortfield, $sortorder, $limit, $page);
}
/**
* TODO move to /thirsparties/ or /customers/
* Get categories for a customer
*
* @param int $cusid Customer id filter
@ -295,6 +260,7 @@ class CategoryApi extends DolibarrApi
}
/**
* TODO move to /thirsparties/ or /customers/
* Add category to customer
*
* @param int $cusid Id of customer
@ -328,60 +294,11 @@ class CategoryApi extends DolibarrApi
return $customer;
}
/**
* Get supplier categories list
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
* @param int $page Page number
*
* @return mixed
*
* @url GET /category/list/supplier
*/
function getListCategorySupplier($sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) {
return $this->getList('supplier', $sortfield, $sortorder, $limit, $page);
}
/**
* Get product categories list
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
* @param int $page Page number
*
* @return mixed
*
* @url GET /category/list/product
*/
function getListCategoryProduct($sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) {
return $this->getList('product', $sortfield, $sortorder, $limit, $page);
}
/**
* Get contact categories list
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
* @param int $page Page number
* @return mixed
*
* @url GET /category/list/contact
*/
function getListCategoryContact($sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) {
return $this->getList('contact', $sortfield, $sortorder, $limit, $page);
}
/**
* Create category object
*
* @param array $request_data Request data
* @return int ID of category
*
* @url POST category/
*/
function post($request_data = NULL)
{
@ -406,8 +323,6 @@ class CategoryApi extends DolibarrApi
* @param int $id Id of category to update
* @param array $request_data Datas
* @return int
*
* @url PUT category/{id}
*/
function put($id, $request_data = NULL)
{
@ -439,8 +354,6 @@ class CategoryApi extends DolibarrApi
*
* @param int $id Category ID
* @return array
*
* @url DELETE category/{id}
*/
function delete($id)
{
@ -479,7 +392,7 @@ class CategoryApi extends DolibarrApi
function _validate($data)
{
$category = array();
foreach (CategoryApi::$FIELDS as $field) {
foreach (Categories::$FIELDS as $field) {
if (!isset($data[$field]))
throw new RestException(400, "$field field missing");
$category[$field] = $data[$field];