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

<refentry xml:id="dateinterval.createfromdatestring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>DateInterval::createFromDateString</refname>

<refpurpose>Configure un objet <classname>DateInterval</classname> à partir des parties d'une chaîne</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<para>&style.oop;</para>

<methodsynopsis role="DateInterval">

<modifier>public</modifier> <modifier>static</modifier> <type>DateInterval</type><methodname>DateInterval::createFromDateString</methodname>

<methodparam><type>string</type><parameter>datetime</parameter></methodparam>

</methodsynopsis>

<para>&style.procedural;</para>

<methodsynopsis>

<type class="union"><type>DateInterval</type><type>false</type></type><methodname>date_interval_create_from_date_string</methodname>

<methodparam><type>string</type><parameter>datetime</parameter></methodparam>

</methodsynopsis>

<para>

Utilise les analyseurs de dates comme celui de

<classname>DateTimeImmutable</classname> et

configure un objet <classname>DateInterval</classname>

à partir d'une chaîne de caractères.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>datetime</parameter></term>

<listitem>

<para>

Une date avec des parties relatives. Spécifiquement, le

<link linkend="datetime.formats.relative">format relatif</link>

supporté par l'analyseur utilisé pour les classes

<classname>DateTimeImmutable</classname>,

<classname>DateTime</classname>, et <function>strtotime</function>

sera utilisé pour construire le DateInterval.

</para>

<para>

Pour utiliser une chaîne au format ISO-8601 comme <literal>P7D</literal>, il faut

utiliser <methodname>DateInterval::__construct</methodname>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne <classname>DateInterval</classname> en cas de succès.

&return.falseforfailure.style.procedural;

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

API orientée objet uniquement : Si une chaîne Date/Time invalide est passée,

<exceptionname>DateMalformedStringException</exceptionname> est levée.

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

<methodname>DateInterval::createFromDateString</methodname> lance désormais

<exceptionname>DateMalformedStringException</exceptionname> si une

chaîne invalide est passée. Auparavant, il retournait &false;,

et un avertissement était émis.

<function>date_interval_create_from_date_string</function> n'a pas été

modifié.

</entry>

</row>

<row>

<entry>8.2.0</entry>

<entry>

Seules les propriétés <literal>from_string</literal> et

<literal>date_string</literal> seront visibles lorsqu'un objet

<classname>DateInterval</classname> est créé avec cette méthode.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Analyse d'intervalles de dates valides</title>

<programlisting role="php" annotations="non-interactive">

</programlisting>

</example>

</para>

<para>

<example>

<title>Analyse des combinaisons et des intervalles négatifs</title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

<para>

<example>

<title>Analyse des intervalles de dates relatifs spéciaux</title>

<programlisting role="php">

</programlisting>

&example.outputs.82;

<screen role="php">

</screen>

&example.outputs.8.similar;

<screen role="php">

</screen>

</example>

</para>

</refsect1>

</refentry>