php-doc-ru/reference/datetime/functions/date-sunset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 9b1673cf114a1e10c4563ab9223cb56aed552b89 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<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>
   Возвращает время захода солнца для заданных дня и расположения
  </refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   <para>
    Начиная с PHP 8.1.0 функция <emphasis>УСТАРЕЛА</emphasis>.
    Разработчики языка настоятельно не рекомендуют полагаться на функцию.
    Вместо неё лучше пользоваться функцией <function>date_sun_info</function>.
   </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> возвращает время захода солнца
   для дня, который указали в аргументе <parameter>timestamp</parameter>,
   и расположения.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>timestamp</parameter>
     </term>
     <listitem>
      <para>
       Параметр <parameter>timestamp</parameter> принимает метку времени дня,
       для которого берётся время захода солнца.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>returnFormat</parameter>
     </term>
     <listitem>
      <para>
       <table>
        <title>&Constants;, которые принимает параметр <parameter>returnFormat</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Константа</entry>
           <entry>Описание</entry>
           <entry>Пример</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>SUNFUNCS_RET_STRING</entry>
           <entry>
            Возвращает результат в виде значения с типом <type>string</type>
           </entry>
           <entry>16:46</entry>
          </row>
          <row>
           <entry>SUNFUNCS_RET_DOUBLE</entry>
           <entry>
            Возвращает результат в виде значения с типом <type>float</type>
           </entry>
           <entry>16.78243132</entry>
          </row>
          <row>
           <entry>SUNFUNCS_RET_TIMESTAMP</entry>
           <entry>
            Возвращает метку времени в виде значения с типом <type>int</type>
           </entry>
           <entry>1095034606</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>latitude</parameter>
     </term>
     <listitem>
      <para>
       Значение по умолчанию — Северное полушарие, для Южного передаётся
       отрицательное значение. Смотрите также описание директивы
       <link linkend="ini.date.default-latitude">date.default_latitude</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>longitude</parameter>
     </term>
     <listitem>
      <para>
       Значение по умолчанию — восточная долгота, для западной передаётся
       отрицательное значение. Смотрите также описание директивы
       <link linkend="ini.date.default-longitude">date.default_longitude</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>zenith</parameter>
     </term>
     <listitem>
      <para>
       Параметр <parameter>zenith</parameter> устанавливает угол между центром Солнца и линией,
       перпендикулярной поверхности Земли. По умолчанию параметр берёт значение директивы
       <link linkend="ini.date.sunrise-zenith">date.sunrise_zenith</link>.
       <table>
        <title>Распространённые углы зенита <parameter>zenith</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Угол</entry>
           <entry>Описание</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>90°50'</entry>
           <entry>Восход солнца: точка, в которой солнце становится невидимым.</entry>
          </row>
          <row>
           <entry>96°</entry>
           <entry>Гражданские сумерки: традиционно обозначает окончание заката.</entry>
          </row>
          <row>
           <entry>102°</entry>
           <entry>Навигационные сумерки: точка, в которой горизонт становится невидимым с моря.</entry>
          </row>
          <row>
           <entry>108°</entry>
           <entry>Астрономические сумерки: момент, в которой солнце перестаёт быть источником освещения.</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>utcOffset</parameter>
     </term>
     <listitem>
      <para>
       Задаётся в часах.
       Функция игнорирует параметр <parameter>utcOffset</parameter>,
       если значение параметра <parameter>returnFormat</parameter>
       равно значению константы <constant>SUNFUNCS_RET_TIMESTAMP</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает время захода солнца в формате, который определили в параметре
   <parameter>returnFormat</parameter>, если завершилась успешно,&return.falseforfailure;.
   Функция завершится неудачно, если солнце вообще не заходит,
   что бывает внутри полярных кругов в течение части года.
  </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>
        Функция устарела, пользуйтесь вместе неё функцию <function>date_sun_info</function>.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Параметры <parameter>latitude</parameter>, <parameter>longitude</parameter>,
        <parameter>zenith</parameter> и <parameter>utcOffset</parameter> теперь принимают значение &null;.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

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

/* Расчёт времени захода солнца в Лиссабоне, Португалия
Latitude: 38.4 North
Longitude: 9 West
Zenith ~= 90
offset: +1 GMT
*/

echo date("D M d Y"). ', время захода солнца : ' .date_sunset(time(), SUNFUNCS_RET_STRING, 38.4, -9, 90, 1);

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Mon Dec 20 2004, время захода солнца : 18:13
]]>
    </screen>
   </example>
   <example>
    <title>Пример работы функции для времени и расположения, при которых солнце не заходит</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
-->