Blame - user_guide/libraries/xmlrpc.html - code-igniter-v3-giggi

<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.codeigniter.com/user_guide/" />Search User Guide  <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>

53

</tr>

54

</table>

55

<h1>XML-RPC and XML-RPC Server Classes</h1>

65

66

67

<p>Code Igniter's XML-RPC classes permit you to send requests to another server, or set up

68

your own XML-RPC server to receive requests.</p>

<p>Quite simply it is a way for two computers to communicate over the internet using XML.

74

One computer, which we will call the <dfn>client</dfn>, sends an XML-RPC <strong>request</strong> to

75

another computer, which we will call the <dfn>server</dfn>. Once the server receives and processes the request it

76

will send back a <strong>response</strong> to the client.</p>

77

78

<p>For example, using the MetaWeblog API, an XML-RPC Client (usually a desktop publishing tool) will

79

send a request to an XML-RPC Server running on your site. This request might be a new weblog entry

80

being sent for publication, or it could be a request for an existing entry for editing.

81

82

When the XML-RPC Server receives this request it will examine it to determine which class/method should be called to process the request.

83

Once processed, the server will then send back a response message.</p>

84

85

<p>For detailed spcifications, you can visit the <a href="http://www.xmlrpc.com/">XML-RPC</a> site.</p>

86

87

<h2>Initializing the Class</h2>

88

89

<p>Like most other classes in Code Igniter, the XML-RPC and XML-RPCS classes are initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>

90

91

<p>To load the XML-RPC class you will use:

92

<code>$this->load->library('xmlrpc');</code>

93

<p>Once loaded, the xml-rpc library object will be available using: <dfn>$this->xmlrpc</dfn></p>

94

95

<p>To load the XML-RPC Server class you will use:

96

<code>$this->load->library('xmlrpcs');</code>

97

<p>Once loaded, the xml-rpcs library object will be available using: <dfn>$this->xmlrpcs</dfn></p>

<h2>Sending XML-RPC Requests</h2>

102

103

<p>To send a request to an XML-RPC server you must specify the following information:</p>

104

105

<ul>

106

<li>The URL of the server</li>

107

<li>The method on the server you wish to call</li>

108

<li>The <em>request</em> data (explained below).</li>

109

</ul>

110

111

<p>Here is a basic example that sends a simple Weblogs.com ping to the <a href="http://pingomatic.com/">Ping-o-Matic</a></p>

112

113

114

<code>$this->load->library('xmlrpc');<br />

115

<br />

116

$this->xmlrpc->server('http://rpc.pingomatic.com/', 80);<br />

117

$this->xmlrpc->method('weblogUpdates.ping');<br />

118

119

<br />

120

$request = array('My Photoblog', 'http://www.my-site.com/photoblog/');<br />

121

$this->xmlrpc->request($request);<br />

122

<br />

123

if ( ! $this->xmlrpc->send_request())<br />

124

{<br />

125

    echo $xmlrpc->display_error();<br />

}

</code>

<h3>Explanation</h3>

<p>The above code initializes the XML-RPC class, sets the server URL and method to be called (weblogUpdates.ping). The

132

request (in this case, the title and URL of your site) is placed into an array for transportation, and

133

compiled using the request() function.

134

Lastly, the full request is sent. If the <dfn>send_request()</dfn> method returns false we will display the error message

135

sent back from the XML-RPC Server.</p>

136

137

<h2>Anatomy of a Request</h2>

138

139

<p>An XML-RPC <dfn>request</dfn> is simply the data you are sending to the XML-RPC server. Each piece of data in a request

140

is referred to as a <dfn>request parameter</dfn>. The above example has two parameters:

141

The URL and title of your site. When the XML-RPC server receives your request, it will look for parameters it requires.</p>

142

143

<p>Request parameters must be placed into an array for transportation, and each parameter can can be one

144

of seven data types (strings, numbers, dates, etc.). If your parameters are something other than strings

145

you will have to include the data type in the request array.</p>

146

147

<p>Here is an example of a simple array with three parameters:</p>

148

149

<code>$request = array('John', 'Doe', 'www.some-site.com');<br />

150

$this->xmlrpc->request($request);</code>

151

152

<p>If you use data types other than strings, or if you have several different data types, you will place

153

each parameter into its own array, with the data type in the second position:</p>

154

155

<code>

156

$request = array (<br />

157

                   array('John', 'string'),<br />

158

                   array('Doe', 'string'),<br />

159

                   array(FALSE, 'boolean'),<br />

160

                   array(12345, 'int')<br />

161

                 );

162

<br />

163

$this->xmlrpc->request($request);</code>

164

165

The <a href="#datatypes">Data Types</a> section below has a full list of data types.</p>

<h2>Creating an XML-RPC Server</h2>

170

171

<p>An XML-RPC Server acts as a traffic cop of sorts, waiting for incoming requests and redirecting them to the

172

appropriate functions for processing.</p>

173

174

<p>To create your own XML-RPC server involves initializing the XML-RPC Server class in your controller where you expect the incoming

175

request to appear, then setting up an array with mapping instructions so that incoming requests can be sent to the appropriate

176

class and method for processing.</p>

177

178

<p>Here is an example to illustrate:</p>

179

180

<code>$this->load->library('xmlrpcs');<br />

181

<br />

182

$config['functions']['<var>new_post</var>'];  = array('function' => '<dfn>My_blog.new_entry</dfn>');<br />

183

$config['functions']['<var>update_post</var>'] = array('function' => '<dfn>My_blog.update_entry</dfn>');<br />

184

<br />

185

$this->xmlrpcs->initialize($config);<br />

186

$this->xmlrpcs->serve();</code>

187

188

<p>The above example contains an array specifying two method requests that the Server allows.

189

The allowed methods are on the left side of the array. When either of those are received, they will be mapped to the class and method on the right.

190

191

<p>In other words, if an XML-RPC Client sends a request for the <var>new_post</var> method, your

192

server will load the <dfn>My_blog</dfn> class and call the <dfn>new_entry</dfn> function.

193

If the request is for the <var>update_post</var> method, your

194

server will load the <dfn>My_blog</dfn> class and call the <dfn>update_entry</dfn> function.</p>

195

196

<p>The function names in the above example are arbitrary. You'll decide what they should be called on your server,

197

or if you are using standardized APIs, like the Blogger or MetaWeblog API, you'll use their function names.</p>

198

199

200

<h2>Processing Server Requests</h2>

201

202

<p>When the XML-RPC Server receives a request and loads the class/method for processing, it will pass

203

an object to that method containing the data sent by the client.</p>

204

205

<p>Using the above example, if the <var>new_post</var> method is requested, the server will expect a class

206

to exist with this prototype:</p>

207

208

<code>class <kbd>My_blog</kbd> extends Controller {<br />

209

<br />

210

    function <kbd>new_post</kbd>(<var>$request</var>)<br />

    {<br />

<br />

    }<br />

}

</code>

<p>The <var>$request</var> variable is an object compiled by the Server, which contains the data sent by the XML-RPC Client.

218

Using this object you will have access to the <em>request parameters</em> enabling you to process the request. When

219

you are done you will send a <dfn>Response</dfn> back to the Client.<p>

220

221

<p>Below is a real-world example, using the Blogger API. One of the methods in the Blogger API is <dfn>getUserInfo()</dfn>.

222

Using this method, an XML-RPC Client can send the Server a username and password, in return the Server sends

223

back information about that particular user (nickname, user ID, email address, etc.). Here is how the processing

224

function might look:</p>

225

226

227

<code>class <kbd>My_blog</kbd> extends Controller {<br />

228

<br />

229

    function <kbd>getUserInfo</kbd>(<var>$request</var>)<br />

230

    {<br />

231

232

        $username = 'smitty';<br />

233

        $password = 'secretsmittypass';<br /><br />

234

235

        $this->load->library('xmlrpc');<br />

236

    <br />

237

        $parameters = $request->output_parameters();<br />

238

    <br />

239

        if ($parameters['1'] != $username AND $parameters['2'] != $password)<br />

240

        {<br />

241

            return $this->xmlrpc->send_error_message('100', 'Invalid Access');<br />

242

        }<br />

243

    <br />

244

        $response = array(array('nickname'  => array('Smitty','string'),<br />

245

                                'userid'    => array('99','string'),<br />

246

                                'url'       => array('http://yoursite.com','string'),<br />

247

                                'email'     => array('jsmith@yoursite.com','string'),<br />

248

                                'lastname'  => array('Smith','string'),<br />

249

                                'firstname' => array('John','string')<br />

250

                                ),<br />

251

                         'struct');<br />

252

<br />

253

        $this->xmlrpc->send_response($response);<br />

    }<br />

}

</code>

<h3>Notes:</h3>

<p>The <dfn>output_parameters()</dfn> function retrieves an indexed array corresponding to the request parameters sent by the client.

260

In the above example, the output parameters will be the username and password.</p>

261

262

<p>If the username and password sent by the client were not valid, and error message is returned using <dfn>send_error_message()</dfn>.</p>

263

264

<p>If the operation was successful, the client will be sent back a response array containing the user's info.</p>

265

266

267

<h2>Formatting a Response</h2>

268

269

<p>Similar to <em>Requests</em>, <em>Responses</em> must be formatted as an array. However, unlike requests, a response is an array

270

<strong>that contains a single item</strong>. This item can be an array with several additional arrays, but there

271

can be only one primary array index. In other words, the basic prototype is this:</p>

272

273

<code>$request = array('Response data', 'array');</code>

274

275

<p>Responses, however, usually contain multiple pieces of information. In order to accomplish this we must put the response into its own

276

array so that the primary array continues to contain a single piece of data. Here's an example showing how this might be accomplished:</p>

277

278

<code>

279

$request = array (<br />

280

                   array(<br />

281

                         'first_name' => array('John', 'string'),<br />

282

                         'last_name' => array('Doe', 'string'),<br />

283

                         'member_id' => array(123435, 'int'),<br />

284

                         'todo_list' => array(array('clean house', 'call mom', 'water plants'), 'array'),<br />

285

                        ),<br />

286

                 'struct'<br />

                 );

</code>

<p class="important">Notice that the above array is formatted as a <dfn>struct</dfn>. This is the most common data type for responses.</p>

291

292

<p>As with Requests, a response can be on of the seven data types listed in the <a href="#datatypes">Data Types</a> section.</p>

293

294

295

<h2>Sending an Error Response</h2>

296

297

<p>If you need to send the client an error response you will use the following:</p>

298

299

<code>return $this->xmlrpc->send_error_message('123', 'Requested data not available');</code>

300

301

<p>The first parameter is the error number while the second parameter is the error message.</p>

<h2>Creating Your Own Client and Server</h2>

309

310

<p>To help you understand everything we've covered thus far, let's create a couple controllers that act as

311

XML-RPC Client and Server. You'll use the Client to send a request to the Server and receive a response.</p>

<h3>The Client</h3>

<p>Using a text editor, create a controller called <dfn>xmlrpc_client.php</dfn>.

316

In it, place this code and save it to your <samp>applications/controllers/</samp> folder:</p>

317

318

<textarea class="textarea" style="width:100%" cols="50" rows="32"><?php

319

320

class Xmlrpc_client extends Controller {

function index()

{

$this->load->helper('url');

325

$server_url = site_url('xmlrpc_server');

326

327

$this->load->library('xmlrpc');

328

329

$this->xmlrpc->server($server_url, 80);

330

$this->xmlrpc->method('Greetings');

331

332

$request = array('How is it going?');

333

$this->xmlrpc->request($request);

334

335

if ( ! $this->xmlrpc->send_request())

336

{

337

echo $this->xmlrpc->display_error();

}

else

{

echo '<pre>';

print_r($this->xmlrpc->display_response());

echo '</pre>';

}

}

}

?></textarea>

<p>Note: In the above code we are using a "url helper". You can find more information in the <a href="../general/helpers.html">Helpers Functions</a> page.</p>

<h3>The Server</h3>

<p>Using a text editor, create a controller called <dfn>xmlrpc_server.php</dfn>.

354

In it, place this code and save it to your <samp>applications/controllers/</samp> folder:</p>

355

356

<textarea class="textarea" style="width:100%" cols="50" rows="30"><?php

357

358

class Xmlrpc_server extends Controller {

function index()

{

$this->load->library('xmlrpcs');

363

364

$config['functions']['Greetings'] = array('function' => 'Xmlrpc_server.process');

365

366

$this->xmlrpcs->initialize($config);

367

$this->xmlrpcs->serve();

}

function process($request)

372

{

373

$parameters = $request->output_parameters();

$response = array(

array(

'you_said' => $parameters['0'],

378

'i_respond' => 'Not bad at all.'),

379

'struct');

380

381

return $this->xmlrpc->send_response($response);

}

}

?></textarea>

<p>Now visit the your site using a URL similar to this:</p>

389

<code>www.your-site.com/index.php/<var>xmlrpc_client</var>/</code>

390

391

<p>You should now see the message you sent to the server, and its response back to you.</p>

392

393

<p>The client you created sends a message ("How's is going?") to the server, along with a reqest for the "Greetings" method.

394

The Server receives the request and maps it to the "process" function, where a response is sent back.</p>

<h1>XML-RPC Function Reference</h1>

400

401

<h2>$this->xmlrpc->server()</h2>

402

<p>Sets the URL and port number of the server to which a request is to be sent:</p>

403

<code>$this->xmlrpc->server('http://www.sometimes.com/pings.php', 80);</code>

404

405

<h2>$this->xmlrpc->timeout()</h2>

406

<p>Set a time out period (in seconds) after which the request will be canceled:</p>

407

<code>$this->xmlrpc->timeout(6);</code>

408

409

<h2>$this->xmlrpc->method()</h2>

410

<p>Sets the method that will be requested from the XML-RPC server:</p>

411

<code>$this->xmlrpc->method('<var>method</var>');</code>

412

413

<p>Where <var>method</var> is the name of the method.</p>

414

415

<h2>$this->xmlrpc->request()</h2>

416

<p>Takes an array of data and builds request to be sent to XML-RPC server:</p>

417

<code>$request = array(array('My Photoblog', 'string'), 'http://www.yoursite.com/photoblog/');<br />

418

$this->xmlrpc->request($request);</code>

419

420

<h2>$this->xmlrpc->send_request()</h2>

421

<p>The request sending function. Returns boolean TRUE or FALSE based on success for failure, enabling it to be used conditionally.</p>

422

423

<h2>$this->xmlrpc->set_debug(TRUE);</h2>

424

<p>Enables debugging, which will display a variety of information and error data helpful during development.</p>

425

426

427

<h2>$this->xmlrpc->display_error()</h2>

428

<p>Returns an error message as a string if your request failed for some reason.</p>

429

<code>echo $this->xmlrpc->display_error();</code>

430

431

<h2>$this->xmlrpc->display_response()</h2>

432

<p>Returns the response from the remote server once request is received. The response will typically be an associative array.</p>

433

<code>$this->xmlrpc->display_response();</code>

434

435

<h2>$this->xmlrpc->send_error_message()</h2>

436

<p>This function lets you send an error message from your server to the client. First parameter is the error number while the second parameter

437

is the error message.</p>

438

<code>return $this->xmlrpc->send_error_message('123', 'Requested data not available');</code>

439

440

<h2>$this->xmlrpc->send_response()</h2>

441

<p>Lets you send the response from your server to the client. An array of of valid data values must be sent with this method.</p>

442

<code>$response = array(<br />

443

                 array(<br />

444

                        'flerror' => array(FALSE, 'boolean'),<br />

445

                        'message' => "Thanks for the ping!")<br />

446

                     )<br />

447

                 'struct');<br />

448

return $this->xmlrpc->send_response($response);</code>

<h2>Data Types</h2>

<p>According to the <a href="http://www.xmlrpc.com/spec">XML-RPC spec</a> there are seven types

455

of values that you can send via XML-RPC:</p>

<ul>

<li><em>boolean</em></li>

460

<li><em>string</em></li>

461

<li><em>double</em></li>

462

<li><em>dateTime.iso8601</em></li>

463

464

<li><em>struct</em> (contains array of values)</li>

465

<li><em>array</em> (contains array of values)</li>

</ul>

</div>

<p>

Previous Topic:  <a href="validation.html">Validation Class</a>

476

   ·  

477

<a href="#top">Top of Page</a>   ·  

478

<a href="../index.html">User Guide Home</a>   ·  

479

Next Topic:  <a href="../helpers/array_helper.html">Array Helper</a>

<p>

</div>

</body>

</html>