Merge pull request #12187 from c3do/develop

NEW Add API to get Country by code and iso

htdocs/api/class/api_setup.class.php

@@ -197,13 +197,64 @@ class Setup extends DolibarrApi
      * @throws RestException
      */
     public function getCountryByID($id, $lang = '')
+    {
+        return $this->_fetchCcountry($id, '', '', $lang);
+    }
+
+    /**
+     * Get country by Code.
+     *
+     * @param string    $code      Code of country
+     * @param string    $lang      Code of the language the name of the
+     *                             country must be translated to
+     * @return array 			   Array of cleaned object properties
+     *
+     * @url     GET dictionary/countries/byCode/{code}
+     *
+     * @throws RestException
+     */
+    public function getCountryByCode($code, $lang = '')
+    {
+        return $this->_fetchCcountry('', $code, '', $lang);
+    }
+
+    /**
+     * Get country by Iso.
+     *
+     * @param string    $iso       ISO of country
+     * @param string    $lang      Code of the language the name of the
+     *                             country must be translated to
+     * @return array 			   Array of cleaned object properties
+     *
+     * @url     GET dictionary/countries/byISO/{iso}
+     *
+     * @throws RestException
+     */
+    public function getCountryByISO($iso, $lang = '')
+    {
+        return $this->_fetchCcountry('', '', $iso, $lang);
+    }
+
+    /**
+    * Get country.
+    *
+    * @param int       $id        ID of country
+    * @param string    $code      Code of country
+    * @param string    $iso       ISO of country
+    * @param string    $lang      Code of the language the name of the
+    *                             country must be translated to
+    * @return array 			   Array of cleaned object properties
+    *
+    * @throws RestException
+    */
+    private function _fetchCcountry($id, $code = '', $iso = '', $lang = '')
     {
         $country = new Ccountry($this->db);
 
-        if ($country->fetch($id) < 0) {
+        $result = $country->fetch($id, $code, $iso);
+        if ($result < 0) {
             throw new RestException(503, 'Error when retrieving country : '.$country->error);
-        }
+        } elseif ($result == 0) {
-        elseif ($country->fetch($id) == 0) {
             throw new RestException(404, 'country not found');
         }
 
@@ -320,6 +371,66 @@ class Setup extends DolibarrApi
         }
     }
 
+    /**
+     * Get the list of shipment methods.
+     *
+     * @param string    $sortfield  Sort field
+     * @param string    $sortorder  Sort order
+     * @param int       $limit      Number of items per page
+     * @param int       $page       Page number (starting from zero)
+     * @param int       $active     Payment term is active or not {@min 0} {@max 1}
+     * @param string    $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"
+     *
+     * @return array List of shipment methods
+     *
+     * @url     GET dictionary/shipment_methods
+     *
+     * @throws RestException
+     */
+    public function getListOfShipmentMethods($sortfield = "rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
+    {
+        $list = array();
+        $sql = "SELECT t.code, t.libelle, t.description, t.tracking";
+        $sql.= " FROM ".MAIN_DB_PREFIX."c_shipment_mode as t";
+        $sql.= " WHERE t.active = ".$active;
+        // 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.= $this->db->order($sortfield, $sortorder);
+
+        if ($limit) {
+            if ($page < 0) {
+                $page = 0;
+            }
+            $offset = $limit * $page;
+
+            $sql .= $this->db->plimit($limit, $offset);
+        }
+
+        $result = $this->db->query($sql);
+
+        if ($result) {
+            $num = $this->db->num_rows($result);
+            $min = min($num, ($limit <= 0 ? $num : $limit));
+            for ($i = 0; $i < $min; $i++) {
+                $list[] = $this->db->fetch_object($result);
+            }
+        } else {
+            throw new RestException(503, 'Error when retrieving list of shipment methods : '.$this->db->lasterror());
+        }
+
+        return $list;
+    }
+
     /**
      * Get the list of events types.
      *

htdocs/core/class/ccountry.class.php

@@ -165,9 +165,10 @@ class Ccountry // extends CommonObject
      *
      *  @param      int		$id    	  Id object
      *  @param		string	$code	    Code
+     *  @param		string	$code_iso	Code ISO
      *  @return     int          	>0 if OK, 0 if not found, <0 if KO
      */
-    public function fetch($id, $code = '')
+    public function fetch($id, $code = '', $code_iso = '')
     {
     	global $langs;
       $sql = "SELECT";
@@ -179,6 +180,7 @@ class Ccountry // extends CommonObject
       $sql.= " FROM ".MAIN_DB_PREFIX."c_country as t";
       if ($id) $sql.= " WHERE t.rowid = ".$id;
       elseif ($code) $sql.= " WHERE t.code = '".$this->db->escape($code)."'";
+      elseif ($code_iso) $sql.= " WHERE t.code_iso = '".$this->db->escape($code_iso)."'";
 
     	dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
         $resql=$this->db->query($sql);