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

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

File diff suppressed because it is too large Load Diff

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

@ -52,12 +52,15 @@ class Products extends DolibarrApi
} }
/** /**
* 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 string $ref Ref of element
* @param string $ref_ext Ref ext of element
* @param string $barcode Barcode of element
* @param int $includestockdata Load also information about stock (slower) * @param int $includestockdata Load also information about stock (slower)
* @return array|mixed Data without useless information * @return array|mixed Data without useless information
* *
@ -65,23 +68,28 @@ class Products extends DolibarrApi
* @throws 403 * @throws 403
* @throws 404 * @throws 404
*/ */
function get($id, $includestockdata=0) function get($id, $ref='', $ref_ext='', $barcode='', $includestockdata=0)
{ {
if (empty($id) && empty($ref) && empty($ref_ext) && empty($barcode)) {
throw new RestException(400, 'bad value for parameter id, ref, ref_ext or barcode');
}
$id = (empty($id)?0:$id);
if(! DolibarrApiAccess::$user->rights->produit->lire) { if(! DolibarrApiAccess::$user->rights->produit->lire) {
throw new RestException(403); throw new RestException(403);
} }
$result = $this->product->fetch($id); $result = $this->product->fetch($id, $ref, $ref_ext, $barcode);
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);
} }
if ($includestockdata) if ($includestockdata) {
{
$this->product->load_stock(); $this->product->load_stock();
} }
@ -112,26 +120,24 @@ 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='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
@ -140,8 +146,7 @@ class Products extends DolibarrApi
$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;
@ -218,57 +222,61 @@ class Products extends DolibarrApi
} }
$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->default_vat_code != $oldproduct->default_vat_code) $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->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 != $oldproduct->price) { $pricemodified = true;
if ($this->product->price_min != $oldproduct->price_min) $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;
} }
@ -277,8 +285,7 @@ class Products extends DolibarrApi
} }
} }
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));
} }
@ -297,11 +304,11 @@ class Products extends DolibarrApi
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);
} }
@ -364,13 +371,12 @@ class Products extends DolibarrApi
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');
} }
@ -406,13 +412,12 @@ class Products extends DolibarrApi
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');
} }
@ -441,13 +446,12 @@ class Products extends DolibarrApi
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');
} }
@ -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;

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

File diff suppressed because it is too large Load Diff