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
|
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.date-sunrise">
<refnamediv>
<refname>date_sunrise</refname>
<refpurpose>
Returns time of sunrise for a given day and location
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>date_sunrise</methodname>
<methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>format</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>latitude</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>longitude</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>zenith</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>gmt_offset</parameter></methodparam>
</methodsynopsis>
<para>
<function>date_sunrise</function> returns the sunrise time for a given
day (specified as a <parameter>timestamp</parameter>) and location. The
<parameter>latitude</parameter>, <parameter>longitude</parameter> and
<parameter>zenith</parameter> parameters default to the
<literal>date.default_latitude</literal>,
<literal>date.default_longitude</literal> and
<literal>date.sunrise_zenith</literal> configuration options,
respectively.
</para>
<para>
The <parameter>latitude</parameter> defaults to North. So, if you want to
specify a South value, you must pass a negative value. The same note
applies to <parameter>longitude</parameter>, which defaults to East.
</para>
<para>
The <parameter>gmt_offset</parameter> parameter is specified in hours.
</para>
<table>
<title><parameter>format</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 sunset time 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 sunset time as an <type>integer</type> (timestamp)</entry>
<entry>1095034606</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
<example>
<title><function>date_sunrise</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* calculate the sunrise time for Lisbon, Portugal
Latitude: 38.4 North
Longitude: 9 West
Zenith ~= 90
offset: +1 GMT
*/
echo date("D M d Y"). ', sunrise time : ' .date_sunrise(time(), SUNFUNCS_RET_STRING, 38.4, -9, 90, 1);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Mon Dec 20 2004, sunrise time : 08:54
]]>
</screen>
</example>
</para>
<para>
See also <function>date_sunset</function>.
</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:"../../../../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
-->
|
