API Documentation RunningExamples debug.get api version PHP

Aus EUserv Wiki

Wechseln zu: Navigation, Suche

back to API Documentation



//includes the class library
$xmlrpc_internalencoding = 'UTF-8';


//defines the function
function debug_get_api_version($host,$port,$username,$password,$api_path)

  //creates the serverurl
  $serverurl = 'https://'.$host.':'.$port.'/'.$api_path;

  //----------creates the message which will be send to the server----------

  //creates the request for the XML-RPC Server
  $request = new xmlrpcmsg('debug.get_api_version');
  //adds parameters to the request
    //creates a value of type struct which contains an array with the username and password
    new xmlrpcval

        //creates a value of type string which contains the "$username"
        'login' => new xmlrpcval($username, 'string'),
        //creates a value of type string which contains the "$password"
        'password' => new xmlrpcval($password, 'string')

  //----------creates the XML-RPC client which represent a client of an XML-RPC server----------

  //creates the client
  $client = new xmlrpc_client($serverurl);
  //disable SSL Keycheck
  //----------sends the request to the server and gets the response----------
//sends the request via https and writes it into $response. timeout is set to 0
  $response = $client->send($request,0,'https');
  //generates a storable representation of $response and writes it into $result_xml
  //$result_xml = $response->serialize();
  //checks the response. if the method "faultCode" returns zero, the response was succesfull
  if (0==$response->faultCode()) 
      //returns the value sent by the server
      $value = $response->value();
      //returns the actual PHP-language value of "value"
      $result_obj = $value->scalarval();
      //destroys "value"
      //returns the faultCode and the faultString
      return $error = array ( 'faultCode' => $response->faultCode(), 'faultString' => $response->faultString());
  //destroys "client"
  //destroys "response"
  //----------reads the result_obj----------
  //if result_obj is set then it returns the actual PHP-language value of "result_obj"
  if (isset($result_obj['status']))
    $value['status'] = $result_obj['status']->scalarval();
  if (isset($result_obj['api_version']))
    $value['api_version'] = $result_obj['api_version']->scalarval();
  return $value;

//calls the function
$result = debug_get_api_version($host,$port,$username,$password,$api_path);

  echo "Status: ".$result['status']."   API-Version: ".$result['api_version'];
  echo "faultCode: ".$result['faultCode']." faultString: ".$result['faultString'];