Changeset 764 for trunk/phpbms/modules/api/apiwrapper.php

Timestamp:

01/15/10 15:01:40 (2 years ago)

Author:

nate

Message:

• Product api functions now have responses consitent with the api / other table api functions.
• api_searchByPartNumber can now distinguish between webenabled and non-webenabled records as well as inactive and non-inactive records.
• Further described the getDefaults apiwrapper function.
• Added a searchProductsByPartnumber function in the apiwrapper.

Files:

• trunk/phpbms/modules/api/apiwrapper.php (modified) (10 diffs)

trunk/phpbms/modules/api/apiwrapper.php

@@ -263 +263 @@
      * function getDefaults
      *
-     */
-
-    function getDefaults($tabledefuuid){
+     * @param string $tabledefuuid The uuid of the tabledefinition that you wish to get defaults.
+     *
+     * @return array An associative array response for the get
+     * @returnf string type The result of the procedure (either 'retrieved' if successful, or 'error' if not).
+     * @returnf string message The detailed message describing the result
+     * @returnf array extras The associative array containing the default record.  <em>Note:</em> This field only exists if type is not 'error'.
+     */
+
+    public function getDefaults($tabledefuuid){
 
         $params["request"][0]["command"] = "getDefaults";
@@ -383 +389 @@
      * function searchClientByEmail
      * @param string $email The email to be searched for
-     * @param bool $useUuid Whether to return uuids or ids.
+     * @param bool $returnUuid Whether to return uuids or ids.
      *
      * @return array An associative array response for the get
      * @returnf string type The result of the get (either 'result' if successful, or 'error' if not).
      * @returnf string message The detailed message describing the result
-     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'useUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
-     */
-
-    public function searchClientByEmail($email, $useUuid = true) {
+     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'returnUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
+     */
+
+    public function searchClientByEmail($email, $returnUuid = true) {
 
         $method = "api_searchByEmail";
@@ -397 +403 @@
         $data["email"] = (string)$email;
 
-        if($useUuid !== true)
-            $useUuid = false;
+        if($returnUuid !== true)
+            $returnUuid = false;
 
         $options = array(
-                          "useUuid" => $useUuid
+                          "useUuid" => $returnUuid
                         );
 
@@ -418 +424 @@
      * @param name $lastname The last name to search for in the client's table
      * @param name $postalcode The postal code to search for in the client's table
-     * @param bool $useUuid Whether to return uuids or ids.
+     * @param bool $returnUuid Whether to return uuids or ids.
      *
      * @return array An associative array response for the get
      * @returnf string type The result of the get (either 'result' if successful, or 'error' if not).
      * @returnf string message The detailed message describing the result
-     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'useUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
-     */
-
-    public function searchClientByNameAndPostalcode($firstname, $lastname, $postalcode, $useUuid = true) {
+     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'returnUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
+     */
+
+    public function searchClientByNameAndPostalcode($firstname, $lastname, $postalcode, $returnUuid = true) {
 
         $method = "api_searchByNameAndPostalcode";
@@ -434 +440 @@
         $data["postalcode"] = (string)$postalcode;
 
-        if($useUuid !== true)
-            $useUuid = false;
+        if($returnUuid !== true)
+            $returnUuid = false;
 
         $options = array(
-                          "useUuid" => $useUuid
+                          "useUuid" => $returnUuid
                         );
 
@@ -455 +461 @@
      * @param string $username The username to search for in the client's table
      * @param string $password The password to search for in the client's table
-     * @param bool $useUuid Whether to return uuids or ids.
+     * @param bool $returnUuid Whether to return uuids or ids.
      *
      * @return array An associative array response for the get
      * @returnf string type The result of the get (either 'result' if successful, or 'error' if not).
      * @returnf string message The detailed message describing the result
-     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'useUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
-     */
-
-    public function searchClientByUsernameAndPassword($username, $password, $useUuid = true) {
+     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'returnUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
+     */
+
+    public function searchClientByUsernameAndPassword($username, $password, $returnUuid = true) {
 
         $method = "api_searchByUsernameAndPassword";
@@ -470 +476 @@
         $data["password"] = (string)$password;
 
-        if($useUuid !== true)
-            $useUuid = false;
+        if($returnUuid !== true)
+            $returnUuid = false;
 
         $options = array(
-                          "useUuid" => $useUuid
+                          "useUuid" => $returnUuid
                         );
 
@@ -493 +499 @@
      * @param string $startdate The sql encoded DATETIME lower range of creation dates.
      * @param string $enddate The sql encoded DATETIME upper range of creation dates.
-     * @param bool $useUuid Whether to return uuids or ids.
+     * @param bool $returnUuid Whether to return uuids or ids.
      *
      * @return array An associative array response for the get
      * @returnf string type The result of the get (either 'result' if successful, or 'error' if not).
      * @returnf string message The detailed message describing the result
-     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'useUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
-     */
-
-    function searchSalesOrdersByClientUuid($clientuuid, $ordertype = NULL, $startdate = NULL, $enddate = NULL, $useUuid = true) {
+     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'returnUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
+     */
+
+    function searchSalesOrdersByClientUuid($clientuuid, $ordertype = NULL, $startdate = NULL, $enddate = NULL, $returnUuid = true) {
 
         $method = "api_searchByClientUuid";
@@ -513 +519 @@
             $data["enddate"] = $enddate;
 
-        if($useUuid !== true)
-            $useUuid = false;
+        if($returnUuid !== true)
+            $returnUuid = false;
 
         $options = array(
-                          "useUuid" => $useUuid
+                          "useUuid" => $returnUuid
                         );
 
@@ -527 +533 @@
             return false;
 
+    }//end function
+    
+    
+    /*
+     * function searchProductsByPartnumber
+     * @param $partnumber
+     * @param $webenabled
+     * @param $inactive
+     * @param $returnUuid
+     *
+     * @return array An associative array response for the get
+     * @returnf string type The result of the get (either 'result' if successful, or 'error' if not).
+     * @returnf string message The detailed message describing the result
+     * @returnf array extras If the type is 'result', this will be a (possibly empty) array of uuids (or ids if the 'returnUuid' option is false).  <em>Note:</em> This field only exists if type is not 'error'.
+     */
+    
+    public function searchProductsByPartnumber($partnumber, $webenabled = true, $inactive = false, $returnUuid = true) {
+        
+        $method = "api_searchByPartNumber";
+        $tabledefuuid = "tbld:7a9e87ed-d165-c4a4-d9b9-0a4adc3c5a34";
+        $data["partnumber"] = (string)$partnumber;
+        $data["webenabled"] = (bool)$webenabled;
+        $data["inactive"] = (bool)$inactive;
+        
+        $returnUuid = (bool)$returnUuid;
+        
+        $options = array(
+                          "useUuid" => $returnUuid
+                        );
+
+        $response = $this->runApiMethod($method, $tabledefuuid, $data, $options);
+
+        if($response !== false)
+            return $response[0];
+        else
+            return false;
+        
     }//end function