mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
document date_sunset() and date_sunrise() + examples
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@168589 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes
parent
32d38f8ed2
commit
0cb21928bb
2 changed files with 142 additions and 6 deletions
|
|
@ -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>
|
||||
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue