<?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>La classe <classname>DateInterval</classname></title>

<titleabbrev>DateInterval</titleabbrev>

<partintro>

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

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

&reftitle.intro;

<para>

Représente un intervalle de dates.

</para>

<para>

Un intervalle stocke un nombre fixe de durées (en années, mois, jours, heures, etc.)

ou une chaîne relative à une durée dans un format compréhensible par

le constructeur de la classe <classname>DateTime</classname> et

<classname>DateTimeImmutable</classname>.

</para>

<para>

Plus précisément, l'information d'un objet de la classe

<classname>DateInterval</classname> est une instruction pour aller d'une

date/moment à une autre date/moment. Ce processus n'est pas toujours

réversible.

</para>

<para>

Une façon typique de créer un objet <classname>DateInterval</classname>

est en calculant la différence entre deux objets dates/moments à travers

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

</para>

<para>

Comme il n'y a pas une manière bien définie pour comparer les intervalles,

les instances de <classname>DateInterval</classname> sont

<link linkend="language.operators.comparison.incomparable">incomparables</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>

Les propriétés disponibles répertoriées ci-dessous dépendent de la version de PHP et doivent

être considérées en <emphasis>lecture seule</emphasis>.

</para>

</warning>

<variablelist>

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

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

<listitem>

<para>

Nombre d'années.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Nombre de mois.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Nombre de jours.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Nombre d'heures.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Nombre de minutes.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Nombre de secondes.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Nombre de microsecondes, en une fraction de seconde.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Vaut <literal>1</literal> si l'intervalle

représente une période de temps négative,

<literal>0</literal> sinon.

Voir la méthode <methodname>DateInterval::format</methodname>.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Si l'objet DateInterval a été créé avec la méthode

<methodname>DateTimeImmutable::diff</methodname> ou

<methodname>DateTime::diff</methodname>, alors ce sera le

nombre total de jours entre la date de début et la

date de fin. Sinon, <varname>days</varname> vaudra &false;.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Si l'objet DateInterval a été créé avec la méthode

<methodname>DateInterval::createFromDateString</methodname>, alors

cette propriété vaudra &true;, et la propriété

<varname>date_string</varname> sera renseignée. Sinon,

cette propriété vaudra &false;, et les propriétés de <varname>y</varname> à

<varname>f</varname>, <varname>invert</varname>, et

<varname>days</varname> seront renseignées.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

La chaîne de caractères utilisée comme argument pour

<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>

Les propriétés <varname>from_string</varname> et <varname>date_string</varname>

ont été ajoutées aux instances de <classname>DateInterval</classname>

qui ont été créées à l'aide de la méthode

<methodname>DateInterval::createFromDateString</methodname>.

</entry>

</row>

<row>

<entry>8.2.0</entry>

<entry>

Seules les propriétés de <literal>y</literal> jusqu'à <literal>f</literal>,

<literal>invert</literal>, et <literal>days</literal> seront visibles.

</entry>

</row>

<row>

<entry>7.4.0</entry>

<entry>

Les instances de <classname>DateInterval</classname> sont désormais incomparables ;

auparavant, toutes les instances <classname>DateInterval</classname> étaient considérées comme égales.

</entry>

</row>

<row>

<entry>7.1.0</entry>

<entry>La propriété <varname>f</varname> a été ajoutée.</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

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

</partintro>

&reference.datetime.entities.dateinterval;

</reference>