1
0
mirror of https://github.com/php/doc-fr.git synced 2026-03-24 07:02:06 +01:00
Files
archived-doc-fr/reference/datetime/dateinterval/createfromdatestring.xml
Louis-Arnaud 5755a1bd8c Style impersonnel dans reference/ (a-d) (#2539)
* style: remplacer vous/votre/vos par style impersonnel dans reference/[a-d]*
2026-02-25 11:54:29 +01:00

289 lines
7.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: lacatoire Status: ready -->
<!-- Reviewed: yes -->
<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">
<![CDATA[
<?php
// Chacun de ces intervalles sont égaux.
$i = new DateInterval('P1D');
$i = DateInterval::createFromDateString('1 day');
$i = new DateInterval('P2W');
$i = DateInterval::createFromDateString('2 weeks');
$i = new DateInterval('P3M');
$i = DateInterval::createFromDateString('3 months');
$i = new DateInterval('P4Y');
$i = DateInterval::createFromDateString('4 years');
$i = new DateInterval('P1Y1D');
$i = DateInterval::createFromDateString('1 year + 1 day');
$i = new DateInterval('P1DT12H');
$i = DateInterval::createFromDateString('1 day + 12 hours');
$i = new DateInterval('PT3600S');
$i = DateInterval::createFromDateString('3600 seconds');
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Analyse des combinaisons et des intervalles négatifs</title>
<programlisting role="php">
<![CDATA[
<?php
$i = DateInterval::createFromDateString('62 weeks + 1 day + 2 weeks + 2 hours + 70 minutes');
echo $i->format('%d %h %i'), "\n";
$i = DateInterval::createFromDateString('1 year - 10 days');
echo $i->format('%y %d'), "\n";
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
449 2 70
1 -10
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Analyse des intervalles de dates relatifs spéciaux</title>
<programlisting role="php">
<![CDATA[
<?php
$i = DateInterval::createFromDateString('last day of next month');
var_dump($i);
$i = DateInterval::createFromDateString('last weekday');
var_dump($i);
]]>
</programlisting>
&example.outputs.82;
<screen role="php">
<![CDATA[
object(DateInterval)#1 (2) {
["from_string"]=>
bool(true)
["date_string"]=>
string(22) "last day of next month"
}
object(DateInterval)#2 (2) {
["from_string"]=>
bool(true)
["date_string"]=>
string(12) "last weekday"
}
]]>
</screen>
&example.outputs.8.similar;
<screen role="php">
<![CDATA[
object(DateInterval)#1 (16) {
["y"]=>
int(0)
["m"]=>
int(1)
["d"]=>
int(0)
["h"]=>
int(0)
["i"]=>
int(0)
["s"]=>
int(0)
["f"]=>
float(0)
["weekday"]=>
int(0)
["weekday_behavior"]=>
int(0)
["first_last_day_of"]=>
int(2)
["invert"]=>
int(0)
["days"]=>
bool(false)
["special_type"]=>
int(0)
["special_amount"]=>
int(0)
["have_weekday_relative"]=>
int(0)
["have_special_relative"]=>
int(0)
}
object(DateInterval)#2 (16) {
["y"]=>
int(0)
["m"]=>
int(0)
["d"]=>
int(0)
["h"]=>
int(0)
["i"]=>
int(0)
["s"]=>
int(0)
["f"]=>
float(0)
["weekday"]=>
int(0)
["weekday_behavior"]=>
int(0)
["first_last_day_of"]=>
int(0)
["invert"]=>
int(0)
["days"]=>
bool(false)
["special_type"]=>
int(1)
["special_amount"]=>
int(-1)
["have_weekday_relative"]=>
int(0)
["have_special_relative"]=>
int(1)
}
]]>
</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
-->