Add API class for categories

htdocs/api/class/api_access.class.php

@@ -26,7 +26,7 @@ class DolibarrApiAccess implements iAuthenticate
     public static $role = 'user';
 	
 	/**
-	 * @var User		$user	Permission of loggued user 
+	 * @var User		$user	Loggued user 
 	 */
 	public static $user = '';
 	 
@@ -43,16 +43,13 @@ class DolibarrApiAccess implements iAuthenticate
 		$stored_key = '';
 		
 		$userClass = Defaults::$userIdentifierClass;
-		
-		
+				
 		if (isset($_GET['api_key'])) {
-			// @todo : check from database
 			$sql = "SELECT u.login, u.datec, u.api_key, ";
 			$sql.= " u.tms as date_modification, u.entity";
 			$sql.= " FROM ".MAIN_DB_PREFIX."user as u";
 			$sql.= " WHERE u.api_key = '".$db->escape($_GET['api_key'])."'";
-
-			
+	
 			if ($db->query($sql))
 			{
 				if ($db->num_rows($result))

htdocs/categories/class/api_category.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.'/categories/class/categorie.class.php';
+
+/**
+ * 
+ * API class for category object
+ *
+ * @smart-auto-routing false
+ * @access protected 
+ * @class  DolibarrApiAccess {@requires user,external}
+ * 
+ *
+ */
+class CategoryApi extends DolibarrApi {
+    
+    /**
+     *
+     * @var array   $FIELDS     Mandatory fields, checked when create and update object 
+     */
+    static $FIELDS = array(
+        'label',
+        'type'
+    );
+
+    /**
+     * @var category $category {@type category}
+     */
+    public $category;
+
+    /**
+     * Constructor
+     *
+     * @url     GET category/
+     * 
+     */
+    function __construct()
+    {
+		global $db, $conf;
+		$this->db = $db;
+        $this->category = new Categorie($this->db);
+    }
+
+    /**
+     * Get properties of a category object
+     *
+     * Return an array with category informations
+     *
+     * @url	GET category/{id}
+     * @param 	int 	$id ID of category
+     * @return 	array|mixed data without useless information
+	 * 
+     * @throws 	RestException
+     */
+    function get($id)
+    {		
+		if(! DolibarrApiAccess::$user->rights->category->read) {
+			throw new RestException(401);
+		}
+			
+        $result = $this->category->fetch($id);
+        if( ! $result ) {
+            throw new RestException(404, 'category not found');
+        }
+		
+		if( ! DolibarrApi::_checkAccessToResource('category',$this->category->id)) {
+			throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+		}
+
+		return $this->_cleanObjectDatas($this->category);
+    }
+
+    /**
+     * List categories
+     * 
+     * Get a list of categories
+     *
+     * @url	GET /category/list
+     * 
+     * @param int		$mode		Use this param to filter list
+     * @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 category objects
+     */
+    function getList($mode=0, $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) {
+        global $db, $conf;
+        
+        $obj_ret = array();
+        
+         if(! DolibarrApiAccess::$user->rights->categorie->lire) {
+			throw new RestException(401);
+		}
+        
+        $sql = "SELECT s.rowid";
+        $sql.= " FROM ".MAIN_DB_PREFIX."categorie as s";
+        
+		// Example of use $mode
+        //if ($mode == 1) $sql.= " AND s.client IN (1, 3)";
+        //if ($mode == 2) $sql.= " AND s.client IN (2, 3)";
+
+        $sql.= ' WHERE s.entity IN ('.getEntity('categorie', 1).')';
+        
+        $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);
+                $category_static = new Categorie($db);
+                if($category_static->fetch($obj->rowid)) {
+                    $obj_ret[] = parent::_cleanObjectDatas($category_static);
+                }
+                $i++;
+            }
+        }
+        else {
+            throw new RestException(503, 'Error when retrieve category list');
+        }
+        if( ! count($obj_ret)) {
+            throw new RestException(404, 'No category found');
+        }
+		return $obj_ret;
+    }
+    
+    /**
+     * Create category object
+     *
+     * @url	POST category/
+     * @param array $request_data
+     * @return int  ID of category
+     */
+    function post($request_data = NULL)
+    {
+        if(! DolibarrApiAccess::$user->rights->categorie->creer) {
+			throw new RestException(401);
+		}
+        // Check mandatory fields
+        $result = $this->_validate($request_data);
+        
+        foreach($request_data as $field => $value) {
+            $this->category->$field = $value;
+        }
+        if($this->category->create(DolibarrApiAccess::$user) < 0) {
+            throw new RestException(503, 'Error when create category : '.$this->category->error);
+        }
+        return $this->category->id;
+    }
+
+    /**
+     * Update category
+     *
+     * @url	PUT category/{id}
+     * @param int   $id             Id of category to update
+     * @param array $request_data   Datas   
+     * @return int 
+     */
+    function put($id, $request_data = NULL)
+    {
+        if(! DolibarrApiAccess::$user->rights->categorie->creer) {
+			throw new RestException(401);
+		}
+        
+        $result = $this->category->fetch($id);
+        if( ! $result ) {
+            throw new RestException(404, 'category not found');
+        }
+		
+		if( ! DolibarrApi::_checkAccessToResource('category',$this->category->id)) {
+			throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+		}
+
+        foreach($request_data as $field => $value) {
+            $this->category->$field = $value;
+        }
+        
+        if($this->category->update($id, DolibarrApiAccess::$user,1,'','','update'))
+            return $this->get ($id);
+        
+        return false;
+    }
+    
+    /**
+     * Delete category
+     *
+     * @url	DELETE category/{id}
+     * @param int $id
+     * @return type
+     */
+    function delete($id)
+    {
+        if(! DolibarrApiAccess::$user->rights->categorie->supprimer) {
+			throw new RestException(401);
+		}
+        $result = $this->category->fetch($id);
+        if( ! $result ) {
+            throw new RestException(404, 'category not found');
+        }
+		
+		if( ! DolibarrApi::_checkAccessToResource('category',$this->category->id)) {
+			throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+		}
+        
+        return $this->category->delete($id);
+    }
+    
+    /**
+     * Validate fields before create or update object
+     * @param array $data
+     * @return array
+     * @throws RestException
+     */
+    function _validate($data)
+    {
+        $category = array();
+        foreach (CategoryApi::$FIELDS as $field) {
+            if (!isset($data[$field]))
+                throw new RestException(400, "$field field missing");
+            $category[$field] = $data[$field];
+        }
+        return $category;
+    }
+}

htdocs/public/api/index.php

@@ -76,13 +76,17 @@ foreach ($modulesdir as $dir)
 
                 // Defined if module is enabled
                 $enabled=true;
-                $part=$obj=strtolower(preg_replace('/^mod/i','',$modulename));
+                $module=$part=$obj=strtolower(preg_replace('/^mod/i','',$modulename));
                 //if ($part == 'propale') $part='propal';
-                if ($part == 'societe') {
+                if ($module == 'societe') {
 					$obj = 'thirdparty';
 				}
-                if (empty($conf->$part->enabled)) $enabled=false;
-
+                if ($module == 'categorie') { 
+                    $part = 'categories';
+					$obj = 'category';
+				}
+                if (empty($conf->$module->enabled)) $enabled=false;
+                
                 if ($enabled)
                 {
                     /*