Add API class for product

htdocs/product/class/api_product.class.php

+<?php
+/* Copyright (C) 2015   Jean-François Ferry     <jfefe@aternatik.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+ use Luracast\Restler\RestException;
+ 
+ require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
+
+/**
+ * 
+ * API class for product object
+ *
+ * @smart-auto-routing false
+ * @access protected 
+ * @class  DolibarrApiAccess {@requires user,external}
+ * 
+ *
+ */
+class ProductApi extends DolibarrApi {
+    
+    /**
+     *
+     * @var array   $FIELDS     Mandatory fields, checked when create and update object 
+     */
+    static $FIELDS = array(
+        'ref',
+        'libelle'       // @todo : marked deprecated but stille in use instead of label
+    );
+
+    /**
+     * @var Product $product {@type Product}
+     */
+    public $product;
+
+    /**
+     * Constructor
+     *
+     * @url	product/
+     * 
+     */
+    function __construct()
+    {
+		global $db, $conf;
+		$this->db = $db;
+        $this->product = new Product($this->db);
+    }
+
+    /**
+     * Get properties of a product object
+     *
+     * Return an array with product informations
+     *
+     * @url	GET product/{id}
+     * @param 	int 	$id ID of product
+     * @return 	array|mixed data without useless information
+	 * 
+     * @throws 	RestException
+     */
+    function get($id='', $ref='', $ref_ext='')
+    {		
+		if(! DolibarrApiAccess::$user->rights->produit->lire) {
+			throw new RestException(401);
+		}
+			
+        $result = $this->product->fetch($id,$ref,$ref_ext);
+        if( ! $result ) {
+            throw new RestException(404, 'Product not found');
+        }
+		
+		if( ! DolibarrApi::_checkAccessToResource('product',$this->product->id)) {
+			throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+		}
+        
+        $this->product->load_stock();
+
+		return $this->_cleanObjectDatas($this->product);
+    }
+
+    /**
+     * List products
+     * 
+     * Get a list of products
+     *
+     * @url	GET /product/list
+     * 
+     * @param int		$mode		Use this param to filter list (0 for all, 1 for only product, 2 for only service)
+     * @param mixed     $to_sell    Filter products to sell (1) or not to sell (0)  
+     * @param mixed     $to_buy     Filter products to nuy (1) or not to buy (0)  
+     * @param string	$sortfield	Sort field
+     * @param string	$sortorder	Sort order
+     * @param int		$limit		Limit for list
+     * @param int		$page		Page number
+     *
+     * @return array Array of product objects
+     */
+    function getList($mode=0, $to_sell='', $to_buy='', $sortfield = "p.ref", $sortorder = 'ASC', $limit = 0, $page = 0) {
+        global $db, $conf;
+        
+        $obj_ret = array();
+        
+        $socid = DolibarrApiAccess::$user->societe_id ? DolibarrApiAccess::$user->societe_id : '';
+
+        $sql ="SELECT rowid, ref, ref_ext";
+        $sql.= " FROM ".MAIN_DB_PREFIX."product as p";
+        $sql.= ' WHERE p.entity IN ('.getEntity('product', 1).')';
+		
+        // Show products
+        if ($mode == 1) $sql.= " AND p.fk_product_type = 0";
+        // Show services
+        if ($mode == 2) $sql.= " AND p.fk_product_type = 1";
+        // Show product on sell
+        if ($to_sell) $sql.= " AND p.to_sell = ".$db->escape($to_sell);
+        // Show product on buy
+        if ($to_buy) $sql.= " AND p.to_nuy = ".$db->escape($to_nuy);
+
+        $nbtotalofrecords = 0;
+        if (empty($conf->global->MAIN_DISABLE_FULL_SCANLIST))
+        {
+            $result = $db->query($sql);
+            $nbtotalofrecords = $db->num_rows($result);
+        }
+
+        $sql.= $db->order($sortfield, $sortorder);
+        if ($limit)	{
+            if ($page < 0)
+            {
+                $page = 0;
+            }
+            $offset = $limit * $page;
+
+            $sql.= $db->plimit($limit + 1, $offset);
+        }
+
+        $result = $db->query($sql);
+        if ($result)
+        {
+            $num = $db->num_rows($result);
+            while ($i < $num)
+            {
+                $obj = $db->fetch_object($result);
+                $product_static = new Product($db);
+                if($product_static->fetch($obj->rowid)) {
+                    $obj_ret[] = parent::_cleanObjectDatas($product_static);
+                }
+                $i++;
+            }
+        }
+        else {
+            throw new RestException(503, 'Error when retrieve product list');
+        }
+        if( ! count($obj_ret)) {
+            throw new RestException(404, 'No product found');
+        }
+		return $obj_ret;
+    }
+    
+    /**
+     * Create product object
+     *
+     * @url     POST product/
+     * 
+     * @param   array   $request_data
+     * @return  int     ID of product
+     */
+    function post($request_data = NULL)
+    {
+        if(! DolibarrApiAccess::$user->rights->produit->creer) {
+			throw new RestException(401);
+		}
+        // Check mandatory fields
+        $result = $this->_validate($request_data);
+        
+        foreach($request_data as $field => $value) {
+            $this->product->$field = $value;
+        }
+        $result = $this->product->create(DolibarrApiAccess::$user);
+        if($result < 0) {
+            throw new RestException(503,'Error when creating product : '.$this->product->error);
+        }
+        
+        return $this->product->id;
+        
+    }
+
+    /**
+     * Update product
+     *
+     * @url	PUT product/{id}
+     * 
+     * @param int   $id             Id of product to update
+     * @param array $request_data   Datas   
+     * @return int 
+     */
+    function put($id, $request_data = NULL)
+    {
+        if(! DolibarrApiAccess::$user->rights->produit->creer) {
+			throw new RestException(401);
+		}
+        
+        $result = $this->product->fetch($id);
+        if( ! $result ) {
+            throw new RestException(404, 'Product not found');
+        }
+		
+		if( ! DolibarrApi::_checkAccessToResource('product',$this->product->id)) {
+			throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+		}
+
+        foreach($request_data as $field => $value) {
+            $this->product->$field = $value;
+        }
+        
+        if($this->product->update($id, DolibarrApiAccess::$user,1,'','','update'))
+            return $this->get ($id);
+        
+        return false;
+    }
+    
+    /**
+     * Delete product
+     *
+     * @url	DELETE product/{id}
+     * @param int $id
+     * @return type
+     */
+    function delete($id)
+    {
+        if(! DolibarrApiAccess::$user->rights->product->supprimer) {
+			throw new RestException(401);
+		}
+        $result = $this->product->fetch($id);
+        if( ! $result ) {
+            throw new RestException(404, 'Product not found');
+        }
+		
+		if( ! DolibarrApi::_checkAccessToResource('product',$this->product->id)) {
+			throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+		}
+        
+        return $this->product->delete($id);
+    }
+    
+    /**
+     * Validate fields before create or update object
+     * @param array $data
+     * @return array
+     * @throws RestException
+     */
+    function _validate($data)
+    {
+        $product = array();
+        foreach (ProductApi::$FIELDS as $field) {
+            if (!isset($data[$field]))
+                throw new RestException(400, "$field field missing");
+            $product[$field] = $data[$field];
+        }
+        return $product;
+    }
+}