Files
doc-fr/reference/datetime/dateperiod/getenddate.xml
2022-06-04 16:43:30 +01:00

124 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b90e4a6e432a5176bd308a7c4f2315ba94848377 Maintainer: jbnahan Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: Gildas Dubois-->
<refentry xml:id="dateperiod.getenddate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DatePeriod::getEndDate</refname>
<refpurpose>
Retourne la date de fin
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>DateTimeInterface</type><type>null</type></type><methodname>DatePeriod::getEndDate</methodname>
<void/>
</methodsynopsis>
<para>
Retourne la date de fin de la période.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne &null; si la <classname>DatePeriod</classname> n'a pas de date de fin.
Par exemple, lorsqu'elle est initialisée avec le paramètre <parameter>recurrences</parameter>,
ou avec le paramètre <parameter>isostr</parameter> sans date de fin.
</para>
<para>
Renvoie un <type>object</type> <classname>DateTimeImmutable</classname>
lorsque la <classname>DatePeriod</classname> est initialisée avec un
<type>object</type> <classname>DateTimeImmutable</classname> comme paramètre <parameter>end</parameter>.
</para>
<para>
Retourne un <type>object</type> <classname>DateTime</classname> cloné
représentant la date de fin sinon.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemples avec <methodname>DatePeriod::getEndDate</methodname></title>
<programlisting role="php">
<![CDATA[
<?php
$period = new DatePeriod(
new DateTime('2016-05-16T00:00:00Z'),
new DateInterval('P1D'),
new DateTime('2016-05-20T00:00:00Z')
);
$start = $period->getEndDate();
echo $start->format(DateTime::ISO8601);
?>
]]>
</programlisting>
&examples.outputs;
<screen>
<![CDATA[
2016-05-20T00:00:00+0000
]]>
</screen>
</example>
<example>
<title><methodname>DatePeriod::getEndDate</methodname> sans date de fin</title>
<programlisting role="php">
<![CDATA[
<?php
$period = new DatePeriod(
new DateTime('2016-05-16T00:00:00Z'),
new DateInterval('P1D'),
7
);
var_dump($period->getEndDate());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
NULL
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>DatePeriod::getStartDate</methodname></member>
<member><methodname>DatePeriod::getDateInterval</methodname></member>
</simplelist>
</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
-->