archived-doc-ru/reference/datetime/dateperiod/createfromiso8601string.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="dateperiod.createfromiso8601string" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DatePeriod::createFromISO8601String</refname>
  <refpurpose>Создаёт новый объект DatePeriod из строки в формате стандарта ISO8601</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DatePeriod">
   <modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>DatePeriod::createFromISO8601String</methodname>
   <methodparam><type>string</type><parameter>specification</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Метод создаёт новый объект DatePeriod из строки в формате стандарта ISO8601,
   как указывает описание параметра <parameter>specification</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>specification</parameter></term>
    <listitem>
     <para>
      Подмножество <link xlink:href="&url.iso-8601.repeating_intervals;">спецификации повторяющихся интервалов
      стандарта ISO 8601</link>.
     </para>
     <para>
      Пример принимаемой спецификации интервала стандарта ISO 8601 — строка
      <literal>R5/2008-03-01T13:00:00Z/P1Y2M10DT2H30M</literal>, которая
      указывает:
     </para>
     <itemizedlist>
      <listitem>
       <simpara>
        5 повторений (<literal>R5/</literal>)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        Начинать с <literal>2008-03-01T13:00:00Z</literal>.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        Каждое повторение равно интервалу в 1 год 2 месяца 10 дней 2 часа и 30 минут
        (<literal>/P1Y2M10DT2H30M</literal>).
       </simpara>
      </listitem>
     </itemizedlist>

     <para>
      Примеры спецификации интервалов стандарта ISO 8601, которые PHP
      не поддерживает:
     </para>
     <orderedlist>
      <listitem>
       <simpara>
        ноль раз (<literal>R0/</literal>)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        смещения времени, отличные от UTC (<literal>Z</literal>), например, <literal>+02:00</literal>.
       </simpara>
      </listitem>
     </orderedlist>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      Битовое поле, которое можно указывать для управления отдельным поведением
      с начальными и конечными датами.
     </para>
     <para>
      Константа <constant>DatePeriod::EXCLUDE_START_DATE</constant>
      исключает дату начала из набора повторяющихся дат
      в пределах периода.
     </para>
     <para>
      Константа <constant>DatePeriod::INCLUDE_END_DATE</constant>
      включает дату окончания в наборе повторяющихся дат в пределах
      периода.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Метод возвращает созданный объект DatePeriod.
  </para>
  <para>
   С объектом <classname>DatePeriod</classname>, который создаётся методом,
   работают как с итератором для генерации объектов
   <classname>DateTimeImmutable</classname>.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Метод выбрасывает исключение <classname>DateMalformedPeriodStringException</classname>,
   если значение параметра <parameter>specification</parameter> невозможно разобрать как допустимое значение периода
   в формате стандарта ISO 8601.
  </para>
 </refsect1>

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

$iso = 'R4/2023-07-01T00:00:00Z/P7D';
$period = DatePeriod::createFromISO8601String($iso);

// При переборе объекта DatePeriod выведутся
// повторяющиеся в пределах периода даты.
foreach ($period as $date) {
    echo $date->format('Y-m-d'), "\n";
}
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
2023-07-01
2023-07-08
2023-07-15
2023-07-22
2023-07-29
]]>
    </screen>
   </example>
  </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
-->