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

Merge pull request #9954 from LaurentBouquet/feature/product-search-barcode

Browse Source 
NEW Add product search from barcode via REST api.
This commit is contained in:
Laurent Destailleur 2018-11-08 19:18:41 +01:00 committed by GitHub
commit ed76fef860
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6477 additions and 6490 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3979
htdocs/core/modules/DolibarrModules.class.php
View File

File diff suppressed because it is too large Load Diff

391
htdocs/product/class/api_products.class.php
View File

@ -46,44 +46,52 @@ class Products extends DolibarrApi
*/ */
function __construct() function __construct()
{ {
global $db, $conf; global $db, $conf;
$this->db = $db; $this->db = $db;
$this->product = new Product($this->db); $this->product = new Product($this->db);
} }
/** /**
* Get properties of a product object * Get properties of a product object (from its ID, Ref, Ref_ext or Barcode)
* *
* Return an array with product information. * Return an array with product information.
* TODO implement getting a product by ref or by $ref_ext * TODO implement getting a product by ref or by $ref_ext
* *
* @param int $id ID of product * @param int $id ID of product
* @param int $includestockdata Load also information about stock (slower) * @param string $ref Ref of element
* @return array|mixed Data without useless information * @param string $ref_ext Ref ext of element
* * @param string $barcode Barcode of element
* @param int $includestockdata Load also information about stock (slower)
* @return array|mixed Data without useless information
*
* @throws 401 * @throws 401
* @throws 403 * @throws 403
* @throws 404 * @throws 404
*/ */
function get($id, $includestockdata=0) function get($id, $ref='', $ref_ext='', $barcode='', $includestockdata=0)
{ {
if(! DolibarrApiAccess::$user->rights->produit->lire) { if (empty($id) && empty($ref) && empty($ref_ext) && empty($barcode)) {
throw new RestException(403); throw new RestException(400, 'bad value for parameter id, ref, ref_ext or barcode');
} }
$result = $this->product->fetch($id); $id = (empty($id)?0:$id);
if( ! $result ) {
if(! DolibarrApiAccess::$user->rights->produit->lire) {
throw new RestException(403);
}
$result = $this->product->fetch($id, $ref, $ref_ext, $barcode);
if(! $result ) {
throw new RestException(404, 'Product not found'); throw new RestException(404, 'Product not found');
} }
if( ! DolibarrApi::_checkAccessToResource('product',$this->product->id)) { if(! DolibarrApi::_checkAccessToResource('product', $this->product->id)) {
throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login); throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
} }
if ($includestockdata) if ($includestockdata) {
{ $this->product->load_stock();
$this->product->load_stock(); }
}
return $this->_cleanObjectDatas($this->product); return $this->_cleanObjectDatas($this->product);
} }
@ -93,13 +101,13 @@ class Products extends DolibarrApi
* *
* Get a list of products * Get a list of products
* *
* @param string $sortfield Sort field * @param string $sortfield Sort field
* @param string $sortorder Sort order * @param string $sortorder Sort order
* @param int $limit Limit for list * @param int $limit Limit for list
* @param int $page Page number * @param int $page Page number
* @param int $mode Use this param to filter list (0 for all, 1 for only product, 2 for only service) * @param int $mode Use this param to filter list (0 for all, 1 for only product, 2 for only service)
* @param int $category Use this param to filter list by category * @param int $category Use this param to filter list by category
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.tobuy:=:0) and (t.tosell:=:1)" * @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.tobuy:=:0) and (t.tosell:=:1)"
* @return array Array of product objects * @return array Array of product objects
*/ */
function index($sortfield = "t.ref", $sortorder = 'ASC', $limit = 100, $page = 0, $mode=0, $category=0, $sqlfilters = '') function index($sortfield = "t.ref", $sortorder = 'ASC', $limit = 100, $page = 0, $mode=0, $category=0, $sqlfilters = '')
@ -112,36 +120,33 @@ class Products extends DolibarrApi
$sql = "SELECT t.rowid, t.ref, t.ref_ext"; $sql = "SELECT t.rowid, t.ref, t.ref_ext";
$sql.= " FROM ".MAIN_DB_PREFIX."product as t"; $sql.= " FROM ".MAIN_DB_PREFIX."product as t";
if ($category > 0) if ($category > 0) {
{
$sql.= ", ".MAIN_DB_PREFIX."categorie_product as c"; $sql.= ", ".MAIN_DB_PREFIX."categorie_product as c";
} }
$sql.= ' WHERE t.entity IN ('.getEntity('product').')'; $sql.= ' WHERE t.entity IN ('.getEntity('product').')';
// Select products of given category // Select products of given category
if ($category > 0) if ($category > 0) {
{
$sql.= " AND c.fk_categorie = ".$db->escape($category); $sql.= " AND c.fk_categorie = ".$db->escape($category);
$sql.= " AND c.fk_product = t.rowid "; $sql.= " AND c.fk_product = t.rowid ";
} }
// Show products // Show products
if ($mode == 1) $sql.= " AND t.fk_product_type = 0"; if ($mode == 1) { $sql.= " AND t.fk_product_type = 0";
}
// Show services // Show services
if ($mode == 2) $sql.= " AND t.fk_product_type = 1"; if ($mode == 2) { $sql.= " AND t.fk_product_type = 1";
}
// Add sql filters // Add sql filters
if ($sqlfilters) if ($sqlfilters) {
{ if (! DolibarrApi::_checkFilters($sqlfilters)) {
if (! DolibarrApi::_checkFilters($sqlfilters))
{
throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters); throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters);
} }
$regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)'; $regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
$sql.=" AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")"; $sql.=" AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")";
} }
$sql.= $db->order($sortfield, $sortorder); $sql.= $db->order($sortfield, $sortorder);
if ($limit) { if ($limit) {
if ($page < 0) if ($page < 0) {
{
$page = 0; $page = 0;
} }
$offset = $limit * $page; $offset = $limit * $page;
@ -150,8 +155,7 @@ class Products extends DolibarrApi
} }
$result = $db->query($sql); $result = $db->query($sql);
if ($result) if ($result) {
{
$num = $db->num_rows($result); $num = $db->num_rows($result);
$min = min($num, ($limit <= 0 ? $num : $limit)); $min = min($num, ($limit <= 0 ? $num : $limit));
while ($i < $min) while ($i < $min)
@ -167,7 +171,7 @@ class Products extends DolibarrApi
else { else {
throw new RestException(503, 'Error when retrieve product list : '.$db->lasterror()); throw new RestException(503, 'Error when retrieve product list : '.$db->lasterror());
} }
if( ! count($obj_ret)) { if(! count($obj_ret)) {
throw new RestException(404, 'No product found'); throw new RestException(404, 'No product found');
} }
return $obj_ret; return $obj_ret;
@ -176,14 +180,14 @@ class Products extends DolibarrApi
/** /**
* Create product object * Create product object
* *
* @param array $request_data Request data * @param array $request_data Request data
* @return int ID of product * @return int ID of product
*/ */
function post($request_data = null) function post($request_data = null)
{ {
if(! DolibarrApiAccess::$user->rights->produit->creer) { if(! DolibarrApiAccess::$user->rights->produit->creer) {
throw new RestException(401); throw new RestException(401);
} }
// Check mandatory fields // Check mandatory fields
$result = $this->_validate($request_data); $result = $this->_validate($request_data);
@ -201,8 +205,8 @@ class Products extends DolibarrApi
* Update product. * Update product.
* Price will be updated by this API only if option is set on "One price per product". See other APIs for other price modes. * Price will be updated by this API only if option is set on "One price per product". See other APIs for other price modes.
* *
* @param int $id Id of product to update * @param int $id Id of product to update
* @param array $request_data Datas * @param array $request_data Datas
* @return int * @return int
* *
* @throws RestException * @throws RestException
@ -211,99 +215,102 @@ class Products extends DolibarrApi
*/ */
function put($id, $request_data = null) function put($id, $request_data = null)
{ {
global $conf; global $conf;
if(! DolibarrApiAccess::$user->rights->produit->creer) { if(! DolibarrApiAccess::$user->rights->produit->creer) {
throw new RestException(401); throw new RestException(401);
} }
$result = $this->product->fetch($id); $result = $this->product->fetch($id);
if( ! $result ) { if(! $result ) {
throw new RestException(404, 'Product not found'); throw new RestException(404, 'Product not found');
} }
if( ! DolibarrApi::_checkAccessToResource('product',$this->product->id)) { if(! DolibarrApi::_checkAccessToResource('product', $this->product->id)) {
throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login); throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
} }
$oldproduct = dol_clone($this->product, 0); $oldproduct = dol_clone($this->product, 0);
foreach($request_data as $field => $value) { foreach($request_data as $field => $value) {
if ($field == 'id') continue; if ($field == 'id') { continue;
}
$this->product->$field = $value; $this->product->$field = $value;
} }
$result = $this->product->update($id, DolibarrApiAccess::$user, 1, 'update'); $result = $this->product->update($id, DolibarrApiAccess::$user, 1, 'update');
// If price mode is 1 price per product // If price mode is 1 price per product
if ($result > 0 && ! empty($conf->global->PRODUCT_PRICE_UNIQ)) if ($result > 0 && ! empty($conf->global->PRODUCT_PRICE_UNIQ)) {
{ // We update price only if it was changed
// We update price only if it was changed $pricemodified = false;
$pricemodified = false; if ($this->product->price_base_type != $oldproduct->price_base_type) { $pricemodified = true;
if ($this->product->price_base_type != $oldproduct->price_base_type) $pricemodified = true; } else
else {
{ if ($this->product->tva_tx != $oldproduct->tva_tx) { $pricemodified = true;
if ($this->product->tva_tx != $oldproduct->tva_tx) $pricemodified = true; }
if ($this->product->tva_npr != $oldproduct->tva_npr) $pricemodified = true; if ($this->product->tva_npr != $oldproduct->tva_npr) { $pricemodified = true;
if ($this->product->default_vat_code != $oldproduct->default_vat_code) $pricemodified = true; }
if ($this->product->default_vat_code != $oldproduct->default_vat_code) { $pricemodified = true;
}
if ($this->product->price_base_type == 'TTC') if ($this->product->price_base_type == 'TTC') {
{ if ($this->product->price_ttc != $oldproduct->price_ttc) { $pricemodified = true;
if ($this->product->price_ttc != $oldproduct->price_ttc) $pricemodified = true; }
if ($this->product->price_min_ttc != $oldproduct->price_min_ttc) $pricemodified = true; if ($this->product->price_min_ttc != $oldproduct->price_min_ttc) { $pricemodified = true;
} }
else }
{ else
if ($this->product->price != $oldproduct->price) $pricemodified = true; {
if ($this->product->price_min != $oldproduct->price_min) $pricemodified = true; if ($this->product->price != $oldproduct->price) { $pricemodified = true;
} }
} if ($this->product->price_min != $oldproduct->price_min) { $pricemodified = true;
}
}
}
if ($pricemodified) if ($pricemodified) {
{ $newvat = $this->product->tva_tx;
$newvat = $this->product->tva_tx; $newnpr = $this->product->tva_npr;
$newnpr = $this->product->tva_npr; $newvatsrccode = $this->product->default_vat_code;
$newvatsrccode = $this->product->default_vat_code;
$newprice = $this->product->price; $newprice = $this->product->price;
$newpricemin = $this->product->price_min; $newpricemin = $this->product->price_min;
if ($this->product->price_base_type == 'TTC') if ($this->product->price_base_type == 'TTC') {
{ $newprice = $this->product->price_ttc;
$newprice = $this->product->price_ttc; $newpricemin = $this->product->price_min_ttc;
$newpricemin = $this->product->price_min_ttc; }
}
$result = $this->product->updatePrice($newprice, $this->product->price_base_type, DolibarrApiAccess::$user, $newvat, $newpricemin, 0, $newnpr, 0, 0, array(), $newvatsrccode); $result = $this->product->updatePrice($newprice, $this->product->price_base_type, DolibarrApiAccess::$user, $newvat, $newpricemin, 0, $newnpr, 0, 0, array(), $newvatsrccode);
} }
} }
if ($result <= 0) if ($result <= 0) {
{ throw new RestException(500, "Error updating product", array_merge(array($this->product->error), $this->product->errors));
throw new RestException(500, "Error updating product", array_merge(array($this->product->error), $this->product->errors)); }
}
return $this->get($id); return $this->get($id);
} }
/** /**
* Delete product * Delete product
* *
* @param int $id Product ID * @param int $id Product ID
* @return array * @return array
*/ */
function delete($id) function delete($id)
{ {
if(! DolibarrApiAccess::$user->rights->produit->supprimer) { if(! DolibarrApiAccess::$user->rights->produit->supprimer) {
throw new RestException(401); throw new RestException(401);
} }
$result = $this->product->fetch($id); $result = $this->product->fetch($id);
if( ! $result ) { if(! $result ) {
throw new RestException(404, 'Product not found'); throw new RestException(404, 'Product not found');
} }
if( ! DolibarrApi::_checkAccessToResource('product',$this->product->id)) { if(! DolibarrApi::_checkAccessToResource('product', $this->product->id)) {
throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login); throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
} }
// The Product::delete() method uses the global variable $user. // The Product::delete() method uses the global variable $user.
global $user; global $user;
@ -316,41 +323,41 @@ class Products extends DolibarrApi
/** /**
* Get categories for a product * Get categories for a product
* *
* @param int $id ID of product * @param int $id ID of product
* @param string $sortfield Sort field * @param string $sortfield Sort field
* @param string $sortorder Sort order * @param string $sortorder Sort order
* @param int $limit Limit for list * @param int $limit Limit for list
* @param int $page Page number * @param int $page Page number
* *
* @return mixed * @return mixed
* *
* @url GET {id}/categories * @url GET {id}/categories
*/ */
function getCategories($id, $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) function getCategories($id, $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
{ {
if (! DolibarrApiAccess::$user->rights->categorie->lire) { if (! DolibarrApiAccess::$user->rights->categorie->lire) {
throw new RestException(401); throw new RestException(401);
} }
$categories = new Categorie($this->db); $categories = new Categorie($this->db);
$result = $categories->getListForItem($id, 'product', $sortfield, $sortorder, $limit, $page); $result = $categories->getListForItem($id, 'product', $sortfield, $sortorder, $limit, $page);
if (empty($result)) { if (empty($result)) {
throw new RestException(404, 'No category found'); throw new RestException(404, 'No category found');
} }
if ($result < 0) { if ($result < 0) {
throw new RestException(503, 'Error when retrieve category list : '.array_merge(array($categories->error), $categories->errors)); throw new RestException(503, 'Error when retrieve category list : '.array_merge(array($categories->error), $categories->errors));
} }
return $result; return $result;
} }
/** /**
* Get prices per segment for a product * Get prices per segment for a product
* *
* @param int $id ID of product * @param int $id ID of product
* *
* @return mixed * @return mixed
* *
@ -358,41 +365,40 @@ class Products extends DolibarrApi
*/ */
function getCustomerPricesPerSegment($id) function getCustomerPricesPerSegment($id)
{ {
global $conf; global $conf;
if (! DolibarrApiAccess::$user->rights->produit->lire) { if (! DolibarrApiAccess::$user->rights->produit->lire) {
throw new RestException(401); throw new RestException(401);
} }
if (empty($conf->global->PRODUIT_MULTIPRICES)) if (empty($conf->global->PRODUIT_MULTIPRICES)) {
{ throw new RestException(400, 'API not available: this mode of pricing is not enabled by setup');
throw new RestException(400, 'API not available: this mode of pricing is not enabled by setup'); }
}
$result = $this->product->fetch($id); $result = $this->product->fetch($id);
if ( ! $result ) { if (! $result ) {
throw new RestException(404, 'Product not found'); throw new RestException(404, 'Product not found');
} }
if ($result < 0) { if ($result < 0) {
throw new RestException(503, 'Error when retrieve prices list : '.array_merge(array($this->product->error), $this->product->errors)); throw new RestException(503, 'Error when retrieve prices list : '.array_merge(array($this->product->error), $this->product->errors));
} }
return array( return array(
'multiprices'=>$this->product->multiprices, 'multiprices'=>$this->product->multiprices,
'multiprices_inc_tax'=>$this->product->multiprices_ttc, 'multiprices_inc_tax'=>$this->product->multiprices_ttc,
'multiprices_min'=>$this->product->multiprices_min, 'multiprices_min'=>$this->product->multiprices_min,
'multiprices_min_inc_tax'=>$this->product->multiprices_min_ttc, 'multiprices_min_inc_tax'=>$this->product->multiprices_min_ttc,
'multiprices_vat'=>$this->product->multiprices_tva_tx, 'multiprices_vat'=>$this->product->multiprices_tva_tx,
'multiprices_base_type'=>$this->product->multiprices_base_type, 'multiprices_base_type'=>$this->product->multiprices_base_type,
//'multiprices_default_vat_code'=>$this->product->multiprices_default_vat_code //'multiprices_default_vat_code'=>$this->product->multiprices_default_vat_code
); );
} }
/** /**
* Get prices per customer for a product * Get prices per customer for a product
* *
* @param int $id ID of product * @param int $id ID of product
* *
* @return mixed * @return mixed
* *
@ -400,34 +406,33 @@ class Products extends DolibarrApi
*/ */
function getCustomerPricesPerCustomer($id) function getCustomerPricesPerCustomer($id)
{ {
global $conf; global $conf;
if (! DolibarrApiAccess::$user->rights->produit->lire) { if (! DolibarrApiAccess::$user->rights->produit->lire) {
throw new RestException(401); throw new RestException(401);
} }
if (empty($conf->global->PRODUIT_CUSTOMER_PRICES)) if (empty($conf->global->PRODUIT_CUSTOMER_PRICES)) {
{ throw new RestException(400, 'API not available: this mode of pricing is not enabled by setup');
throw new RestException(400, 'API not available: this mode of pricing is not enabled by setup'); }
}
$result = $this->product->fetch($id); $result = $this->product->fetch($id);
if ( ! $result ) { if (! $result ) {
throw new RestException(404, 'Product not found'); throw new RestException(404, 'Product not found');
} }
if ($result < 0) { if ($result < 0) {
throw new RestException(503, 'Error when retrieve prices list : '.array_merge(array($this->product->error), $this->product->errors)); throw new RestException(503, 'Error when retrieve prices list : '.array_merge(array($this->product->error), $this->product->errors));
} }
throw new RestException(501, 'Feature not yet available'); throw new RestException(501, 'Feature not yet available');
//return $result; //return $result;
} }
/** /**
* Get prices per quantity for a product * Get prices per quantity for a product
* *
* @param int $id ID of product * @param int $id ID of product
* *
* @return mixed * @return mixed
* *
@ -435,38 +440,37 @@ class Products extends DolibarrApi
*/ */
function getCustomerPricesPerQuantity($id) function getCustomerPricesPerQuantity($id)
{ {
global $conf; global $conf;
if (! DolibarrApiAccess::$user->rights->produit->lire) { if (! DolibarrApiAccess::$user->rights->produit->lire) {
throw new RestException(401); throw new RestException(401);
} }
if (empty($conf->global->PRODUIT_CUSTOMER_PRICES_BY_QTY)) if (empty($conf->global->PRODUIT_CUSTOMER_PRICES_BY_QTY)) {
{ throw new RestException(400, 'API not available: this mode of pricing is not enabled by setup');
throw new RestException(400, 'API not available: this mode of pricing is not enabled by setup'); }
}
$result = $this->product->fetch($id); $result = $this->product->fetch($id);
if ( ! $result ) { if (! $result ) {
throw new RestException(404, 'Product not found'); throw new RestException(404, 'Product not found');
} }
if ($result < 0) { if ($result < 0) {
throw new RestException(503, 'Error when retrieve prices list : '.array_merge(array($this->product->error), $this->product->errors)); throw new RestException(503, 'Error when retrieve prices list : '.array_merge(array($this->product->error), $this->product->errors));
} }
return array( return array(
'prices_by_qty'=>$this->product->prices_by_qty[0], // 1 if price by quantity was activated for the product 'prices_by_qty'=>$this->product->prices_by_qty[0], // 1 if price by quantity was activated for the product
'prices_by_qty_list'=>$this->product->prices_by_qty_list[0] 'prices_by_qty_list'=>$this->product->prices_by_qty_list[0]
); );
} }
/** /**
* Clean sensible object datas * Clean sensible object datas
* *
* @param object $object Object to clean * @param object $object Object to clean
* @return array Array of cleaned object properties * @return array Array of cleaned object properties
*/ */
function _cleanObjectDatas($object) function _cleanObjectDatas($object)
{ {
@ -492,7 +496,7 @@ class Products extends DolibarrApi
/** /**
* Validate fields before create or update object * Validate fields before create or update object
* *
* @param array $data Datas to validate * @param array $data Datas to validate
* @return array * @return array
* @throws RestException * @throws RestException
*/ */
@ -500,8 +504,9 @@ class Products extends DolibarrApi
{ {
$product = array(); $product = array();
foreach (Products::$FIELDS as $field) { foreach (Products::$FIELDS as $field) {
if (!isset($data[$field])) if (!isset($data[$field])) {
throw new RestException(400, "$field field missing"); throw new RestException(400, "$field field missing");
}
$product[$field] = $data[$field]; $product[$field] = $data[$field];
} }
return $product; return $product;

8593
htdocs/product/class/product.class.php
View File

File diff suppressed because it is too large Load Diff