PHP code snippet

Summary:

An example of a call to XML RPC API with PHP

PHP code snippet

karl3i 26 Nov 2010 22:44

Hi there,

please find hereafter an example of consuming XML RPC API with PHP. It is based on the XML-RPC3.0.0beta downloaded on sourceforge.
You have to modify fields written in Capital letters.

<?php
 
  $sLibPath = dirname(__DIR__)."/lib";
  $sPath = $sLibPath.'/xmlrpc.inc';
 
  require_once($sPath);
 
// https://www.wikidot.com/xml-rpc-api.php
 
    $sServerPath = "xml-rpc-api.php";
    $sServerHostName = "www.wikidot.com";
    $iServerPort = "";
 
    $oClient = new xmlrpc_client($sServerPath,$sServerHostName,$iServerPort);
 
    $oClient->setCredentials("YOUR_WIKIDOT_USERNAME","YOUR_API_KEY");
 
    $oClient->setDebug(2);  // Debugging level
    $oClient->setSSLVerifyPeer(false);
    $oClient->setSSLVerifyHost(false);
 
   // http://developer.wikidot.com/doc:api
   // http://developer.wikidot.com/doc:api-methods
   // site.pages(arguments array)
   // http://phpxmlrpc.sourceforge.net/doc-2/ch07.html#id932680
 
    $sMethodName = "site.pages";
    $sSiteName   = "THE_SITE_NAME"; // (for instance: http://foobar.wikidot.com should be "foobar" for $sSiteName)
 
    $req = new xmlrpcmsg($sMethodName);
    $req->addParam(new xmlrpcval(  array("site" => new xmlrpcval($sSiteName, "string")),"struct"));
 
    $res = $oClient->send($req, 30, "https");
    $value = $res->value();
 
    if(!$res->faultCode()) { // SUCCESS!
 
      echo "success! "; // $value
    }
    else {
      echo "<font color=\"red\"> <H1>Fault</H1><BR>\n".
          " Code: " . $res->faultCode() . "\n<BR>".
          " Reason: " . $res->faultString() . "'\n<BR></font>";
    }
 
// Fault
// Code: 2
// Reason: Invalid return payload: enable debugging to examine incoming payload found not-xmlrpc xml element NIL'  ==> BECAUSE OF NIL NOT RECOGNIZED in the php xml rpc library! Fixing is explained below.
// Fix in file xmlrpc.inc:
// At line 2539, add:
// FIX!!! http://www.devraju.com/2010/07/magento-xml-rpc-api-invalid-return-payload-enable-debugging-to-examine-incoming-payload-found-not-xmlrpc-xml-element-nil-for-product-info/
// $data = str_replace(array('<nil/>','<NIL/>'),'', $data);
// \FIX!!! http://www.devraju.com/2010/07/magento-xml-rpc-api-invalid-return-payload-enable-debugging-to-examine-incoming-payload-found-not-xmlrpc-xml-element-nil-for-product-info/
 
?>

Enjoy!

Karl3i

Re: PHP code snippet

leiger 27 Nov 2010 01:49

Thank you!

I have never tried - does PHP work in the [[html]] code block? Guess I will have to try it later today.

---

~ Shane (Wikidot Community Admin - Volunteer)
Wikidot: Wikidot Editor, Official Docs
Other: YouTube (gaming, primarily Minecraft)

Re: PHP code snippet

karl3i 27 Nov 2010 08:51

You're welcome.

Keep us informed of your test!

Karl3i.

Re: PHP code snippet

leiger 13 Aug 2012 11:53

Hey karl3i,

Only just got around to testing it earlier today, and everything's working perfectly so far. Thanks again :)

Cheers,
Shane

---

~ Shane (Wikidot Community Admin - Volunteer)
Wikidot: Wikidot Editor, Official Docs
Other: YouTube (gaming, primarily Minecraft)

Re: PHP code snippet

Ed Johnson 14 Aug 2012 18:05

and everything's working perfectly so far.

Shane,
I'm working with another user who's new to the API, but gets around PHP pretty well. We're having trouble making the example PHP work in a HTML block. Could you provide a copy of a simple working example (masking your API key of course) so we can figure out what we're doing wrong?

Thanks!

---

Community Admin

Re: PHP code snippet

Steven Heynderickx 14 Aug 2012 20:09

Yes that would be helpfull… I tried and I got following errors:

First a problem with not finding the lib. I assume that this script requires you to install (upload) the files that can be found on http://sourceforge.net/projects/phpxmlrpc/. So I uploaded the three files to a dir named "lib". And replaced the variable part of the $sPath to a fixed adress… That got me going 1 line further in the script… So it finds the "xmlrpc.inc" file but now there is a problem with the "Wrapper".

This is the error I get

Warning: require_once(): http:// wrapper is disabled in the server configuration by allow_url_include=0 in /customers/0/0/3/artizen.be/httpd.www/wikidot/php-test.php on line 7 Warning: require_once(http://artizen.be/wikidot/lib/xmlrpc.inc): failed to open stream: no suitable wrapper could be found in /customers/0/0/3/artizen.be/httpd.www/wikidot/php-test.php on line 7 Fatal error: require_once(): Failed opening required 'http://artizen.be/wikidot/lib/xmlrpc.inc' (include_path='.:/usr/share/php') in /customers/0/0/3/artizen.be/httpd.www/wikidot/php-test.php on line 7

My provider (host) does not allow me to change the php.ini settings… story stops then I assume OR has wikidot this lib also available on one of their servers and can we adress it with our API-key or so?

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Last edited on 14 Aug 2012 20:26 by Steven Heynderickx Show more

Re: PHP code snippet

tsangk 14 Aug 2012 22:38

PHP code will not work within [[html]] or [[code]] blocks.

---

Kenneth Tsang (@jxeeno)

Re: PHP code snippet

Ed Johnson 14 Aug 2012 23:39

I didn't think so. I must have misunderstood what Shane was referring to.

So, back to my original question…
I'd really like to see some sample PHP code that calls a few of the API methods. I have an application where I need to create a few hundred pages in a data form category and I really don't want to create them one-by-one.

---

Community Admin

Re: PHP code snippet

leiger 15 Aug 2012 01:14

Ed Johnson:
We're having trouble making the example PHP work in a HTML block.

Yeah, biggest issue is that it can't be used on Wikidot. You would need to use a separate server, as I'm doing with this project.

Ed Johnson:
I'd really like to see some sample PHP code that calls a few of the API methods. I have an application where I need to create a few hundred pages in a data form category and I really don't want to create them one-by-one.

As for code, what karl3i posted above should work. He's calling the "site.pages" method.

<?php
    /**
     * This is not a complete solution (use the code at the top of this thread for that). I'm merely
     * pulling out a few of the more important lines and describing what they do with comments.
     **/
 
    // Creating the xmlrpc_client object (with URI for Wikidot's API)
    $oClient = new xmlrpc_client($sServerPath,$sServerHostName,$iServerPort);
 
    // Create the xmlrpcmsg object (with method name)
    $req = new xmlrpcmsg($sMethodName);
 
    // Passing in an array as method parameter, with one field: "site"
    $req->addParam(new xmlrpcval(  array("site" => new xmlrpcval($sSiteName, "string")),"struct"));
?>

---

~ Shane (Wikidot Community Admin - Volunteer)
Wikidot: Wikidot Editor, Official Docs
Other: YouTube (gaming, primarily Minecraft)

Last edited on 15 Aug 2012 01:24 by leiger Show more

Re: PHP code snippet

Steven Heynderickx 13 Aug 2012 12:18

I'm wondering what this php script is for… could anyone give some extra info for what you can use this…

Thanks

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Re: PHP code snippet

leiger 13 Aug 2012 23:35

Steven, it's an XML-RPC client for the Wikidot API.

I've seen you interact with the API before using PHP, so I assumed you already knew about this?

Edit: Just occurred to me, perhaps you wrote your own library for handling the calls?

Cheers,
Shane

---

~ Shane (Wikidot Community Admin - Volunteer)
Wikidot: Wikidot Editor, Official Docs
Other: YouTube (gaming, primarily Minecraft)

Last edited on 13 Aug 2012 23:38 by leiger Show more

Re: PHP code snippet

Steven Heynderickx 14 Aug 2012 06:33

yes, that is true, I use php to get things done automatically using the API. However, I am more a hacker then a programmer… and I could not make sens out of the code. So unless I know what it is for, I find it difficult to figure out what it will do…

So please give a small description because XML-RPC client does not ring a bell.

edit After looking again, and your remark "maybe you made your own lib" I saw it… it is a general piece of code that pulls the correct methode-syntax for any given methode… So as a user of this I just need to state my vars, like sitename, username, key AND methode… and the Api will give me the result.

could be usefull… will try this if I find time.

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Last edited on 14 Aug 2012 06:44 by Steven Heynderickx Show more

Re: PHP code snippet

tsangk 14 Aug 2012 06:37

The code that karl3i has provided uses the PHP XML-RPC library rather than the XML-RPC extension which is in the code that you're using. This is useful in servers/hosts where the XML-RPC extension is not configured/installed.

---

Kenneth Tsang (@jxeeno)

Re: PHP code snippet

Steven Heynderickx 14 Aug 2012 06:46

thanks Tsangk,… as you know… you started me up on this… I'm still using your code… MANY THANKS for that.

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Last edited on 14 Aug 2012 06:47 by Steven Heynderickx Show more

Re: PHP code snippet

leiger 14 Aug 2012 06:49

Steven Heynderickx:
yes, that is true, I use php to get things done automatically using the API. However, I am more a hacker then a programmer… and I could not make sens out of the code. So unless I know what it is for, I find it difficult to figure out what it will do…

So please give a small description because XML-RPC client does not ring a bell.

Ah, okay. What tsangk said ^ then, as he explained it well … :) To expand on his post, however:

Wikidot is the XML-RPC Server, and you write an XML-RPC Client to connect to it.

PHP has some built-in functionality for this, but there are also libraries available which extend that functionality. This code uses one of those libraries, which tsangk linked to.

I'm not sure how much experience you have with object-oriented programming (OOP), Steven, but that is being used here which is why the code may look unfamiliar. PHP can be written using an object-oriented approach, but it's completely optional. In most code samples that I've seen, it isn't used.

The following line defines a new object, which represents the XML-RPC Client:

<?php $oClient = new xmlrpc_client($sServerPath,$sServerHostName,$iServerPort); ?>

And the code following that line is generally making use of this client object to connect to the Wikidot API and to make remote procedure calls.

---

~ Shane (Wikidot Community Admin - Volunteer)
Wikidot: Wikidot Editor, Official Docs
Other: YouTube (gaming, primarily Minecraft)

Last edited on 14 Aug 2012 06:52 by leiger Show more

Re: PHP code snippet

Steven Heynderickx 14 Aug 2012 06:53

Much clearer. thanks Shane

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Re: PHP code snippet

Steven Heynderickx 14 Aug 2012 21:13

@ Tsangk … I have no rights to alter the php.ini, but XML-RPC is installed by my host… so I can just keep on working the way I was doing

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Re: PHP code snippet

Steven Heynderickx 14 Aug 2012 06:51

Should the var $sMethodName not also be in Capital letters? I assume you can choose different methodes with this code?

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Re: PHP code snippet

leiger 14 Aug 2012 06:55

Steven Heynderickx:
Should the var $sMethodName not also be in Capital letters? I assume you can choose different methodes with this code?

For a different method, just change the method name here:

<?php $sMethodName = "CHANGE_THIS_VALUE"; ?>

You'll also need to adapt the parameters that you are passing in, based on the method that you are using.

---

~ Shane (Wikidot Community Admin - Volunteer)
Wikidot: Wikidot Editor, Official Docs
Other: YouTube (gaming, primarily Minecraft)

Re: PHP code snippet

Steven Heynderickx 19 Aug 2012 20:22

So in case you have access to a server that runs php… I could give you some sample code to use the API. But I think that is not the case is it?

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Re: PHP code snippet

leiger 19 Aug 2012 23:06

I installed XAMPP on my CentOS server a couple weeks ago, and have been building 'Colombo' mainly in PHP since then, so it definitely works :)

I'd be happy to test out some code for you if you want.

Edit: Or, install a server on your local machine and use that to interpret the PHP.

---

~ Shane (Wikidot Community Admin - Volunteer)
Wikidot: Wikidot Editor, Official Docs
Other: YouTube (gaming, primarily Minecraft)

Last edited on 19 Aug 2012 23:07 by leiger Show more

Re: PHP code snippet

Steven Heynderickx 19 Aug 2012 23:22

i have my server. Our code (tsangk and mine) works. Just wanted to share it. however People are looking in this thread for a solution without having to own a server… so parsing beeing done on the wikidot server… this could be a useful PRO feature.

---

A - S I M P L E - P L A N by ARTiZEN a startingpoint for simple wikidot solutions.

Re: PHP code snippet

leiger 19 Aug 2012 23:33

It would also be a massive security issue, unfortunately. I would assume that is why it's not already possible :\

---

~ Shane (Wikidot Community Admin - Volunteer)
Wikidot: Wikidot Editor, Official Docs
Other: YouTube (gaming, primarily Minecraft)

Last edited on 19 Aug 2012 23:33 by leiger Show more