API Documentation RunningExamples debug.pingpong PHP
Aus EUserv Wiki
(Unterschied zwischen Versionen)
Root (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „back to API Documentation <nowiki> <?php //includes the class library include_once("lib/xmlrpc.inc"); $xmlrpc_internalencoding = 'UTF-8'; $host="api.test.e…“) |
Root (Diskussion | Beiträge) |
||
| (Der Versionsvergleich bezieht 3 dazwischenliegende Versionen mit ein.) | |||
| Zeile 1: | Zeile 1: | ||
| - | back to [[API Documentation]] | + | back to [[API_Documentation#PHP_EXAMPLE_2|API Documentation]] |
| - | + | = debug.pingpong = | |
<nowiki> | <nowiki> | ||
<?php | <?php | ||
| + | |||
//includes the class library | //includes the class library | ||
include_once("lib/xmlrpc.inc"); | include_once("lib/xmlrpc.inc"); | ||
$xmlrpc_internalencoding = 'UTF-8'; | $xmlrpc_internalencoding = 'UTF-8'; | ||
| + | |||
| + | |||
$host="api.test.euserv.net"; | $host="api.test.euserv.net"; | ||
$port=443; | $port=443; | ||
| Zeile 12: | Zeile 15: | ||
$api_path="/"; | $api_path="/"; | ||
$parameter="srv_id"; | $parameter="srv_id"; | ||
| - | $wert = "1337"; | + | $wert = "1337"; |
| + | |||
//defines the function | //defines the function | ||
function debug_pingpong($host,$port,$username,$password,$api_path,$parameter,$wert) | function debug_pingpong($host,$port,$username,$password,$api_path,$parameter,$wert) | ||
{ | { | ||
| - | //creates the serverurl | + | |
| - | $serverurl = 'https://'.$host.':'.$port.'/'.$api_path; | + | //creates the serverurl |
| - | //----------creates the message which will be send to the server---------- | + | $serverurl = 'https://'.$host.':'.$port.'/'.$api_path; |
| - | //creates the request for the XML-RPC Server | + | |
| - | $request = new xmlrpcmsg('debug.pingpong'); | + | //----------creates the message which will be send to the server---------- |
| - | //adds parameters to the request | + | |
| - | $request->addParam | + | //creates the request for the XML-RPC Server |
| - | ( | + | $request = new xmlrpcmsg('debug.pingpong'); |
| - | //creates a value of type struct which contains an array with the username and password | + | |
| - | new xmlrpcval | + | //adds parameters to the request |
| - | ( | + | $request->addParam |
| - | array | + | ( |
| - | ( | + | |
| - | //creates a value of type string which contains the "$username" | + | //creates a value of type struct which contains an array with the username and password |
| - | 'login' => new xmlrpcval($username, 'string'), | + | new xmlrpcval |
| - | //creates a value of type string which contains the "$password" | + | ( |
| - | 'password' => new xmlrpcval($password, 'string'), | + | array |
| - | //creates a value of type string which contains the "$parameter" | + | |
| - | $parameter => new xmlrpcval($wert) | + | ( |
| - | ) | + | //creates a value of type string which contains the "$username" |
| - | ,'struct' | + | '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 represents a client of a XML-RPC server---------- | + | |
| - | //creates the client | + | //creates a value of type string which contains the "$parameter" |
| - | $client = new xmlrpc_client($serverurl); | + | $parameter => new xmlrpcval($wert) |
| - | //disable SSL Keycheck | + | ) |
| - | $client->setSSLVerifyPeer(0); | + | ,'struct' |
| - | //----------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 | + | //----------creates the XML-RPC client which represents a client of a XML-RPC server---------- |
| - | //$result_xml = $response->serialize(); | + | |
| - | //checks the response. if the method "faultCode" returns zero, the response was succesfull | + | //creates the client |
| - | if (0==$response->faultCode()) | + | $client = new xmlrpc_client($serverurl); |
| - | { | + | |
| - | //returns the value sent by the server | + | //disable SSL Keycheck |
| - | $value = $response->value(); | + | $client->setSSLVerifyPeer(0); |
| - | //returns the actual PHP-language value of "value" | + | |
| - | $result_obj = $value->scalarval(); | + | //----------sends the request to the server and gets the response---------- |
| - | //destroys "value" | + | |
| - | unset($value); | + | //sends the request via https and writes it into $response. timeout is set to 0 |
| - | } | + | $response = $client->send($request,0,'https'); |
| - | else | + | |
| - | { | + | //generates a storable representation of $response and writes it into $result_xml |
| - | //returns the faultCode and the faultString | + | //$result_xml = $response->serialize(); |
| - | return $error = array ( 'faultCode' => $response->faultCode(), 'faultString' => $response->faultString()); | + | |
| - | } | + | //checks the response. if the method "faultCode" returns zero, the response was succesfull |
| - | //destroys "client" | + | if (0==$response->faultCode()) |
| - | unset($client); | + | { |
| - | //destroys "response" | + | //returns the value sent by the server |
| - | unset($response); | + | $value = $response->value(); |
| - | //----------reads the result_obj---------- | + | |
| - | //if result_obj is set then it returns the actual PHP-language value of "result_obj" | + | //returns the actual PHP-language value of "value" |
| - | if (isset($result_obj['status'])) | + | $result_obj = $value->scalarval(); |
| - | { | + | |
| - | $value['status'] = $result_obj['status']->scalarval(); | + | //destroys "value" |
| - | } | + | unset($value); |
| - | if (isset($result_obj[$parameter])) | + | } |
| - | { | + | else |
| - | $value[$parameter] = $result_obj[$parameter]->scalarval(); | + | { |
| - | } | + | //returns the faultCode and the faultString |
| - | return $value; | + | return $error = array ( 'faultCode' => $response->faultCode(), 'faultString' => $response->faultString()); |
| + | } | ||
| + | |||
| + | //destroys "client" | ||
| + | unset($client); | ||
| + | |||
| + | //destroys "response" | ||
| + | unset($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[$parameter])) | ||
| + | { | ||
| + | $value[$parameter] = $result_obj[$parameter]->scalarval(); | ||
| + | } | ||
| + | |||
| + | return $value; | ||
| + | |||
} | } | ||
| + | |||
//calls the function | //calls the function | ||
$result = debug_pingpong($host,$port,$username,$password,$api_path,$parameter,$wert); | $result = debug_pingpong($host,$port,$username,$password,$api_path,$parameter,$wert); | ||
| + | |||
if(!($result['faultCode'])) | if(!($result['faultCode'])) | ||
{ | { | ||
| - | echo "Status: ".$result['status']." ".$parameter.": ".$result[$parameter]; | + | echo "Status: ".$result['status']." ".$parameter.": ".$result[$parameter]; |
} | } | ||
else | else | ||
{ | { | ||
| - | echo "faultCode: ".$result['faultCode']." faultString: ".$result['faultString']; | + | echo "faultCode: ".$result['faultCode']." faultString: ".$result['faultString']; |
} | } | ||
?> | ?> | ||
</nowiki> | </nowiki> | ||
Aktuelle Version vom 07:23, 6. Sep. 2012
back to API Documentation
debug.pingpong
<?php
//includes the class library
include_once("lib/xmlrpc.inc");
$xmlrpc_internalencoding = 'UTF-8';
$host="api.test.euserv.net";
$port=443;
$username="<API_USER>";
$password="<API_USER_PASSWORD>";
$api_path="/";
$parameter="srv_id";
$wert = "1337";
//defines the function
function debug_pingpong($host,$port,$username,$password,$api_path,$parameter,$wert)
{
//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.pingpong');
//adds parameters to the request
$request->addParam
(
//creates a value of type struct which contains an array with the username and password
new xmlrpcval
(
array
(
//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 a value of type string which contains the "$parameter"
$parameter => new xmlrpcval($wert)
)
,'struct'
)
);
//----------creates the XML-RPC client which represents a client of a XML-RPC server----------
//creates the client
$client = new xmlrpc_client($serverurl);
//disable SSL Keycheck
$client->setSSLVerifyPeer(0);
//----------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"
unset($value);
}
else
{
//returns the faultCode and the faultString
return $error = array ( 'faultCode' => $response->faultCode(), 'faultString' => $response->faultString());
}
//destroys "client"
unset($client);
//destroys "response"
unset($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[$parameter]))
{
$value[$parameter] = $result_obj[$parameter]->scalarval();
}
return $value;
}
//calls the function
$result = debug_pingpong($host,$port,$username,$password,$api_path,$parameter,$wert);
if(!($result['faultCode']))
{
echo "Status: ".$result['status']." ".$parameter.": ".$result[$parameter];
}
else
{
echo "faultCode: ".$result['faultCode']." faultString: ".$result['faultString'];
}
?>

