Changeset 764 for trunk/phpbms

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.

Location:

trunk/phpbms/modules

Files:

• api/apiwrapper.php (modified) (10 diffs)
• bms/include/products.php (modified) (4 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
 

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