More complete examples

Dolibarr · Apr 1, 2019 · c7e4cd7 · c7e4cd7
1 parent 5d9a7e0
commit c7e4cd7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/htdocs/adherents/class/api_members.class.php b/htdocs/adherents/class/api_members.class.php
@@ -86,7 +86,8 @@ public function get($id)
      * @param int       $limit      Limit for list
      * @param int       $page       Page number
      * @param string    $typeid     ID of the type of member
-     * @param string    $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
+     * @param string    $sqlfilters Other criteria to filter answers separated by a comma.
+     *                              Example: "(t.ref:like:'SO-%') and ((t.date_creation:<:'20160101') or (t.nature:is:NULL))"
      * @return array                Array of member objects
      *
      * @throws RestException

diff --git a/htdocs/api/class/api.class.php b/htdocs/api/class/api.class.php
@@ -279,7 +279,7 @@ protected function _checkFilters($sqlfilters)
 	/**
 	 * Function to forge a SQL criteria
 	 *
-	 * @param  array    $matches       Array of found string by regex search
+	 * @param  array    $matches       Array of found string by regex search. Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.nature:is:NULL"
 	 * @return string                  Forged criteria. Example: "t.field like 'abc%'"
 	 */
 	protected static function _forge_criteria_callback($matches)