<?xml version="1.0" encoding="utf-8"?>

<reference xml:id="class.dateinterval" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

<title>Класс DateInterval</title>

<titleabbrev>DateInterval</titleabbrev>

<partintro>

<!-- {{{ DateInterval intro -->

<section xml:id="dateinterval.intro">

&reftitle.intro;

<para>

Представляет интервалы дат.

</para>

<para>

Интервал дат хранит либо определённое фиксированное время

(в годах, месяцах, днях, часах и т.д.) или относительную строку времени в формате, поддерживаемом

конструктором <classname>DateTimeImmutable</classname> и <classname>DateTime</classname>.

</para>

<para>

Более конкретно, информация в объекте класса

<classname>DateInterval</classname> является инструкцией для перехода от одной даты/времени к другой дате/времени. Этот процесс не всегда обратим.

</para>

<para>

Распространённым способом создания объекта <classname>DateInterval</classname>

является вычисление разницы между двумя объектами даты/времени с помощью

<methodname>DateTimeInterface::diff</methodname>.

</para>

<para>

Поскольку не существует чётко определённого способа сравнения интервалов дат,

экземпляры <classname>DateInterval</classname> являются

<link linkend="language.operators.comparison.incomparable">несравнимыми</link>.

</para>

</section>

<!-- }}} -->

<section xml:id="dateinterval.synopsis">

&reftitle.classsynopsis;

<classsynopsis class="class">

<ooclass>

<classname>DateInterval</classname>

</ooclass>

<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>

<fieldsynopsis>

<modifier>public</modifier>

<type>int</type>

<varname linkend="dateinterval.props.y">y</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>int</type>

<varname linkend="dateinterval.props.m">m</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>int</type>

<varname linkend="dateinterval.props.d">d</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>int</type>

<varname linkend="dateinterval.props.h">h</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>int</type>

<varname linkend="dateinterval.props.i">i</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>int</type>

<varname linkend="dateinterval.props.s">s</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>float</type>

<varname linkend="dateinterval.props.f">f</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>int</type>

<varname linkend="dateinterval.props.invert">invert</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>mixed</type>

<varname linkend="dateinterval.props.days">days</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>bool</type>

<varname linkend="dateinterval.props.from-string">from_string</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<type>string</type>

<varname linkend="dateinterval.props.date-string">date_string</varname>

</fieldsynopsis>

<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateinterval')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='DateInterval'])">

<xi:fallback/>

</xi:include>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateinterval')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DateInterval'])">

<xi:fallback/>

</xi:include>

</classsynopsis>

</section>

<section xml:id="dateinterval.props">

&reftitle.properties;

<warning>

<para>

Доступные свойства, перечисленные ниже, зависят от версии PHP

и должны рассматриваться как <emphasis>доступные только для чтения</emphasis>.

</para>

</warning>

<variablelist>

<varlistentry xml:id="dateinterval.props.y">

<term><varname>y</varname></term>

<listitem>

<para>

Количество лет.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.m">

<term><varname>m</varname></term>

<listitem>

<para>

Количество месяцев.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.d">

<term><varname>d</varname></term>

<listitem>

<para>

Количество дней.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.h">

<term><varname>h</varname></term>

<listitem>

<para>

Количество часов.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.i">

<term><varname>i</varname></term>

<listitem>

<para>

Количество минут.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.s">

<term><varname>s</varname></term>

<listitem>

<para>

Количество секунд.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.f">

<term><varname>f</varname></term>

<listitem>

<para>

Количество микросекунд в виде долей секунды.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.invert">

<term><varname>invert</varname></term>

<listitem>

<para>

Принимает <literal>1</literal>, если интервал представляет

отрицательный период времени и

<literal>0</literal> в противном случае. Смотрите

<methodname>DateInterval::format</methodname>.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.days">

<term><varname>days</varname></term>

<listitem>

<para>

Если объект DateInterval создан методом

<methodname>DateTimeImmutable::diff</methodname> или <methodname>DateTime::diff</methodname>,

то это общее количество полных дней между начальной и конечной датами

В противном случае <varname>days</varname> примет значение &false;.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.from-string">

<term><varname>from_string</varname></term>

<listitem>

<para>

Если объект DateInterval был создан методом <methodname>DateInterval::createFromDateString</methodname>,

то значение свойства будет &true; и свойство <varname>date_string</varname> будет заполнено.

В противном случае значение свойства будет &false;

и свойства от <varname>y</varname> до <varname>f</varname>, <varname>invert</varname> и <varname>days</varname> будут заполнены.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="dateinterval.props.date-string">

<term><varname>date_string</varname></term>

<listitem>

<para>

Строка, используемая в качестве аргумента метода <methodname>DateInterval::createFromDateString</methodname>.

</para>

</listitem>

</varlistentry>

</variablelist>

</section>

<section role="changelog" xml:id="dateinterval.changelog"><!-- {{{ -->

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.2.0</entry>

<entry>

Добавлены свойства <varname>from_string</varname> и <varname>date_string</varname> для экземпляров <classname>DateInterval</classname>,

которые были созданы с помощью метода <methodname>DateInterval::createFromDateString</methodname>.

</entry>

</row>

<row>

<entry>8.2.0</entry>

<entry>

Будут видны только значения от <literal>y</literal> до <literal>f</literal>,

<literal>invert</literal> и <literal>days</literal>.

</entry>

</row>

<row>

<entry>7.4.0</entry>

<entry>

Экземпляры <classname>DateInterval</classname> теперь несравнимы;

ранее все экземпляры <classname>DateInterval</classname> считались равными.

</entry>

</row>

<row>

<entry>7.1.0</entry>

<entry>Добавлено свойство <varname>f</varname>.</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</section><!-- }}} -->

</partintro>

&reference.datetime.entities.dateinterval;

</reference>