Changeset 761

Timestamp:

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

Author:

brieb

Message:

• apiApiMethod had wrong logic for api_mehtod checking

Files:

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

trunk/phpbms/modules/api/apiwrapper.php

@@ -2 +2 @@
 
 class apiwrapper{
-    
+
     /**
-      *  @var string api username 
+      *  @var string api username
       */
     var $username;
-    
+
     /**
-      *  @var string api password 
+      *  @var string api password
       */
     var $password;
-    
+
     /**
       *  @var string the hostname of the target script
       */
     var $apiHostname;
-    
+
     /**
-      *  @var string the url path from $apiHostname to the target script 
+      *  @var string the url path from $apiHostname to the target script
       */
     var $apiUrl;
-    
+
     /**
-      *  @var integer Custom port 
+      *  @var integer Custom port
       */
     var $port = NULL;
-    
+
     /**
-      *  @var bool Whether or not to use an ssl connection 
+      *  @var bool Whether or not to use an ssl connection
       */
     var $secure = false;
-    
+
     /**
-      *  @var integer size (in bytes) of each fread 
+      *  @var integer size (in bytes) of each fread
       */
     var $chunkSize = 8192;
-    
+
     /**
-      *  @var integer time (in seconds) of connection timeout 
+      *  @var integer time (in seconds) of connection timeout
       */
     var $timeout = 300;
-    
-    
+
+
     /*
      * function __construct
-     * 
+     *
      * @param string $hostname The hostname of the target script
      * @param string $urlPath The location of the target script in relation to $hostname (usually something like 'modules/api/api_json.php').
@@ -54 +54 @@
      * @param integer $port If there is a non-standard port (i.e. different than 80 if not using an ssl connection, and different than 443 if using an ssl connection).
      */
-    
+
     public function __construct($hostname, $urlPath, $username, $password, $secure = false, $port = NULL) {
-        
+
         $this->apiHostname = $hostname;
         $this->apiUrl = $urlPath;
@@ -64 +64 @@
         if($port === 0 || (int)$port > 0)
             $this->port = $port;
-        
-    }//end function
-    
+
+    }//end function
+
     /*
      * function ping
@@ -75 +75 @@
      * @returnf string message The related message.  This will be 'Everything is phpBMSy!' if no errors have occurred and the tabledefuuid is api accessible.
      */
-    
+
     function ping($tabledefuuid) {
-        
+
         $params["request"][0]["tabledefid"] = $tabledefuuid;
         $params["request"][0]["command"] = "ping";
         $params["request"][0]["data"] = array();
-        
+
         $response = $this->_callServer($params);
-        
+
         if($response !== false)
             return $response[0];
         else
             return false;
-        
+
     }//end funciton
-    
-    
+
+
     /*
      * function insertRecords
-     * 
+     *
      * @param string $tabledefuuid The uuid of the tabledefinition that you wish to insert records.
      * @param array $data An array of associative arrays consising of fieldname => value pairs.
@@ -101 +101 @@
      * @param string $dateFormat The format of the dates (if any) in $data.  Possible choices are : 'SQL', 'English, US', 'English, UK', or 'Dutch, NL'.  If none of these are chosen, it will default to 'SQL'.
      * @param string $timeFormat The format of the times (if any) in $data.  Possible choices are : '24 Hour' or '12 Hour'.  If none of these are chosen, it will default to '24 Hour'.
-     * 
+     *
      *
      * @return array An array of associative arrays of responses for each insert
@@ -109 +109 @@
      * @returnff string extras The uuid of the inserted record (or the integer id if the 'useUuid' option is false).  <em>Note:</em> his field only exists if type is not 'error'.
      */
-    
+
     public function insertRecords($tabledefuuid, $data, $generateUuid = true, $keepDestId = true, $dateFormat = NULL, $timeFormat = NULL) {
-        
+
         if($generateUuid !== true)
             $generateUuid = false;
-        
+
         if($keepDestId !== true)
             $keepDestId = false;
-            
+
         switch($dateFormat){
-            
+
             case "SQL":
             case "English, US":
@@ -129 +129 @@
                 $dateFormat = "SQL";
             break;
-        
+
         }//end switch
-        
+
         switch($timeFormat){
-            
+
             case "24 Hour":
             case "12 Hour":
@@ -141 +141 @@
                 $timeFormat = "24 Hour";
             break;
-        
+
         }//end switch
-        
+
         $options = array(
                     "useUuid" => $generateUuid,
@@ -150 +150 @@
                     "keepDestId" => $keepDestId
                     );
-        
+
         return $this->_runTableCommnad("insert", $tabledefuuid, $data, $options);
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function updateRecords
-     * 
+     *
      * @param string $tabledefuuid The uuid of the tabledefinition that you wish to update records.
      * @param array $data An array of associative arrays consising of fieldname => value pairs.
@@ -170 +170 @@
      * @returnff string message The detailed message describing the result
      */
-    
+
     public function updateRecords($tabledefuuid, $data, $useUuid = true, $dateFormat = NULL, $timeFormat = NULL) {
-        
+
         if($useUuid !== true)
             $useUuid = false;
-        
+
         switch($dateFormat){
-            
+
             case "SQL":
             case "English, US":
@@ -187 +187 @@
                 $dateFormat = "SQL";
             break;
-        
+
         }//end switch
-        
+
         switch($timeFormat){
-            
+
             case "24 Hour":
             case "12 Hour":
@@ -199 +199 @@
                 $timeFormat = "24 Hour";
             break;
-        
+
         }//end switch
-        
+
         $options = array(
                     "useUuid" => $useUuid,
@@ -207 +207 @@
                     "timeFormat" => $timeFormat
                     );
-        
+
         return $this->_runTableCommnad("update", $tabledefuuid, $data, $options);
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function getRecords
-     * 
+     *
      * @param string $tabledefuuid The uuid of the tabledefinition that you wish to get records.
      * @param mixed $ids Either an array uuids (or ids if $useUuid = false), or an individual uuid (or id).
@@ -226 +226 @@
      * @returnff array extras The associative array containing the record retrieved.  <em>Note:</em> This field only exists if type is not 'error' AND there is a record that corresponds to the uuid/id searched for.
      */
-    
+
     public function getRecords($tabledefuuid, $ids, $useUuid = true) {
-        
+
         if($useUuid !== true)
             $useUuid = false;
-        
+
         if($useUuid)
             $keyName = "uuid";
         else
             $keyName = "id";
-            
+
         if(!is_array($ids))
             $ids = array($ids);
-        
+
         $data = array();
         foreach($ids as $id){
-            
+
             if($useUuid)
                 $id = (string)$id;
@@ -248 +248 @@
                 $id = (int)$id;
             $data[][$keyName] = $id;
-            
+
         }//end foreach
-        
+
         $options = array(
                          "useUuid" => $useUuid
                         );
-        
+
         return $this->_runTableCommnad("get", $tabledefuuid, $data, $options);
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function deleteRecords
-     * 
+     *
      * @param string $tabledefuuid The uuid of the tabledefinition that you wish to delete (or inactivate, depending upon the tabledef) records.
      * @param mixed $ids Either an array uuids (or ids if $useUuid is false), or an individual uuid (or id).
@@ -272 +272 @@
      * @returnff string message The detailed message describing the result
      */
-    
+
     public function deleteRecords($tabledefuuid, $ids, $useUuid = true) {
-        
+
         if($useUuid !== true)
             $useUuid = false;
-        
+
         if($useUuid)
             $keyName = "uuid";
         else
             $keyName = "id";
-            
+
         if(!is_array($ids))
             $ids = array($ids);
-        
+
         $data = array();
         foreach($ids as $id){
-            
+
             if($useUuid)
                 $id = (string)$id;
@@ -294 +294 @@
                 $id = (int)$id;
             $data[][$keyName] = $id;
-            
+
         }//end foreach
-        
+
         $options = array(
                          "useUuid" => $useUuid
                         );
-        
+
         return $this->_runTableCommnad("delete", $tabledefuuid, $data, $options);
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function runStoredProcedure
@@ -316 +316 @@
      * @returnf string message The detailed message describing the result
      */
-    
+
     public function runStoredProcedure($tabledefuuid, $procedureName) {
-        
+
         $params["request"][0]["command"] = "procedure";
         $params["request"][0]["data"]["name"] = $procedurename;
         $params["request"][0]["tabledefid"] = $tabledefuuid;
-        
+
         $response = $this->_callServer($params);
-        
+
         if($response !== false)
             return $response[0];
         else
             return false;
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function getSetting
-     * 
+     *
      * @param array $settings Array of settings names
      *
@@ -343 +343 @@
      * @returnf array extras The associative array containing the settings retrieved.  <em>Note:</em> This field only exists if type is not 'error'.
      */
-    
+
     public function getSettings($settings) {
-        
+
         $params["request"][0]["command"] = "getsettings";
         $params["request"][0]["data"] = $settings;
-        
+
         $response = $this->_callServer($params);
-        
+
         if($response !== false)
             return $response[0];
         else
             return false;
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function searchClientByEmail
@@ -369 +369 @@
      * @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) {
-        
+
         $method = "api_searchByEmail";
         $tabledefuuid = "tbld:6d290174-8b73-e199-fe6c-bcf3d4b61083";
         $data["email"] = (string)$email;
-        
+
         if($useUuid !== true)
             $useUuid = false;
-        
+
         $options = array(
-                          "useUuid" => $useUuid  
+                          "useUuid" => $useUuid
                         );
-        
+
         $response = $this->runApiMethod($method, $tabledefuuid, $data, $options);
-        
+
         if($response !== false)
             return $response[0];
         else
             return false;
-        
-    }//end function
-    
+
+    }//end function
+
     /*
      * function searchClientByNameAndPostalcode
@@ -404 +404 @@
      * @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) {
-        
+
         $method = "api_searchByNameAndPostalcode";
         $tabledefuuid = "tbld:6d290174-8b73-e199-fe6c-bcf3d4b61083";
@@ -412 +412 @@
         $data["lastname"] = (string)$lastname;
         $data["postalcode"] = (string)$postalcode;
-        
+
         if($useUuid !== true)
             $useUuid = false;
-        
+
         $options = array(
-                          "useUuid" => $useUuid  
+                          "useUuid" => $useUuid
                         );
-        
+
         $response = $this->runApiMethod($method, $tabledefuuid, $data, $options);
-        
+
         if($response !== false)
             return $response[0];
         else
             return false;
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function searchClientByUsernameAndPassword
@@ -441 +441 @@
      * @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) {
-        
+
         $method = "api_searchByUsernameAndPassword";
         $tabledefuuid = "tbld:6d290174-8b73-e199-fe6c-bcf3d4b61083";
         $data["username"] = (string)$username;
         $data["password"] = (string)$password;
-        
+
         if($useUuid !== true)
             $useUuid = false;
-        
+
         $options = array(
-                          "useUuid" => $useUuid  
+                          "useUuid" => $useUuid
                         );
-        
+
         $response = $this->runApiMethod($method, $tabledefuuid, $data, $options);
-        
+
         if($response !== false)
             return $response[0];
         else
             return false;
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function searchSalesOrdersByClientUuid
@@ -479 +479 @@
      * @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) {
-        
+
         $method = "api_searchByClientUuid";
         $tabledefuuid = "tbld:62fe599d-c18f-3674-9e54-b62c2d6b1883";
@@ -491 +491 @@
         if($enddate !== NULL)
             $data["enddate"] = $enddate;
-            
+
         if($useUuid !== true)
             $useUuid = false;
-        
+
         $options = array(
-                          "useUuid" => $useUuid  
+                          "useUuid" => $useUuid
                         );
-            
+
         $response = $this->runApiMethod($method, $tabledefuuid, $data, $options);
-        
+
         if($response !== false)
             return $response[0];
         else
             return false;
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function getFile
@@ -515 +515 @@
      * @return mixed The file if successful, false, if not.
      */
-    
+
     public function getFile($url) {
-        
+
         $urlInfo = parse_url($url);
-        
+
         $oldHost = $this->apiHostname;
         $oldPort = $this->port;
         $oldUrl = $this->apiUrl;
-        
+
         $this->apiHostname = $urlInfo["host"];
         if($port === 0 || (int)$port > 0)
@@ -530 +530 @@
             $this->port = NULL;
         $this->apiUrl = $urlInfo["path"]."?".$urlInfo["query"];
-        
+
         $response = $this->_callServer(array());
-        
+
         $this->apiUrl = $oldUrl;
         $this->apiHostname = $oldHost;
         $this->port = $oldPort;
-        
+
         if($response !== false)
             return $response;
@@ -543 +543 @@
             return false;
         }//end if
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function runApiMethod
-     * 
+     *
      * @param string $method The name of the api method to be called.  This must start with 'api_'.
      * @param string $tabledefuuid The uuid of the tabledefinition with the relevant api method.
@@ -557 +557 @@
      * @return mixed Response dependent upon the api command
      */
-    
+
     public function runApiMethod($method, $tabledefuuid, $data, $options = NULL) {
-        
-        if(substr($method, 0, 4) == "api_"){
+
+        if(substr($method, 0, 4) != "api_"){
+
             $this->errorMessage = "The command is not a valid api method";
             return false;
+
         }//end if
-        
+
         $params["request"][0]["tabledefid"] = $tabledefuuid;
         $params["request"][0]["options"] = $options;
         $params["request"][0]["command"] = $method;
         $params["request"][0]["data"] = $data;
-        
+
         return $this->_callServer($params);
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function runSearchMethod
-     * 
+     *
      * @param string $method The name of the api method to be called.  This must start with 'api_'.
      * @param string $tabledefuuid The uuid of the tabledefinition with the relevant api method.
@@ -589 +591 @@
      * @returnff array extras The associative array containing the record retrieved.  <em>Note:</em> This field only exists if type is 'error'.
      */
-    
+
     public function runSearchMethod($method, $tabledefuuid, $data, $options = NULL) {
-        
+
         if(substr($method, 0, 4) == "api_"){
             $this->errorMessage = "The command is not a valid search method";
             return false;
         }//end if
-        
+
         switch($method){
-            
+
             case "insert":
             case "update":
@@ -608 +610 @@
                 return false;
                 break;
-            
+
         }//end switch
-        
+
         return $this->_runTableCommnad($method, $tabledefuuid, $data, $options);
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function _runTableCommnad
-     * 
+     *
      * @param string $command The api command
      * @param string $tabledefuuid The uuid of the tabledefinition with the relevant method.
@@ -626 +628 @@
      * @return array The response from _callServer
      */
-    
+
     private function _runTableCommnad($command, $tabledefuuid, $records, $options) {
-        
+
         $params = array();
         $i = 0;
@@ -638 +640 @@
             $i++;
         }//end foreach
-        
+
         return $this->_callServer($params);
-        
-        
-    }//end function
-    
-    
+
+
+    }//end function
+
+
     /*
      * function _encode
-     * 
+     *
      * @param array $message Message to be encoded
-     * 
+     *
      * @return string Encoded message
      */
-    
+
     private function _encode($message) {
-        
+
         return json_encode($message);
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function _decode
-     * 
+     *
      * @param string $response Encoded api response
-     * 
+     *
      * @return array Decoded api response
      */
-    
+
     private function _decode($response) {
-        
+
         return json_decode($response, true);
-        
-    }//end function
-    
-    
+
+    }//end function
+
+
     /*
      * function _callServer
-     * 
+     *
      * @param array $params
-     * 
+     *
      * @return array False if major (i.e. connection) error has occurred.  Otherwise, returns an array of associative arrays.
      */
-    
+
     private function _callServer($params) {
-        
+
         $params["phpbmsusername"] = $this->username;
         $params["phpbmspassword"] = $this->password;
-        
+
         if(!isset($params["request"]))
             $params["request"] = array();
-        
+
         $params["request"] = $this->_encode($params["request"]);
-            
-        
+
+
         $this->errorMessage = "";
         $this->errorCode = "";
-        
+
         $post_vars = http_build_query($params);
-        
+
         $payload = "POST " .$this->apiUrl. " HTTP/1.0\r\n";
         $payload .= "Host: " . $this->apiHostname . "\r\n";
@@ -705 +707 @@
         $payload .= "Connection: close \r\n\r\n";
         $payload .= $post_vars;
-        
+
         ob_start();
         if ($this->secure){
-            
+
             if($this->port !== NULL)
                 $port = $this->port;
             else
                 $port = 443;
-            
+
             $sock = fsockopen("ssl://".$this->apiHostname, $port, $errno, $errstr, 30);
         } else {
-            
+
             if($this->port !== NULL)
                 $port = $this->port;
             else
                 $port = 80;
-            
+
             $sock = fsockopen($this->apiHostname, $port, $errno, $errstr, 30);
         }
@@ -730 +732 @@
             return false;
         }
-        
+
         $response = "";
         fwrite($sock, $payload);
@@ -746 +748 @@
         ob_end_clean();
         list($throw, $response) = explode("\r\n\r\n", $response, 2);
-        
+
         if ($info["timed_out"]) return false;
-        
+
         if(ini_get("magic_quotes_runtime")) $response = stripslashes($response);
-        
-        
+
+
         $decodedResponse = $this->_decode($response);
-            
+
         if($response && $decodedResponse === false) {
             $this->errorMessage = "Bad Response. Got This:".$response;
@@ -760 +762 @@
             $response = $decodedResponse;
         }
-        
+
         return $response;
-        
+
     }//end function --_callServer--
-    
+
 }//end class