1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
|
<HTML
><HEAD
><TITLE
>Class documentation</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.77+"><LINK
REV="MADE"
HREF="edd@usefulinc.com"><LINK
REL="HOME"
TITLE="XML-RPC for PHP"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="The Jellyfish Book"
HREF="jellyfish.html"><LINK
REL="NEXT"
TITLE="xmlrpcmsg"
HREF="xmlrpcmsg.html"></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>XML-RPC for PHP: version 1.1</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="jellyfish.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="xmlrpcmsg.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="APIDOCS"
></A
>Chapter 5. Class documentation</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="apidocs.html#XMLRPC-CLIENT"
>xmlrpc_client</A
></DT
><DT
><A
HREF="xmlrpcmsg.html"
>xmlrpcmsg</A
></DT
><DT
><A
HREF="xmlrpcresp.html"
>xmlrpcresp</A
></DT
><DT
><A
HREF="xmlrpcval.html"
>xmlrpcval</A
></DT
><DT
><A
HREF="xmlrpc-server.html"
>xmlrpc_server</A
></DT
></DL
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="XMLRPC-CLIENT"
></A
>xmlrpc_client</H1
><P
>This is the basic class used to represent a client of an
XML-RPC server.</P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN174"
></A
>Creation</H2
><P
>The constructor has the following syntax:</P
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN177"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$client=new xmlrpc_client</CODE
>($server_path, $server_hostname, $server_port);</CODE
></P
><P
></P
></DIV
><P
>Here's an example client set up to query Userland's XML-RPC
server at <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>betty.userland.com</I
></SPAN
>:</P
><PRE
CLASS="PROGRAMLISTING"
>$client=new xmlrpc_client("/RPC2", "betty.userland.com", 80);</PRE
><P
>The <TT
CLASS="PARAMETER"
><I
>server_port</I
></TT
> parameter is
optional, and if omitted will default to 80 when using
HTTP and 443 when using HTTPS (see the "send" method below.)</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN191"
></A
>Methods</H2
><P
>This class supports the following methods.</P
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="XMLRPC-CLIENT-SEND"
></A
>send</H3
><P
>This method takes the form:</P
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN197"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$response=$client->send</CODE
>($xmlrpc_message, $timeout, $server_method);</CODE
></P
><P
></P
></DIV
><P
>Where <TT
CLASS="PARAMETER"
><I
>$xmlrpc_message</I
></TT
> is an
instance of <TT
CLASS="CLASSNAME"
>xmlrpcmsg</TT
> (see <A
HREF="xmlrpcmsg.html"
>xmlrpcmsg</A
>), and
<TT
CLASS="PARAMETER"
><I
>$response</I
></TT
> is an
instance of <TT
CLASS="CLASSNAME"
>xmlrpcresp</TT
> (see <A
HREF="xmlrpcresp.html"
>xmlrpcresp</A
>).</P
><P
>The <TT
CLASS="PARAMETER"
><I
>$timeout</I
></TT
> is optional, and
will be set to <TT
CLASS="LITERAL"
>0</TT
> (wait forever) if
omitted. This timeout value is passed to
<TT
CLASS="FUNCTION"
>fsockopen()</TT
>.</P
><P
>The <TT
CLASS="PARAMETER"
><I
>server_method</I
></TT
> parameter is
optional, and if omitted will default to 'http'. The only
other valid value is 'https', which will use an SSL HTTP
connection to connect to the remote server. Note that your
PHP must have the "curl" extensions compiled in in order to
use this feature. Note that when using SSL you should
normally set your port number to 443, unless the SSL server
you are contacting runs at any other port.</P
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
>PHP 4.0.2 or greater is required for SSL
functionality.
PHP 4.0.6 has a bug which prevents SSL
working.</P
></TD
></TR
></TABLE
></DIV
><P
>If the value of <TT
CLASS="PARAMETER"
><I
>$response</I
></TT
> is
<TT
CLASS="LITERAL"
>0</TT
> rather than an
<TT
CLASS="CLASSNAME"
>xmlrpcresp</TT
> object, then this
signifies an I/O error has occured. You can find out what
the I/O error was from the values
<TT
CLASS="FUNCTION"
>$client->errno</TT
> and
<TT
CLASS="FUNCTION"
>$client->errstring</TT
>.
</P
><P
>In addition to low-level errors, the XML-RPC server you
were querying may return an error in the
<TT
CLASS="CLASSNAME"
>xmlrpcresp</TT
> object. See <A
HREF="xmlrpcresp.html"
>xmlrpcresp</A
> for details of
how to handle these errors.
</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN230"
></A
>setCredentials</H3
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN232"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$client->setCredentials</CODE
>($username, $password);</CODE
></P
><P
></P
></DIV
><P
>This method sets the username and password for authorizing the
client to a server. With the default (HTTP) transport, this
information is used for HTTP Basic authorization.
</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN240"
></A
>setCertificate</H3
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN242"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$client->setCertificate</CODE
>($certificate, $passphrase);</CODE
></P
><P
></P
></DIV
><P
>This method sets the optional certificate and passphrase
used in SSL-enabled communication with a remote server
(when the <TT
CLASS="PARAMETER"
><I
>server_method</I
></TT
> is set to
'https' in the client's construction).
</P
><P
>The <TT
CLASS="PARAMETER"
><I
>certificate</I
></TT
> parameter must
be the filename of a PEM formatted certificate. The
<TT
CLASS="PARAMETER"
><I
>passphrase</I
></TT
> parameter must contain
the password required to use the certificate.</P
><P
>This requires the "curl" extensions to be compiled
into your installation of PHP.</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN255"
></A
>setSSLVerifyPeer</H3
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN257"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$client->setSSLVerifyPeer</CODE
>($i);</CODE
></P
><P
></P
></DIV
><P
>This method defines whether connections made to XMLRPC
backends via HTTPS should verify the remote host's SSL
certificate, and cause the connection to fail if the cert
verification fails. $i should be a boolean value.
</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN263"
></A
>setSSLVerifyHost</H3
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN265"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$client->setSSLVerifyHost</CODE
>($i);</CODE
></P
><P
></P
></DIV
><P
>This method defines whether connections made to XMLRPC
backends via HTTPS should verify the remote host's SSL
certificate's common name (CN). By default, only the existence
of a CN is checked. $i should be an integer value; 0 to not
check the CN at all, 1 to merely check for its existence, and
2 to check that the CN on the certificate matches the hostname
that is being connected to.
</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN271"
></A
>setDebug</H3
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN273"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$client->setDebug</CODE
>($debugOn);</CODE
></P
><P
></P
></DIV
><P
><TT
CLASS="PARAMETER"
><I
>$debugOn</I
></TT
> is either
<TT
CLASS="LITERAL"
>0</TT
> or <TT
CLASS="LITERAL"
>1</TT
> depending on
whether you require the client to print debugging
information to the browser. The default is not to output
this information.</P
><P
> The debugging information includes the raw data returned
from the XML-RPC server it was querying, and the PHP value
the client attempts to create to represent the value
returned by the server. This option can be very useful when
debugging servers as it allows you to see exactly what the
server returns.
</P
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="jellyfish.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="xmlrpcmsg.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>The Jellyfish Book</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>xmlrpcmsg</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|
