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

Timestamp:

01/14/10 16:59:01 (2 years ago)

Author:

nate

Message:

• Removed unneded comments in apiclass.php and api_json.php
• Added ping functionality (for connection / access / tabledef testing) in the api class and the apiwrapper class.

Files:

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

trunk/phpbms/modules/api/apiwrapper.php

@@ -66 +66 @@
         
     }//end function
+    
+    /*
+     * function ping
+     * @param string $tabledefuuid A tabledef uuid.
+     *
+     * @return array|bool An associative array containing the response, or false if a connection error has occured (in which case see $this->errorMessage).
+     * @returnf string type The type of response.  This will either be 'error' or 'message'.
+     * @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
     
     
@@ -284 +308 @@
     /*
      * function runStoredProcedure
-     * 
+     *
+     * @param string $tabledefuuid The uuid of an api accessible tabledefinition.
      * @param string $procedureName The stored procedure to be called.
      *
@@ -292 +317 @@
      */
     
-    public function runStoredProcedure($procedureName) {
+    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);
@@ -719 +745 @@
         fclose($sock);
         ob_end_clean();
-        
         list($throw, $response) = explode("\r\n\r\n", $response, 2);