archived-doc-ru/reference/datetime/functions/date-sun-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 03b6583a4ade7a2b68b57fe958d2d9022b15a873 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.date-sun-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>date_sun_info</refname>
  <refpurpose>
   Возвращает массив с информацией о закате или рассвете и начале или окончании сумерек
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>date_sun_info</methodname>
   <methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
   <methodparam><type>float</type><parameter>latitude</parameter></methodparam>
   <methodparam><type>float</type><parameter>longitude</parameter></methodparam>
  </methodsynopsis>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>timestamp</parameter></term>
     <listitem>
      <para>
       Unix-метка времени.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>latitude</parameter></term>
     <listitem>
      <para>
       Широта в градусах.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>longitude</parameter></term>
     <listitem>
      <para>
       Долгота в градусах.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает массив, чью структуру подробно описывает следующий список:
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><literal>sunrise</literal></term>
     <listitem>
      <simpara>
       Временная метка восхода солнца (зенитный угол = 90°35').
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>sunset</literal></term>
     <listitem>
      <simpara>
       Временная метка заката солнца (зенитный угол = 90°35').
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>transit</literal></term>
     <listitem>
      <simpara>
       Временная метка, когда солнце находится в своём зените, то есть достигло самой верхней точки.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>civil_twilight_begin</literal></term>
     <listitem>
      <simpara>
       Начало гражданского рассвета (зенитный угол = 96°). Оно заканчивается на <literal>sunrise</literal>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>civil_twilight_end</literal></term>
     <listitem>
      <simpara>
       Конец гражданского заката (зенитный угол = 96°). Оно начинается на <literal>sunset</literal>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>nautical_twilight_begin</literal></term>
     <listitem>
      <simpara>
       Начало навигационного рассвета (зенитный угол = 102°). Оно заканчивается
       <literal>civil_twilight_begin</literal>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>nautical_twilight_end</literal></term>
     <listitem>
      <simpara>
       Конец навигационного заката (зенитный угол = 102°). Оно начинается на
       <literal>civil_twilight_end</literal>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>astronomical_twilight_begin</literal></term>
     <listitem>
      <simpara>
       Начало астрономического рассвета (зенитный угол = 108°). Оно заканчивается на
       <literal>nautical_twilight_begin</literal>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>astronomical_twilight_end</literal></term>
     <listitem>
      <simpara>
       Конец астрономического заката (зенитный угол = 108°). Оно начинается на
       <literal>nautical_twilight_end</literal>.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>
   Значения элементов массива — UNIX-метка времени, &false;, если солнце находится
   ниже соответствующего зенита в течение всего дня, или &true;, если солнце находится выше соответствующего зенита в течение всего дня.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Расчёт был исправлен с учётом местной полуночи вместо местного полудня,
        что несколько изменяет результаты.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>date_sun_info</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$sun_info = date_sun_info(strtotime("2006-12-12"), 31.7667, 35.2333);

foreach ($sun_info as $key => $val) {
    echo "$key: " . date("H:i:s", $val) . "\n";
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
sunrise: 05:52:11
sunset: 15:41:21
transit: 10:46:46
civil_twilight_begin: 05:24:08
civil_twilight_end: 16:09:24
nautical_twilight_begin: 04:52:25
nautical_twilight_end: 16:41:06
astronomical_twilight_begin: 04:21:32
astronomical_twilight_end: 17:12:00
]]>
    </screen>
   </example>

   <example>
    <title>Полярная ночь с некоторой обработкой</title>
    <programlisting role="php">
<![CDATA[
<?php

$tz = new \DateTimeZone('America/Anchorage');
$si = date_sun_info(strtotime("2022-12-21"), 70.21, -148.51);

foreach ($si as $key => $value) {
    echo
        match ($value) {
            true => 'always',
            false => 'never',
            default => date_create("@{$value}")->setTimeZone($tz)->format( 'H:i:s T' ),
        },
        ": {$key}",
        "\n";
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
never: sunrise
never: sunset
12:52:18 AKST: transit
10:53:19 AKST: civil_twilight_begin
14:51:17 AKST: civil_twilight_end
09:01:47 AKST: nautical_twilight_begin
16:42:48 AKST: nautical_twilight_end
07:40:47 AKST: astronomical_twilight_begin
18:03:49 AKST: astronomical_twilight_end
]]>
    </screen>
   </example>
   <example>
    <title>Полуночное солнце (Тромсё, Норвегия)</title>
    <programlisting role="php">
<![CDATA[
<?php

$si = date_sun_info(strtotime("2022-06-26"), 69.68, 18.94);
print_r($si);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [sunrise] => 1
    [sunset] => 1
    [transit] => 1656240426
    [civil_twilight_begin] => 1
    [civil_twilight_end] => 1
    [nautical_twilight_begin] => 1
    [nautical_twilight_end] => 1
    [astronomical_twilight_begin] => 1
    [astronomical_twilight_end] => 1
)
]]>
    </screen>
   </example>
  </para>

  <para>
   <example>
    <title>Вычисление продолжительности дня (Киев)</title>
    <programlisting role="php">
<![CDATA[
<?php

$si = date_sun_info(strtotime('2022-08-26'), 50.45, 30.52);
$diff = $si['sunset'] - $si['sunrise'];

echo "Продолжительность дня: ",
    floor($diff / 3600), " ч. ",
    floor(($diff % 3600) / 60), " сек.\n"
;

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Продолжительность дня: 13 ч. 56 сек.
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>date_sunrise</function></member>
    <member><function>date_sunset</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
-->