Merge pull request #6891 from hregis/develop_api

NEW add REST api "memberstypes"

ChangeLog

@@ -4,6 +4,9 @@ English Dolibarr ChangeLog
 
 ***** ChangeLog for 6.0.0 compared to 5.0.* *****
 
+For developers:
+NEW: Add a lot of API REST: dictionaryevents, memberstypes, ...
+
 WARNING: 
 
 Following changes may create regression for some external modules, but were necessary to make Dolibarr better:

htdocs/adherents/class/adherent_type.class.php

@@ -1,7 +1,7 @@
 <?php
 /* Copyright (C) 2002		Rodolphe Quiedeville	<rodolphe@quiedeville.org>
  * Copyright (C) 2004-2008	Laurent Destailleur		<eldy@users.sourceforge.net>
- * Copyright (C) 2009      Regis Houssin        <regis.houssin@capnetworks.com>
+ * Copyright (C) 2009-2017	Regis Houssin			<regis.houssin@capnetworks.com>
  * Copyright (C) 2016		Charlie Benke			<charlie@patas-monkey.com>
  *
  * This program is free software; you can redistribute it and/or modify
@@ -37,6 +37,12 @@ class AdherentType extends CommonObject
 	public $element = 'adherent_type';
 	public $picto = 'group';
 
+	/**
+	 * @var string
+	 * @deprecated Use label
+	 * @see label
+	 */
+	public $libelle;
 	/** @var string Label */
 	public $label;
 	/**
@@ -81,12 +87,13 @@ class AdherentType extends CommonObject
         global $conf;
 
         $this->statut=(int) $this->statut;
+        $this->label=(!empty($this->libelle)?trim($this->libelle):trim($this->label));
 
         $sql = "INSERT INTO ".MAIN_DB_PREFIX."adherent_type (";
         $sql.= "libelle";
         $sql.= ", entity";
         $sql.= ") VALUES (";
-        $sql.= "'".$this->db->escape($this->libelle)."'";
+        $sql.= "'".$this->db->escape($this->label)."'";
         $sql.= ", ".$conf->entity;
         $sql.= ")";
 
@@ -117,12 +124,12 @@ class AdherentType extends CommonObject
 
     	$error=0;
 
-        $this->libelle=trim($this->libelle);
+    	$this->label=(!empty($this->libelle)?trim($this->libelle):trim($this->label));
 
         $sql = "UPDATE ".MAIN_DB_PREFIX."adherent_type ";
         $sql.= "SET ";
         $sql.= "statut = ".$this->statut.",";
-        $sql.= "libelle = '".$this->db->escape($this->libelle) ."',";
+        $sql.= "libelle = '".$this->db->escape($this->label) ."',";
         $sql.= "subscription = '".$this->db->escape($this->subscription)."',";
         $sql.= "note = '".$this->db->escape($this->note)."',";
         $sql.= "vote = '".$this->db->escape($this->vote)."',";

htdocs/adherents/class/api_memberstypes.class.php

@@ -0,0 +1,322 @@
+<?php
+/* Copyright (C) 2017	Regis Houssin	<regis.houssin@capnetworks.com>
+ *
+ * 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.'/adherents/class/adherent_type.class.php';
+
+/**
+ * API class for members types
+ *
+ * @access protected
+ * @class  DolibarrApiAccess {@requires user,external}
+ */
+class MembersTypes extends DolibarrApi
+{
+    /**
+     * @var array   $FIELDS     Mandatory fields, checked when create and update object
+     */
+    static $FIELDS = array(
+        'label'
+    );
+
+    /**
+     * Constructor
+     */
+    function __construct()
+    {
+        global $db, $conf;
+        $this->db = $db;
+    }
+
+    /**
+     * Get properties of a member type object
+     *
+     * Return an array with member type informations
+     *
+     * @param     int     $id ID of member type
+     * @return    array|mixed data without useless information
+     *
+     * @throws    RestException
+     */
+    function get($id)
+    {
+        if(! DolibarrApiAccess::$user->rights->adherent->lire) {
+            throw new RestException(401);
+        }
+
+        $membertype = new AdherentType($this->db);
+        $result = $membertype->fetch($id);
+        if( ! $result ) {
+            throw new RestException(404, 'member type not found');
+        }
+
+        if( ! DolibarrApi::_checkAccessToResource('member',$membertype->id,'adherent_type')) {
+            throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+        }
+
+        return $this->_cleanObjectDatas($membertype);
+    }
+
+    /**
+     * List members types
+     *
+     * Get a list of members types
+     *
+     * @param string    $sortfield  Sort field
+     * @param string    $sortorder  Sort order
+     * @param int       $limit      Limit for list
+     * @param int       $page       Page number
+     * @param string    $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.libelle:like:'SO-%') and (t.subscription:=:'1')"
+     * @return array                Array of member type objects
+     *
+     * @throws RestException
+     */
+    function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 0, $page = 0, $sqlfilters = '') {
+        global $db, $conf;
+
+        $obj_ret = array();
+
+        if(! DolibarrApiAccess::$user->rights->adherent->lire) {
+            throw new RestException(401);
+        }
+
+        $sql = "SELECT t.rowid";
+        $sql.= " FROM ".MAIN_DB_PREFIX."adherent_type as t";
+        $sql.= ' WHERE t.entity IN ('.getEntity('adherent', 1).')';
+
+        // Add sql filters
+        if ($sqlfilters)
+        {
+            if (! DolibarrApi::_checkFilters($sqlfilters))
+            {
+                throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters);
+            }
+	        $regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
+            $sql.=" AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")";
+        }
+
+        $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)
+        {
+            $i=0;
+            $num = $db->num_rows($result);
+            $min = min($num, ($limit <= 0 ? $num : $limit));
+            while ($i < $min)
+            {
+            	$obj = $db->fetch_object($result);
+                $membertype = new AdherentType($this->db);
+                if ($membertype->fetch($obj->rowid)) {
+                    $obj_ret[] = $this->_cleanObjectDatas($membertype);
+                }
+                $i++;
+            }
+        }
+        else {
+            throw new RestException(503, 'Error when retrieve member type list : '.$db->lasterror());
+        }
+        if ( ! count($obj_ret)) {
+            throw new RestException(404, 'No member type found');
+        }
+
+        return $obj_ret;
+    }
+
+    /**
+     * Create member type object
+     *
+     * @param array $request_data   Request data
+     * @return int  ID of member type
+     */
+    function post($request_data = null)
+    {
+        if (! DolibarrApiAccess::$user->rights->adherent->configurer) {
+            throw new RestException(401);
+        }
+        // Check mandatory fields
+        $result = $this->_validate($request_data);
+
+        $membertype = new AdherentType($this->db);
+        foreach($request_data as $field => $value) {
+            $membertype->$field = $value;
+        }
+        if ($membertype->create(DolibarrApiAccess::$user) < 0) {
+            throw new RestException(500, 'Error creating member type', array_merge(array($membertype->error), $membertype->errors));
+        }
+        return $membertype->id;
+    }
+
+    /**
+     * Update member type
+     *
+     * @param int   $id             ID of member type to update
+     * @param array $request_data   Datas
+     * @return int
+     */
+    function put($id, $request_data = null)
+    {
+        if (! DolibarrApiAccess::$user->rights->adherent->configurer) {
+            throw new RestException(401);
+        }
+
+        $membertype = new AdherentType($this->db);
+        $result = $membertype->fetch($id);
+        if( ! $result ) {
+            throw new RestException(404, 'member type not found');
+        }
+
+        if( ! DolibarrApi::_checkAccessToResource('member',$membertype->id,'adherent_type')) {
+            throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+        }
+
+        foreach($request_data as $field => $value) {
+            if ($field == 'id') continue;
+            // Process the status separately because it must be updated using
+            // the validate() and resiliate() methods of the class AdherentType.
+            $membertype->$field = $value;
+        }
+
+        // If there is no error, update() returns the number of affected rows
+        // so if the update is a no op, the return value is zero.
+        if ($membertype->update(DolibarrApiAccess::$user) >= 0)
+            return $this->get($id);
+
+        return false;
+    }
+
+    /**
+     * Delete member type
+     *
+     * @param int $id   member type ID
+     * @return array
+     */
+    function delete($id)
+    {
+        if (! DolibarrApiAccess::$user->rights->adherent->configurer) {
+            throw new RestException(401);
+        }
+        $membertype = new AdherentType($this->db);
+        $result = $membertype->fetch($id);
+        if( ! $result ) {
+            throw new RestException(404, 'member type not found');
+        }
+
+        if ( ! DolibarrApi::_checkAccessToResource('member',$membertype->id,'adherent_type')) {
+            throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
+        }
+
+        if (! $membertype->delete($membertype->id)) {
+            throw new RestException(401,'error when deleting member type');
+        }
+
+        return array(
+            'success' => array(
+                'code' => 200,
+                'message' => 'member type deleted'
+            )
+        );
+    }
+
+    /**
+     * Validate fields before creating an object
+     *
+     * @param array|null    $data   Data to validate
+     * @return array
+     *
+     * @throws RestException
+     */
+    function _validate($data)
+    {
+        $membertype = array();
+        foreach (MembersTypes::$FIELDS as $field) {
+            if (!isset($data[$field]))
+                throw new RestException(400, "$field field missing");
+            $membertype[$field] = $data[$field];
+        }
+        return $membertype;
+    }
+
+    /**
+     * Clean sensible object datas
+     *
+     * @param   object  $object    Object to clean
+     * @return    array    Array of cleaned object properties
+     */
+    function _cleanObjectDatas($object) {
+
+        $object = parent::_cleanObjectDatas($object);
+
+        unset($object->cotisation);
+        unset($object->libelle);
+
+        unset($object->import_key);
+        unset($object->array_options);
+        unset($object->linkedObjectsIds);
+        unset($object->context);
+        unset($object->canvas);
+        unset($object->fk_project);
+        unset($object->contact);
+        unset($object->contact_id);
+        unset($object->thirdparty);
+        unset($object->user);
+        unset($object->origin);
+        unset($object->origin_id);
+        unset($object->ref_ext);
+        unset($object->country);
+        unset($object->country_id);
+        unset($object->country_code);
+        unset($object->barcode_type);
+        unset($object->barcode_type_code);
+        unset($object->barcode_type_label);
+        unset($object->barcode_type_coder);
+        unset($object->mode_reglement_id);
+        unset($object->cond_reglement_id);
+        unset($object->cond_reglement);
+        unset($object->fk_delivery_address);
+        unset($object->shipping_method_id);
+        unset($object->modelpdf);
+        unset($object->fk_account);
+        unset($object->note_public);
+        unset($object->note_private);
+        unset($object->fk_incoterms);
+        unset($object->libelle_incoterms);
+        unset($object->location_incoterms);
+        unset($object->name);
+        unset($object->lastname);
+        unset($object->firstname);
+        unset($object->civility_id);
+        unset($object->total_ht);
+        unset($object->total_tva);
+        unset($object->total_localtax1);
+        unset($object->total_localtax2);
+        unset($object->total_ttc);
+
+        return $object;
+    }
+
+}

htdocs/adherents/type.php

@@ -2,7 +2,7 @@
 /* Copyright (C) 2001-2002	Rodolphe Quiedeville	<rodolphe@quiedeville.org>
  * Copyright (C) 2003		Jean-Louis Bergamo		<jlb@j1b.org>
  * Copyright (C) 2004-2011	Laurent Destailleur		<eldy@users.sourceforge.net>
- * Copyright (C) 2005-2012 Regis Houssin        <regis.houssin@capnetworks.com>
+ * Copyright (C) 2005-2017	Regis Houssin			<regis.houssin@capnetworks.com>
  * Copyright (C) 2013		Florian Henry			<florian.henry@open-concept.pro>
  * Copyright (C) 2015		Alexandre Spangaro		<aspangaro.dolibarr@gmail.com>
  *
@@ -55,7 +55,7 @@ $pagenext = $page + 1;
 if (! $sortorder) {  $sortorder="DESC"; }
 if (! $sortfield) {  $sortfield="d.lastname"; }
 
-$label=GETPOST("libelle","alpha");
+$label=GETPOST("label","alpha");
 $subscription=GETPOST("subscription","int");
 $vote=GETPOST("vote","int");
 $comment=GETPOST("comment");
@@ -93,7 +93,7 @@ if ($action == 'add' && $user->rights->adherent->configurer)
 	{
 		$object = new AdherentType($db);
 
-		$object->libelle        = trim($label);
+		$object->label			= trim($label);
 		$object->subscription	= (int) trim($subscription);
 		$object->note			= trim($comment);
 		$object->mail_valid		= (boolean) trim($mail_valid);
@@ -103,7 +103,7 @@ if ($action == 'add' && $user->rights->adherent->configurer)
 		$ret = $extrafields->setOptionalsFromPost($extralabels,$object);
 		if ($ret < 0) $error++;
 
-		if ($object->libelle)
+		if ($object->label)
 		{
 			$id=$object->create($user);
 			if ($id > 0)
@@ -131,7 +131,7 @@ if ($action == 'update' && $user->rights->adherent->configurer)
 	{
 		$object = new AdherentType($db);
 		$object->id             = $rowid;
-		$object->libelle        = trim($label);
+		$object->label        = trim($label);
 		$object->subscription   = (int) trim($subscription);
 		$object->note           = trim($comment);
 		$object->mail_valid     = (boolean) trim($mail_valid);
@@ -171,7 +171,7 @@ if (! $rowid && $action != 'create' && $action != 'edit')
 {
 	//dol_fiche_head('');
 
-	$sql = "SELECT d.rowid, d.libelle, d.subscription, d.vote";
+	$sql = "SELECT d.rowid, d.libelle as label, d.subscription, d.vote";
 	$sql.= " FROM ".MAIN_DB_PREFIX."adherent_type as d";
 	$sql.= " WHERE d.entity IN (".getEntity().")";
 
@@ -214,7 +214,7 @@ if (! $rowid && $action != 'create' && $action != 'edit')
 			$objp = $db->fetch_object($result);
 			print '<tr class="oddeven">';
 			print '<td><a href="'.$_SERVER["PHP_SELF"].'?rowid='.$objp->rowid.'">'.img_object($langs->trans("ShowType"),'group').' '.$objp->rowid.'</a></td>';
-			print '<td>'.dol_escape_htmltag($objp->libelle).'</td>';
+			print '<td>'.dol_escape_htmltag($objp->label).'</td>';
 			print '<td align="center">'.yn($objp->subscription).'</td>';
 			print '<td align="center">'.yn($objp->vote).'</td>';
 			if ($user->rights->adherent->configurer)
@@ -256,7 +256,7 @@ if ($action == 'create')
 	print '<table class="border" width="100%">';
 	print '<tbody>';
 
-	print '<tr><td class="titlefieldcreate fieldrequired">'.$langs->trans("Label").'</td><td><input type="text" name="libelle" size="40"></td></tr>';
+	print '<tr><td class="titlefieldcreate fieldrequired">'.$langs->trans("Label").'</td><td><input type="text" name="label" size="40"></td></tr>';
 
 	print '<tr><td>'.$langs->trans("SubscriptionRequired").'</td><td>';
 	print $form->selectyesno("subscription",1,1);
@@ -460,7 +460,7 @@ if ($rowid > 0)
 		    {
 				$membertype=new AdherentType($db);
 		        $result=$membertype->fetch($type);
-				$titre.=" (".$membertype->libelle.")";
+				$titre.=" (".$membertype->label.")";
 		    }
 
 		    $param="&rowid=".$rowid;
@@ -548,7 +548,7 @@ if ($rowid > 0)
 		        // Type
 		        /*print '<td class="nowrap">';
 		        $membertypestatic->id=$objp->type_id;
-		        $membertypestatic->libelle=$objp->type;
+		        $membertypestatic->label=$objp->type;
 		        print $membertypestatic->getNomUrl(1,12);
 		        print '</td>';
 				*/
@@ -652,7 +652,7 @@ if ($rowid > 0)
 
 		print '<tr><td width="15%">'.$langs->trans("Ref").'</td><td>'.$object->id.'</td></tr>';
 
-		print '<tr><td>'.$langs->trans("Label").'</td><td><input type="text" name="libelle" size="40" value="'.dol_escape_htmltag($object->libelle).'"></td></tr>';
+		print '<tr><td>'.$langs->trans("Label").'</td><td><input type="text" name="label" size="40" value="'.dol_escape_htmltag($object->label).'"></td></tr>';
 
 		print '<tr><td>'.$langs->trans("SubscriptionRequired").'</td><td>';
 		print $form->selectyesno("subscription",$object->subscription,1);

htdocs/core/class/html.form.class.php

@@ -5904,6 +5904,10 @@ class Form
 		{
 		    $ret.=$object->ref.'<br>'.$object->label;
 		}
+		else if (in_array($object->element, array('adherent_type')))
+		{
+			$ret.=$object->label;
+		}
 		else if ($fieldref != 'none') $ret.=dol_htmlentities($object->$fieldref);