Changeset 759 for trunk

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.

Location:

trunk/phpbms/modules/api

Files:

• apiwrapper.php (modified) (4 diffs)
• api_json.php (modified) (1 diff)
• include/apiclass.php (modified) (2 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);
         

trunk/phpbms/modules/api/api_json.php

@@ -37 +37 @@
  +-------------------------------------------------------------------------+
 */
-
-//Test Information
-//$_POST["phpbmsusername"] = "api";
-//$_POST["phpbmspassword"] = "spiderman";
-//$_POST["request"] = '[
-//    {
-//        "tabledefid": "tbld:c9ff2c8c-ce1f-659a-9c55-31bca7cce70e",
-//        "command" : "insert",
-//        "data" : {"name":"FOObar","percentage":"3","inactive":"0","createdby":"2","creationdate":"2009-06-25 14:38:02","modifiedby":"2","modifieddate":"2009-06-25 14:38:02","custom1":null,"custom2":null,"custom3":null,"custom4":null,"custom5":null,"custom6":null,"custom7":null,"custom8":null}
-//    }
-//]';
-//$_POST["request"] = '[
-//    {
-//        "tabledefid": "tbld:c9ff2c8c-ce1f-659a-9c55-31bca7cce70e",
-//        "command" : "update",
-//        "data" : {"useUuid":false, "id":2, "name":"JOOOOO","percentage":"3","inactive":"0","createdby":"2","creationdate":"2009-06-25 14:38:02","modifiedby":"2","modifieddate":"2009-06-25 14:38:02","custom1":null,"custom2":null,"custom3":null,"custom4":null,"custom5":null,"custom6":null,"custom7":null,"custom8":null}
-//    }
-//]';
-//$_POST["request"] = '[
-//    {
-//        "tabledefid": "tbld:c9ff2c8c-ce1f-659a-9c55-31bca7cce70e",
-//        "command" : "get",
-//        "data" : {"uuid":"tax:66dd77f5-c68e-74f4-5ce6-64768282b232"}
-//    }
-//]';
-//$_POST["request"] = '[
-//    {
-//        "tabledefid": "tbld:c9ff2c8c-ce1f-659a-9c55-31bca7cce70e",
-//        "command" : "inactivate",
-//        "data" : [4],
-//        "options" : {"useUuid" : false}
-//    }
-//]';
-
-//if(isset($_POST["foo"])){
-//    var_dump(stripslashes($_POST["request"]));
-//    exit;
-//}
-
 require("../../include/session.php");
 require("include/apiclass.php");

trunk/phpbms/modules/api/include/apiclass.php

@@ -456 +456 @@
 
                 switch($request["command"]){
+                    
+                    case "ping":
+                        //======================================================
+                        
+                        $this->_addToResponse("message", "Everything is phpBMSy!");
+                        
+                        break;
 
                     case "insert":
@@ -636 +643 @@
                             include_once("include/search_class.php");
 
-                           //if($useUuid){
-                           //     if(!isset($request["data"]->uuid))
-                           //         $this->sendError("The `uuid` field must be set in request number ".$i, $request["data"], true);
-                           //     else
-                           //         $id = $request["data"]->uuid;
-                           //
-                           // }else{
-                           //     if(!isset($request["data"]->id))
-                           //         $this->sendError("The `id` field must be set in request number ".$i, $request["data"], true);
-                           //     else
-                           //         $id = $request["data"]->uuid;
-                           // }//end if
-
                             if($hasTableClassOveride){