summaryrefslogtreecommitdiffstats
path: root/modules/xmlrpc/doc/helpers.html
blob: 4f0c13194a1fdd801f480793698bfbe1662d8e9a (plain)
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
<HTML
><HEAD
><TITLE
>Helper functions</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="xmlrpc_server"
HREF="xmlrpc-server.html"><LINK
REL="NEXT"
TITLE="Easy use with PHP arrays"
HREF="arrayuse.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="xmlrpc-server.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="arrayuse.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="HELPERS"
></A
>Chapter 6. Helper functions</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="helpers.html#AEN739"
>Date functions</A
></DT
><DT
><A
HREF="arrayuse.html"
>Easy use with PHP arrays</A
></DT
><DT
><A
HREF="debugging.html"
>Debugging aids</A
></DT
></DL
></DIV
><P
>XML-RPC for PHP contains some helper functions which you can
			use to make processing of XML-RPC requests easier.</P
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN739"
></A
>Date functions</H1
><P
>The XML-RPC specification has this to say on dates:</P
><A
NAME="AEN742"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>Don't assume a timezone. It should be specified by the server in its
                 documentation what assumptions it makes about timezones. </P
></BLOCKQUOTE
><P
>Unfortunately, this means that date processing isn't
				straightforward. Although XML-RPC uses ISO 8601 format dates, it
				doesn't use the timezone specifier.</P
><P
>We strongly recommend that in every case where you pass
				dates in XML-RPC calls, you use UTC (GMT) as your timezone. Most computer
				languages include routines for handling GMT times natively, and
				you won't have to translate between timezones.</P
><P
>For more information about dates, see <A
HREF="http://www.uic.edu/year2000/datefmt.html"
TARGET="_top"
>ISO 8601: The Right Format for Dates</A
>, which has a handy link to a PDF of the ISO 8601 specification. Note that XML-RPC uses exactly one of the available representations: CCYYMMDDTHH:MM:SS.</P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="ISO8601ENCODE"
></A
>iso8601_encode</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN750"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$isoString=iso8601_encode</CODE
>($time_t, $utc=0);</CODE
></P
><P
></P
></DIV
><P
>Returns an ISO 8601 formatted date generated from the
					UNIX timestamp <TT
CLASS="PARAMETER"
><I
>$time_t</I
></TT
>, as returned by
					the PHP function <TT
CLASS="FUNCTION"
>time()</TT
>. </P
><P
>The argument <TT
CLASS="PARAMETER"
><I
>$utc</I
></TT
> can be omitted,
					in which case it defaults to <TT
CLASS="LITERAL"
>0</TT
>. If it is
					set to <TT
CLASS="LITERAL"
>1</TT
>, then the function corrects the
					time passed in for UTC. Example: if you're in the GMT-6:00
					timezone and set <TT
CLASS="PARAMETER"
><I
>$utc</I
></TT
>, you will receive
					a date representation six hours ahead of your local
					time.</P
><P
>The included demo program <TT
CLASS="FILENAME"
>vardemo.php</TT
>
					includes a demonstration of this function.</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="ISO8601DECODE"
></A
>iso8601_decode</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN768"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>$time_t=iso8601_decode</CODE
>($isoString, $utc=0);</CODE
></P
><P
></P
></DIV
><P
>Returns a UNIX timestamp from an ISO 8601 encoded time and
					date string passed in. If <TT
CLASS="PARAMETER"
><I
>$utc</I
></TT
> is
					<TT
CLASS="LITERAL"
>1</TT
> then <TT
CLASS="PARAMETER"
><I
>$isoString</I
></TT
> is
					assumed to be in the UTC timezone, and thus the
					<TT
CLASS="PARAMETER"
><I
>$time_t</I
></TT
> result is also UTC: otherwise,
					the timezone is assumed to be your local timezone and you receive a local timestamp.</P
></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="xmlrpc-server.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="arrayuse.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>xmlrpc_server</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Easy use with PHP arrays</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>