mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-26 01:42:09 +01:00
307 lines
9.9 KiB
XML
307 lines
9.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: ac83abe55f4da019036de5ec14400d674fa3f9f5 Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
<!-- CREDITS: DavidA -->
|
|
<reference xml:id="class.dateperiod" 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 DatePeriod</title>
|
|
<titleabbrev>DatePeriod</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ DatePeriod intro -->
|
|
<section xml:id="dateperiod.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
Représente une période de dates.
|
|
</para>
|
|
<para>
|
|
Une période de dates permet des itérations à travers
|
|
un jeu de dates et d'heures, survenant à intervalle régulier,
|
|
sur une période donnée.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="dateperiod.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis class="class">
|
|
<ooclass>
|
|
<classname>DatePeriod</classname>
|
|
</ooclass>
|
|
|
|
<oointerface>
|
|
<modifier>implements</modifier>
|
|
<interfacename>IteratorAggregate</interfacename>
|
|
</oointerface>
|
|
|
|
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="dateperiod.constants.exclude-start-date">DatePeriod::EXCLUDE_START_DATE</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="dateperiod.constants.include-end-date">DatePeriod::INCLUDE_END_DATE</varname>
|
|
</fieldsynopsis>
|
|
|
|
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>readonly</modifier>
|
|
<type class="union"><type>DateTimeInterface</type><type>null</type></type>
|
|
<varname linkend="dateperiod.props.start">start</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>readonly</modifier>
|
|
<type class="union"><type>DateTimeInterface</type><type>null</type></type>
|
|
<varname linkend="dateperiod.props.current">current</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>readonly</modifier>
|
|
<type class="union"><type>DateTimeInterface</type><type>null</type></type>
|
|
<varname linkend="dateperiod.props.end">end</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>readonly</modifier>
|
|
<type class="union"><type>DateInterval</type><type>null</type></type>
|
|
<varname linkend="dateperiod.props.interval">interval</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>readonly</modifier>
|
|
<type>int</type>
|
|
<varname linkend="dateperiod.props.recurrences">recurrences</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>readonly</modifier>
|
|
<type>bool</type>
|
|
<varname linkend="dateperiod.props.include-start-date">include_start_date</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>readonly</modifier>
|
|
<type>bool</type>
|
|
<varname linkend="dateperiod.props.include-end-date">include_end_date</varname>
|
|
</fieldsynopsis>
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='DatePeriod'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DatePeriod'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
</classsynopsis>
|
|
<!-- }}} -->
|
|
|
|
</section>
|
|
|
|
<!-- {{{ DatePeriod constants -->
|
|
<section xml:id="dateperiod.constants">
|
|
&reftitle.constants;
|
|
<variablelist>
|
|
<varlistentry xml:id="dateperiod.constants.exclude-start-date">
|
|
<term><constant>DatePeriod::EXCLUDE_START_DATE</constant></term>
|
|
<listitem>
|
|
<para>Exclut la date de début, utilisée par <function>DatePeriod::__construct</function>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="dateperiod.constants.include-end-date">
|
|
<term><constant>DatePeriod::INCLUDE_END_DATE</constant></term>
|
|
<listitem>
|
|
<para>Inclut la date de fin, utilisée par <function>DatePeriod::__construct</function>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="dateperiod.props">
|
|
&reftitle.properties;
|
|
<variablelist>
|
|
<varlistentry xml:id="dateperiod.props.recurrences">
|
|
<term><varname>recurrences</varname></term>
|
|
<listitem>
|
|
<para>
|
|
La quantité minimale d'instances retournée par l'itérateur.
|
|
</para>
|
|
<para>
|
|
Si le nombre de récurrences a été explicitement passé par l'intermédiaire
|
|
du paramètre <literal>$recurrences</literal> dans le constructeur de l'instance
|
|
<classname>DatePeriod</classname>, alors cette propriété contient cette valeur,
|
|
<emphasis>plus</emphasis> un si la date de début n'a pas été désactivée par
|
|
<constant>DatePeriod::EXCLUDE_START_DATE</constant>, <emphasis>plus</emphasis>
|
|
un si la date de fin a été activée par
|
|
<constant>DatePeriod::INCLUDE_END_DATE</constant>.
|
|
</para>
|
|
<para>
|
|
Si le nombre de récurrences n'a pas été explicitement passé, alors cette
|
|
propriété contient le nombre minimum d'instances retournées. Cela serait
|
|
<literal>0</literal>, <emphasis>plus</emphasis> un si la date de début n'a pas
|
|
été désactivée par <constant>DatePeriod::EXCLUDE_START_DATE</constant>,
|
|
<emphasis>plus</emphasis> un si la date de fin a été activée par
|
|
<constant>DatePeriod::INCLUDE_END_DATE</constant>.
|
|
</para>
|
|
<para>
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[<?php
|
|
$start = new DateTime('2018-12-31 00:00:00');
|
|
$end = new DateTime('2021-12-31 00:00:00');
|
|
$interval = new DateInterval('P1M');
|
|
$recurrences = 5;
|
|
|
|
// récurrences explicitement définies par le constructeur
|
|
$period = new DatePeriod($start, $interval, $recurrences, DatePeriod::EXCLUDE_START_DATE);
|
|
echo $period->recurrences, "\n";
|
|
|
|
$period = new DatePeriod($start, $interval, $recurrences);
|
|
echo $period->recurrences, "\n";
|
|
|
|
$period = new DatePeriod($start, $interval, $recurrences, DatePeriod::INCLUDE_END_DATE);
|
|
echo $period->recurrences, "\n";
|
|
|
|
// récurrences non définies dans le constructeur
|
|
$period = new DatePeriod($start, $interval, $end);
|
|
echo $period->recurrences, "\n";
|
|
|
|
$period = new DatePeriod($start, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
|
|
echo $period->recurrences, "\n";
|
|
?>]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen role="php">
|
|
5
|
|
6
|
|
7
|
|
1
|
|
0
|
|
</screen>
|
|
</informalexample>
|
|
</para>
|
|
<para>
|
|
Voir aussi <methodname>DatePeriod::getRecurrences</methodname>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="dateperiod.props.include-end-date">
|
|
<term><varname>include_end_date</varname></term>
|
|
<listitem>
|
|
<para>
|
|
Inclut ou non la date de fin dans le jeu de dates récurrentes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="dateperiod.props.include-start-date">
|
|
<term><varname>include_start_date</varname></term>
|
|
<listitem>
|
|
<para>
|
|
S'il faut inclure la date de début dans l'ensemble des dates récurrentes
|
|
ou non.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="dateperiod.props.start">
|
|
<term><varname>start</varname></term>
|
|
<listitem>
|
|
<para>
|
|
La date de début de la période.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="dateperiod.props.current">
|
|
<term><varname>current</varname></term>
|
|
<listitem>
|
|
<para>
|
|
Pendant l'itération, cela contiendra la date du jour dans la période.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="dateperiod.props.end">
|
|
<term><varname>end</varname></term>
|
|
<listitem>
|
|
<para>
|
|
La date de fin de la période.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="dateperiod.props.interval">
|
|
<term><varname>interval</varname></term>
|
|
<listitem>
|
|
<para>
|
|
Une spécification d'intervalle répétitif ISO 8601.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
|
|
<section role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.2.0</entry>
|
|
<entry>
|
|
La constante <constant>DatePeriod::INCLUDE_END_DATE</constant> et
|
|
la propriété <property>include_end_date</property> ont été ajoutées.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
La classe <classname>DatePeriod</classname> implémente désormais <interfacename>IteratorAggregate</interfacename>.
|
|
Auparavant, seule <interfacename>Traversable</interfacename> était implémentée.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</section>
|
|
|
|
</partintro>
|
|
|
|
&reference.datetime.entities.dateperiod;
|
|
|
|
</reference>
|
|
<!-- 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
|
|
-->
|