<?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>Die Klasse DateInterval</title>

<titleabbrev>DateInterval</titleabbrev>

<partintro>

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

&reftitle.intro;

<para>

Repräsentiert eine Zeitspanne.

</para>

<para>

Eine Zeitspanne wird entweder als feste Zeitspanne (in Jahren, Monaten,

Tagen, Stunden etc.) oder als relative Zeitangabe in einem Format

dargestellt, das vom Konstruktor der Klassen

<classname>DateTimeImmutable</classname> und

<classname>DateTime</classname> unterstützt wird.

</para>

<para>

Genauer gesagt ist die Information in einem Objekt der Klasse

<classname>DateInterval</classname> eine Anweisung, um von einem

Datum/Zeit-Wert zu einem anderen Datum/Zeit-Wert zu kommen.

Dieser Prozess ist nicht immer umkehrbar.

</para>

<para>

Eine übliche Methode, um ein <classname>DateInterval</classname>-Objekt zu

erzeugen, ist die Berechnung des Unterschieds zwischen zwei

Datum/Zeit-Objekten durch <methodname>DateTimeInterface::diff</methodname>.

</para>

<para>

Da es keine eindeutig definierte Möglichkeit gibt, Zeitspannen zu

vergleichen, sind <classname>DateInterval</classname>-Instanzen

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

Die unten aufgeführten verfügbaren Eigenschaften hängen von der

PHP-Version ab und sollten als <emphasis>nur lesbar</emphasis> eingestuft

werden.

</para>

</warning>

<variablelist>

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

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

<listitem>

<para>

Anzahl der Jahre.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Anzahl der Monate.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Anzahl der Tage.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Anzahl der Stunden.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Anzahl der Minuten.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Anzahl der Sekunden.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Anzahl der Mikrosekunden als Bruchteil einer Sekunde.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Ist <literal>1</literal>, wenn die Zeitspanne negativ ist, und sonst

<literal>0</literal>.

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

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Wenn das DateInterval-Objekt durch

<methodname>DateTimeImmutable::diff</methodname> oder

<methodname>DateTime::diff</methodname> erstellt wurde, dann enthält

diese Eigenschaft die Gesamtanzahl der vollen Tage zwischen dem Start- und

Enddatum. Ansonsten enthält <varname>days</varname> den Wert &false;.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Wenn das DateInterval-Objekt durch

<methodname>DateInterval::createFromDateString</methodname> erstellt

wurde, dann ist der Wert dieser Eigenschaft &true; und die Eigenschaft

<varname>date_string</varname> wird mit Daten belegt. Andernfalls ist

der Wert &false; und die Eigenschaften <varname>y</varname> bis

<varname>f</varname>, <varname>invert</varname>, und

<varname>Tage</varname> werden mit Daten belegt.

</para>

</listitem>

</varlistentry>

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

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

<listitem>

<para>

Die Zeichenkette, die als Parameter für

<methodname>DateInterval::createFromDateString</methodname> verwendet

wird.

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

Die Eigenschaften <varname>from_string</varname> und

<varname>date_string</varname> wurden für

<classname>DateInterval</classname>-Instanzen hinzugefügt, die mit

der Methode <methodname>DateInterval::createFromDateString</methodname>

erstellt wurden.

</entry>

</row>

<row>

<entry>8.2.0</entry>

<entry>

Nur die Eigenschaften <literal>y</literal> bis <literal>f</literal>,

<literal>invert</literal> und <literal>days</literal> sind sichtbar.

</entry>

</row>

<row>

<entry>7.4.0</entry>

<entry>

<classname>DateInterval</classname>-Instanzen sind nun nicht mehr

vergleichbar; bisher wurden alle

<classname>DateInterval</classname>-Instanzen als gleich angesehen.

</entry>

</row>

<row>

<entry>7.1.0</entry>

<entry>Die Eigenschaft <varname>f</varname> wurde hinzugefügt.</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

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

</partintro>

&reference.datetime.entities.dateinterval;

</reference>