nlopess Tue Sep 14 15:30:51 2004 EDT
Modified files:
/phpdoc/en/reference/datetime/functions date-sunrise.xml
date-sunset.xml
Log:
document date_sunset() and date_sunrise() + examples
http://cvs.php.net/diff.php/phpdoc/en/reference/datetime/functions/date-sunrise.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/datetime/functions/date-sunrise.xml
diff -u phpdoc/en/reference/datetime/functions/date-sunrise.xml:1.1
phpdoc/en/reference/datetime/functions/date-sunrise.xml:1.2
--- phpdoc/en/reference/datetime/functions/date-sunrise.xml:1.1 Sat Sep 4 08:25:25
2004
+++ phpdoc/en/reference/datetime/functions/date-sunrise.xml Tue Sep 14 15:30:50
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.date-sunrise">
<refnamediv>
<refname>date_sunrise</refname>
@@ -11,16 +11,84 @@
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>date_sunrise</methodname>
- <methodparam><type>mixed</type><parameter>time</parameter></methodparam>
+ <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 negavite 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
- &warn.undocumented.func;
+/* calculate the sunrise time for Lisbon, Portugal
+Latitude: 38.4 North
+Longitude: 9 West
+Zenith ~= 90
+offset: +1 GMT
+*/
+echo date_sunrise(time(), SUNFUNCS_RET_STRING, 38.4, -9, 90, 1);
+
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ See also <function>date_sunset</function>.
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/datetime/functions/date-sunset.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/datetime/functions/date-sunset.xml
diff -u phpdoc/en/reference/datetime/functions/date-sunset.xml:1.1
phpdoc/en/reference/datetime/functions/date-sunset.xml:1.2
--- phpdoc/en/reference/datetime/functions/date-sunset.xml:1.1 Sat Sep 4 08:25:25
2004
+++ phpdoc/en/reference/datetime/functions/date-sunset.xml Tue Sep 14 15:30:50
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.date-sunset">
<refnamediv>
<refname>date_sunset</refname>
@@ -11,16 +11,84 @@
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>date_sunset</methodname>
- <methodparam><type>mixed</type><parameter>time</parameter></methodparam>
+ <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_sunset</function> returns the sunset 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.sunset_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 negavite 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_sunset</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
- &warn.undocumented.func;
+/* calculate the sunset time for Lisbon, Portugal
+Latitude: 38.4 North
+Longitude: 9 West
+Zenith ~= 90
+offset: +1 GMT
+*/
+echo date_sunset(time(), SUNFUNCS_RET_STRING, 38.4, -9, 90, 1);
+
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ See also <function>date_sunrise</function>.
+ </para>
</refsect1>
</refentry>
