File: constants.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (274 lines) | stat: -rw-r--r-- 7,016 bytes parent folder | download
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="datetime.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 <para>
  The <constant>DATE_<replaceable>*</replaceable></constant>
  constants are defined and offer standard
  date representations, which can be used along with the date format functions
  (like <function>date</function>).
 </para>

 <variablelist>
  <title>
   Available <parameter>returnFormat</parameter> for
   <function>date_sunrise</function> and
   <function>date_sunset</function>
  </title>

  <warning>
   <simpara>
    These constants are deprecated as of PHP 8.4.0.
    The corresponding <function>date_sunrise</function> and
    <function>date_sunset</function> functions are deprecated as of PHP 8.1.0.
   </simpara>
  </warning>

  <varlistentry xml:id="constant.sunfuncs-ret-timestamp">
   <term>
    <constant>SUNFUNCS_RET_TIMESTAMP</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Timestamp
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sunfuncs-ret-string">
   <term>
    <constant>SUNFUNCS_RET_STRING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Hours:minutes (example: <literal>08:02</literal>)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sunfuncs-ret-double">
   <term>
    <constant>SUNFUNCS_RET_DOUBLE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Hours as floating point number (example <literal>8.75</literal>)
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title><constant>DATE_<replaceable>*</replaceable></constant> constants</title>
  <varlistentry xml:id="constant.date-atom">
   <term>
    <constant>DATE_ATOM</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Atom (example: <literal>2005-08-15T15:52:01+00:00</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-cookie">
   <term>
    <constant>DATE_COOKIE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     HTTP Cookies (example: <literal>Monday, 15-Aug-2005 15:52:01 UTC</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-iso8601">
   <term>
    <constant>DATE_ISO8601</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     ISO-8601 (example: <literal>2005-08-15T15:52:01+0000</literal>)
    </simpara>
    <note>
     <simpara>
      This format is not compatible with ISO-8601, but is left this way for
      backward compatibility reasons. Use
      <constant>DATE_ISO8601_EXPANDED</constant>,
      <constant>DATE_ATOM</constant> for compatibility with ISO-8601
      instead (ref ISO8601:2004 section 4.3.3 clause d).
     </simpara>
    </note>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-iso8601-expanded">
   <term>
    <constant>DATE_ISO8601_EXPANDED</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     ISO-8601 Expanded (example: <literal>+10191-07-26T08:59:52+01:00</literal>)
    </simpara>
    <note>
     <simpara>
      This format allows for year ranges outside of ISO-8601's normal range
      of <literal>0000</literal>-<literal>9999</literal> by always
      including a sign character. It also addresses that that timezone part
      (<literal>+01:00</literal>) is compatible with ISO-8601.
     </simpara>
    </note>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc822">
   <term>
    <constant>DATE_RFC822</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 822 (example: <literal>Mon, 15 Aug 05 15:52:01 +0000</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc850">
   <term>
    <constant>DATE_RFC850</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 850 (example: <literal>Monday, 15-Aug-05 15:52:01 UTC</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc1036">
   <term>
    <constant>DATE_RFC1036</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 1036 (example: <literal>Mon, 15 Aug 05 15:52:01 +0000</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc1123">
   <term>
    <constant>DATE_RFC1123</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 1123 (example: <literal>Mon, 15 Aug 2005 15:52:01 +0000</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc7231">
   <term>
    <constant>DATE_RFC7231</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 7231 (as of PHP 7.0.19 and 7.1.5)
     (example: <literal>Sat, 30 Apr 2016 17:52:13 GMT</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc2822">
   <term>
    <constant>DATE_RFC2822</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 2822 (example: <literal>Mon, 15 Aug 2005 15:52:01 +0000</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc3339">
   <term>
    <constant>DATE_RFC3339</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Same as <constant>DATE_ATOM</constant>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc3339-extended">
   <term>
    <constant>DATE_RFC3339_EXTENDED</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 3339 EXTENDED format
     (example: <literal>2005-08-15T15:52:01.000+00:00</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rss">
   <term>
    <constant>DATE_RSS</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RSS (example: <literal>Mon, 15 Aug 2005 15:52:01 +0000</literal>).
     &Alias; <constant>DATE_RFC1123</constant>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-w3c">
   <term>
    <constant>DATE_W3C</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     World Wide Web Consortium (example: <literal>2005-08-15T15:52:01+00:00</literal>).
     &Alias; <constant>DATE_RFC3339</constant>.
    </simpara>
   </listitem>
  </varlistentry>

 </variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->