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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.date-sunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>date_sunset</refname>
<refpurpose>
Returns time of sunset for a given day and location
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<warning>
<para>
This function has been <emphasis>DEPRECATED</emphasis> as of PHP 8.1.0.
Relying on this function is highly discouraged. Use
<function>date_sun_info</function> instead.
</para>
</warning>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier role="attribute">#[\Deprecated]</modifier>
<type class="union"><type>string</type><type>int</type><type>float</type><type>false</type></type><methodname>date_sunset</methodname>
<methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>returnFormat</parameter><initializer><constant>SUNFUNCS_RET_STRING</constant></initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>latitude</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>longitude</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>zenith</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>utcOffset</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>date_sunset</function> returns the sunset time for a given
day (specified as a <parameter>timestamp</parameter>) and location.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>timestamp</parameter></term>
<listitem>
<para>
The <parameter>timestamp</parameter> of the day from which the sunset
time is taken.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>returnFormat</parameter></term>
<listitem>
<para>
<table>
<title><parameter>returnFormat</parameter> constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>constant</entry>
<entry>description</entry>
<entry>example</entry>
</row>
</thead>
<tbody>
<row>
<entry>SUNFUNCS_RET_STRING</entry>
<entry>returns the result as <type>string</type></entry>
<entry>16:46</entry>
</row>
<row>
<entry>SUNFUNCS_RET_DOUBLE</entry>
<entry>returns the result as <type>float</type></entry>
<entry>16.78243132</entry>
</row>
<row>
<entry>SUNFUNCS_RET_TIMESTAMP</entry>
<entry>returns the result as <type>int</type> (timestamp)</entry>
<entry>1095034606</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>latitude</parameter></term>
<listitem>
<para>
Defaults to North, pass in a negative value for South.
See also: <link linkend="ini.date.default-latitude">date.default_latitude</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>longitude</parameter></term>
<listitem>
<para>
Defaults to East, pass in a negative value for West.
See also: <link linkend="ini.date.default-longitude">date.default_longitude</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>zenith</parameter></term>
<listitem>
<para>
<parameter>zenith</parameter> is the angle between the center of the sun
and a line perpendicular to earth's surface. It defaults to
<link linkend="ini.date.sunset-zenith">date.sunset_zenith</link>
<table>
<title>Common <parameter>zenith</parameter> angles</title>
<tgroup cols="2">
<thead>
<row>
<entry>Angle</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>90°50'</entry>
<entry>Sunset: the point where the sun becomes invisible.</entry>
</row>
<row>
<entry>96°</entry>
<entry>Civil twilight: conventionally used to signify the end of dusk.</entry>
</row>
<row>
<entry>102°</entry>
<entry>Nautical twilight: the point at which the horizon ends being visible at sea.</entry>
</row>
<row>
<entry>108°</entry>
<entry>Astronomical twilight: the point at which the sun ends being the source of any illumination.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>utcOffset</parameter></term>
<listitem>
<para>
Specified in hours.
The <parameter>utcOffset</parameter> is ignored, if
<parameter>returnFormat</parameter> is
<constant>SUNFUNCS_RET_TIMESTAMP</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the sunset time in a specified <parameter>returnFormat</parameter> on
success&return.falseforfailure;. One potential reason for failure is that the
sun does not set at all, which happens inside the polar circles for part of
the year.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&date.timezone.errors.description;
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
This function has been deprecated in favor of <function>date_sun_info</function>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>latitude</parameter>, <parameter>longitude</parameter>,
<parameter>zenith</parameter> and <parameter>utcOffset</parameter> are nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>date_sunset</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* calculate the sunset time for Lisbon, Portugal
Latitude: 38.4 North
Longitude: 9 West
Zenith ~= 90
offset: +1 GMT
*/
echo date("D M d Y"). ', sunset time : ' .date_sunset(time(), SUNFUNCS_RET_STRING, 38.4, -9, 90, 1);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Mon Dec 20 2004, sunset time : 18:13
]]>
</screen>
</example>
<example>
<title>No sunset</title>
<programlisting role="php">
<![CDATA[
<?php
$solstice = strtotime('2017-12-21');
var_dump(date_sunset($solstice, SUNFUNCS_RET_STRING, 69.245833, -53.537222));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>date_sun_info</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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
-->
|
