Changeset 764 for trunk/phpbms/modules/bms/include/products.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/bms/include/products.php (modified) (4 diffs)

trunk/phpbms/modules/bms/include/products.php

@@ -534 +534 @@
                 /*
                  * function api_searchByPartNumber
+                 * 
                  * @param array $requestData Array containing the "partnumber" key.
                  * @param bool $returnUuid If true, returns result's uuid , if
                  * false, the id.
+                 * 
                  * @return array An array containing response information
-                 * @returnf string 'type' The type of response (e.g. 'error' or 'result')
-                 * @returnf string 'message' Message explaining the type / result
-                 * @returnf array details Either the array of uuid / ids if no errors
+                 * @returnf string type The type of response (e.g. 'error' or 'result')
+                 * @returnf string message Message explaining the type / result
+                 * @returnf array extras Either the array of uuid / ids if no errors
                  * were encountered, or the original $requestData if there was an error
                  */
@@ -547 +549 @@
                         
                         /**
-                          *  do error search 
+                          *  verify data integrity. 
                           */
+                        
+                        $response["type"] = "";
+                        $response["message"] = "";
                         if(!isset($requestData["partnumber"])){
                                 $response["type"] = "error";
-                                $response["message"] = "Data does not contain a key of 'partnumber'.";
-                                $response["details"] = $requestData;
+                                $response["message"] = "Data does not contain a key of 'partnumber'";
+                        }//end if
+                        
+                        if(!isset($requestData["webenabled"])){
+                                $response["type"] = "error";
+                                if($response["message"])
+                                        $response["message"] .= " or 'webenabled'.";
+                                else
+                                        $response["message"] = "Data does not contain a key of 'webenabled'.";
+                                
+                        }//end if
+                        
+                        if(!isset($requestData["inactive"])){
+                                $response["type"] = "error";
+                                if($response["message"])
+                                        $response["message"] .= " or 'inactive'.";
+                                else
+                                        $response["message"] = "Data does not contain a key of 'inactive'.";
+                                
+                        }//end if
+                        
+                        if($response["type"] == "error")
                                 return $response;
-                        }//end if
+                        
                         
                         /**
@@ -567 +592 @@
                                 WHERE
                                         `partnumber` = '".mysql_real_escape_string($requestData["partnumber"])."'
+                                        AND
+                                        `webenabled` = '".(int)$response["webenabled"]."'
+                                        AND
+                                        `inactive` = '".(int)$response["inactive"]."'
                         ";
                         
@@ -576 +605 @@
                         $thereturn["message"] = "The function api_searchByPartNumber has been run successfully.";
                         $thereturn["type"] = "";
-                        $thereturn["details"] = array();
+                        $thereturn["extras"] = array();
                         while($therecord = $this->db->fetchArray($queryresult)){
                                 
                                 if($returnUuid)
-                                        $thereturn["details"][] = $therecord["uuid"];
+                                        $thereturn["extras"][] = $therecord["uuid"];
                                 else
-                                        $thereturn["details"][] = $therecord["id"];
+                                        $thereturn["extras"][] = $therecord["id"];
                                         
                         }//end while