archived-doc-ru/reference/datetime/dateinterval/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="dateinterval.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DateInterval::__construct</refname>
  <refpurpose>Создаёт новый объект DateInterval</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="DateInterval">
   <modifier>public</modifier> <methodname>DateInterval::__construct</methodname>
   <methodparam><type>string</type><parameter>duration</parameter></methodparam>
  </constructorsynopsis>
  <para>
   Создаёт новый объект DateInterval.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>duration</parameter></term>
     <listitem>
      <para>
       Описание интервала.
      </para>
      <para>
       Формат описания интервала начинается с буквы <literal>P</literal> (от англ. period).
       Длительность периодов представляют целочисленным значением, за которым идёт
       обозначение периода. Перед частью описания с элементами времени указывают букву <literal>T</literal>.
      </para>
      <para>
       <table>
        <title>
         Обозначения периодов <parameter>duration</parameter>
        </title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Обозначение периода</entry>
           <entry>Описание</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>Y</literal></entry>
           <entry>Годы</entry>
          </row>
          <row>
           <entry><literal>M</literal></entry>
           <entry>Месяцы</entry>
          </row>
          <row>
           <entry><literal>D</literal></entry>
           <entry>Дни</entry>
          </row>
          <row>
           <entry><literal>W</literal></entry>
           <entry>
            Недели. Преобразовываются в дни.
            До PHP 8.0.0 нельзя было объединять с обозначением дней <literal>D</literal>.
           </entry>
          </row>
          <row>
           <entry><literal>H</literal></entry>
           <entry>Часы</entry>
          </row>
          <row>
           <entry><literal>M</literal></entry>
           <entry>Минуты</entry>
          </row>
          <row>
           <entry><literal>S</literal></entry>
           <entry>Секунды</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
      <para>
       Вот несколько простых примеров.
       Два дня — <literal>P2D</literal>.
       Две секунды — <literal>PT2S</literal>.
       Шесть лет и пять минут — <literal>P6YT5M</literal>.
      </para>
      <note>
       <para>
        Единицы измерения записывают от наибольшей
        величины слева к наименьшей величине справа. То есть
        годы идут перед месяцами, месяцы перед днями, дни перед минутами и т. д.
        Поэтому один год и четыре дня
        представляют как <literal>P1Y4D</literal>, но не <literal>P4D1Y</literal>.
       </para>
      </note>
      <para>
       Описание можно записать и в виде даты и времени.
       Пример одного года и четырёх дней можно описать как
       <literal>P0001-00-04T00:00:00</literal>.
       Но значения в этом формате не должны выходить за рамки
       допустимых значений даты и времени (например, <literal>25</literal> часов недопустимо).
      </para>
      <para>
       Эти форматы основаны на <link xlink:href="&url.iso-8601.duration;">стандарте ISO 8601</link>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Метод выбросит исключение <classname>DateMalformedIntervalStringException</classname>,
   если не разберёт значение параметра <parameter>duration</parameter> как интервал.
   До PHP 8.3 метод выбрасывал исключение <exceptionname>Exception</exceptionname>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.3.0</entry>
      <entry>
       Теперь вместо исключения <exceptionname>Exception</exceptionname>
       выбрасывается исключение
       <exceptionname>DateMalformedIntervalStringException</exceptionname>.
      </entry>
     </row>
     <row>
      <entry>8.2.0</entry>
      <entry>
       Из свойств объекта интервала будут видны только <literal>y</literal> в <literal>f</literal>,
       <literal>invert</literal> и <literal>days</literal>,
       включая новое логическое свойство <literal>from_string</literal>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Обозначение недель <literal>W</literal> теперь разрешено
       комбинировать с обозначением дней <literal>D</literal>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример создания и использования объектов <classname>DateInterval</classname></title>
    <programlisting role="php">
<![CDATA[
<?php

// Создаём конкретную дату
$someDate = \DateTime::createFromFormat("Y-m-d H:i", "2022-08-25 14:18");

// Создаём интервал
$interval = new \DateInterval("P7D");

// Добавляем интервал
$someDate->add($interval);

// Преобразовываем интервал в строку
echo $interval->format("%d");
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
7
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Пример использования объекта <classname>DateInterval</classname></title>
    <programlisting role="php">
<![CDATA[
<?php

$interval = new DateInterval('P1W2D');
var_dump($interval);
]]>
    </programlisting>
    &example.outputs.82;
    <screen role="php">
<![CDATA[
object(DateInterval)#1 (10) {
  ["y"]=>
  int(0)
  ["m"]=>
  int(0)
  ["d"]=>
  int(9)
  ["h"]=>
  int(0)
  ["i"]=>
  int(0)
  ["s"]=>
  int(0)
  ["f"]=>
  float(0)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
  ["from_string"]=>
  bool(false)
}
]]>
    </screen>
    &example.outputs.8;
    <screen role="php">
<![CDATA[
object(DateInterval)#1 (16) {
  ["y"]=>
  int(0)
  ["m"]=>
  int(0)
  ["d"]=>
  int(9)
  ["h"]=>
  int(0)
  ["i"]=>
  int(0)
  ["s"]=>
  int(0)
  ["f"]=>
  float(0)
  ["weekday"]=>
  int(0)
  ["weekday_behavior"]=>
  int(0)
  ["first_last_day_of"]=>
  int(0)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
  ["special_type"]=>
  int(0)
  ["special_amount"]=>
  int(0)
  ["have_weekday_relative"]=>
  int(0)
  ["have_special_relative"]=>
  int(0)
}
]]>
    </screen>
    &example.outputs.7;
    <screen role="php">
<![CDATA[
object(DateInterval)#1 (16) {
  ["y"]=>
  int(0)
  ["m"]=>
  int(0)
  ["d"]=>
  int(2)
  ["h"]=>
  int(0)
  ["i"]=>
  int(0)
  ["s"]=>
  int(0)
  ["f"]=>
  float(0)
  ["weekday"]=>
  int(0)
  ["weekday_behavior"]=>
  int(0)
  ["first_last_day_of"]=>
  int(0)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
  ["special_type"]=>
  int(0)
  ["special_amount"]=>
  int(0)
  ["have_weekday_relative"]=>
  int(0)
  ["have_special_relative"]=>
  int(0)
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>DateInterval::format</function></member>
    <member><function>DateTime::add</function></member>
    <member><function>DateTime::sub</function></member>
    <member><function>DateTime::diff</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
-->