php/archived-doc-fr
1
0
Fork 0
mirror of https://github.com/php/doc-fr.git synced 2026-03-24 15:12:13 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
4f1cdf80bbfdc95f059faebfdfe42011da19ff82
archived-doc-fr/reference/datetime/datetimeinterface/format.xml
George Peter Banyard cb2dca10c2 Apply commit 511dd1075401d892a314b475f0985378582da799 
The format char  is only available as of PHP 8.0.0.
2021-01-26 18:17:34 +00:00

446 lines
16 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 511dd1075401d892a314b475f0985378582da799 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="datetime.format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTime::format</refname>
<refname>DateTimeImmutable::format</refname>
<refname>DateTimeInterface::format</refname>
<refname>date_format</refname>
<refpurpose>Retourne une date formatée suivant le format fourni</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>string</type><methodname>DateTime::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="DateTimeImmutable">
<modifier>public</modifier> <type>string</type><methodname>DateTimeImmutable::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="DateTimeInterface">
<modifier>public</modifier> <type>string</type><methodname>DateTimeInterface::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>string</type><methodname>date_format</methodname>
<methodparam><type>DateTimeInterface</type><parameter>object</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
Retourne une date formatée suivant le format fourni.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&date.datetime.description;
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Le format de la date désirée. Voir les options de formatage ci-dessous.
Il existe aussi de nombreuses
<link linkend="datetime.constants.types">constantes de dates</link>
qui peuvent être utilisées, ce qui fait que <constant>DATE_RSS</constant>
va remplacer le format <literal>"D, d M Y H:i:s"</literal>.
</para>
<para>
<table>
<title>
Les caractères suivants sont reconnus dans le paramètre
<parameter>format</parameter>
</title>
<tgroup cols="3">
<thead>
<row>
<entry>Caractères pour le paramètre <parameter>format</parameter></entry>
<entry>Description</entry>
<entry>Exemple de valeurs retournées</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis>Jour</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>d</literal></entry>
<entry>Jour du mois, sur deux chiffres (avec un zéro initial)</entry>
<entry><literal>01</literal> à <literal>31</literal></entry>
</row>
<row>
<entry><literal>D</literal></entry>
<entry>Jour de la semaine, en trois lettres (et en anglais - par défaut : en anglais, ou sinon, dans la langue locale du serveur)</entry>
<entry><literal>Mon</literal> à <literal>Sun</literal></entry>
</row>
<row>
<entry><literal>j</literal></entry>
<entry>Jour du mois sans les zéros initiaux</entry>
<entry><literal>1</literal> à <literal>31</literal></entry>
</row>
<row>
<entry><literal>l</literal> ('L' minuscule)</entry>
<entry>Jour de la semaine, textuel, version longue, en anglais</entry>
<entry><literal>Sunday</literal> à <literal>Saturday</literal></entry>
</row>
<row>
<entry><literal>N</literal></entry>
<entry>Représentation numérique ISO-8601 du jour de la semaine</entry>
<entry><literal>1</literal> (pour Lundi) à <literal>7</literal> (pour Dimanche)</entry>
</row>
<row>
<entry><literal>S</literal></entry>
<entry>Suffixe ordinal d'un nombre pour le jour du mois, en anglais, sur deux lettres</entry>
<entry>
<literal>st</literal>, <literal>nd</literal>, <literal>rd</literal> ou
<literal>th</literal>. Fonctionne bien avec <literal>j</literal>
</entry>
</row>
<row>
<entry><literal>w</literal></entry>
<entry>Jour de la semaine au format numérique</entry>
<entry><literal>0</literal> (pour dimanche) à <literal>6</literal> (pour samedi)</entry>
</row>
<row>
<entry><literal>z</literal></entry>
<entry>Jour de l'année</entry>
<entry><literal>0</literal> à <literal>365</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Semaine</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>W</literal></entry>
<entry>Numéro de semaine dans l'année ISO-8601, les semaines commencent
le lundi</entry>
<entry>Exemple : <literal>42</literal> (la 42ème semaine de l'année)</entry>
</row>
<row>
<entry align="center"><emphasis>Mois</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>F</literal></entry>
<entry>Mois, textuel, version longue; en anglais, comme
<literal>January</literal> ou <literal>December</literal></entry>
<entry><literal>January</literal> à <literal>December</literal></entry>
</row>
<row>
<entry><literal>m</literal></entry>
<entry>Mois au format numérique, avec zéros initiaux</entry>
<entry><literal>01</literal> à <literal>12</literal></entry>
</row>
<row>
<entry><literal>M</literal></entry>
<entry>Mois, en trois lettres, en anglais</entry>
<entry><literal>Jan</literal> à <literal>Dec</literal></entry>
</row>
<row>
<entry><literal>n</literal></entry>
<entry>Mois sans les zéros initiaux</entry>
<entry>&one; à <literal>12</literal></entry>
</row>
<row>
<entry><literal>t</literal></entry>
<entry>Nombre de jours dans le mois</entry>
<entry><literal>28</literal> à <literal>31</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Année</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>L</literal></entry>
<entry>Est ce que l'année est bissextile</entry>
<entry><literal>1</literal> si bissextile, <literal>0</literal> sinon.</entry>
</row>
<row>
<entry><literal>o</literal></entry>
<entry>La numérotation de semaine dans l'année ISO-8601. C'est la même valeur que
<literal>Y</literal>, excepté si le numéro de la semaine ISO
(<literal>W</literal>) appartient à l'année précédente ou suivante,
cette année sera utilisée à la place.</entry>
<entry>Exemples : <literal>1999</literal> ou <literal>2003</literal></entry>
</row>
<row>
<entry><literal>Y</literal></entry>
<entry>Année sur 4 chiffres</entry>
<entry>Exemples : <literal>1999</literal> ou <literal>2003</literal></entry>
</row>
<row>
<entry><literal>y</literal></entry>
<entry>Année sur 2 chiffres</entry>
<entry>Exemples : <literal>99</literal> ou <literal>03</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Heure</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>a</literal></entry>
<entry>Ante meridiem et Post meridiem en minuscules</entry>
<entry><literal>am</literal> ou <literal>pm</literal></entry>
</row>
<row>
<entry><literal>A</literal></entry>
<entry>Ante meridiem et Post meridiem en majuscules</entry>
<entry><literal>AM</literal> ou <literal>PM</literal></entry>
</row>
<row>
<entry><literal>B</literal></entry>
<entry>Heure Internet Swatch</entry>
<entry><literal>000</literal> à <literal>999</literal></entry>
</row>
<row>
<entry><literal>g</literal></entry>
<entry>Heure, au format 12h, sans les zéros initiaux</entry>
<entry><literal>1</literal> à <literal>12</literal></entry>
</row>
<row>
<entry><literal>G</literal></entry>
<entry>Heure, au format 24h, sans les zéros initiaux</entry>
<entry><literal>0</literal> à <literal>23</literal></entry>
</row>
<row>
<entry><literal>h</literal></entry>
<entry>Heure, au format 12h, avec les zéros initiaux</entry>
<entry><literal>01</literal> à <literal>12</literal></entry>
</row>
<row>
<entry><literal>H</literal></entry>
<entry>Heure, au format 24h, avec les zéros initiaux</entry>
<entry><literal>00</literal> à <literal>23</literal></entry>
</row>
<row>
<entry><literal>i</literal></entry>
<entry>Minutes avec les zéros initiaux</entry>
<entry><literal>00</literal> à <literal>59</literal></entry>
</row>
<row>
<entry><literal>s</literal></entry>
<entry>Secondes avec zéros initiaux</entry>
<entry><literal>00</literal> à <literal>59</literal></entry>
</row>
<row>
<entry><literal>u</literal></entry>
<entry>
Microsecondes. Notez que la fonction
<function>date</function> génèrera toujours
<literal>000000</literal> vu qu'elle prend un paramètre de type
entier, alors que la méthode <methodname>DateTime::format</methodname>
supporte les microsecondes si <classname>DateTime</classname> a
été créée avec des microsecondes.
</entry>
<entry>Exemple : <literal>654321</literal></entry>
</row>
<row>
<entry><literal>v</literal></entry>
<entry>
Millisecondes. Même note que pour
<literal>u</literal>.
</entry>
<entry>Exemple: <literal>654</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Fuseau horaire</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>e</literal></entry>
<entry>L'identifiant du fuseau horaire</entry>
<entry>Exemples : <literal>UTC</literal>, <literal>GMT</literal>, <literal>Atlantic/Azores</literal></entry>
</row>
<row>
<entry><literal>I</literal> (i majuscule)</entry>
<entry>L'heure d'été est activée ou pas</entry>
<entry><literal>1</literal> si oui, <literal>0</literal> sinon.</entry>
</row>
<row>
<entry><literal>O</literal></entry>
<entry>Différence d'heures avec l'heure de Greenwich (GMT), sans
deux-points entre les heures et les minutes</entry>
<entry>Exemple : <literal>+0200</literal></entry>
</row>
<row>
<entry><literal>P</literal></entry>
<entry>Différence avec l'heure Greenwich (GMT) avec un deux-points
entre les heures et les minutes</entry>
<entry>Exemple : <literal>+02:00</literal></entry>
</row>
<row>
<entry><literal>p</literal></entry>
<entry>Identique à <literal>P</literal>, mais retourne <literal>Z</literal> au lieu de <literal>+00:00</literal></entry>
<entry>Exemple : <literal>+02:00</literal></entry>
</row>
<row>
<entry><literal>T</literal></entry>
<entry>Abréviation du fuseau horaire</entry>
<entry>Exemples : <literal>EST</literal>, <literal>MDT</literal> ...</entry>
</row>
<row>
<entry><literal>Z</literal></entry>
<entry>Décalage horaire en secondes. Le décalage des zones à l'ouest
de la zone UTC est négative, et à l'est, il est positif.</entry>
<entry><literal>-43200</literal> à <literal>50400</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Date et Heure complète</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>c</literal></entry>
<entry>Date au format ISO 8601</entry>
<entry>2004-02-12T15:19:21+00:00</entry>
</row>
<row>
<entry><literal>r</literal></entry>
<entry>Format de date <link xlink:href="&url.rfc;2822">RFC 2822</link></entry>
<entry>Exemple : <literal>Thu, 21 Dec 2000 16:01:070200</literal></entry>
</row>
<row>
<entry><literal>U</literal></entry>
<entry>Secondes depuis l'époque Unix (1er Janvier 1970, 0h00 00s GMT)</entry>
<entry>Voir aussi <function>time</function></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
Les caractères non reconnus seront imprimés tels quels.
"<literal>Z</literal>" retournera toujours <literal>0</literal> lorsqu'il est utilisé avec
<function>gmdate</function>.
</para>
<note>
<para>
Sachant que cette fonction n'accepte que des entiers sous la forme de timestamp,
le caractère <literal>u</literal> n'est utile que lors de l'utilisation de la fonction
<function>date_format</function> avec un timestamp utilisateur créé avec la fonction
<function>date_create</function>.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne la date formatée, sous forme de chaîne de caractères,
en cas de succès.
</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.0.0</entry>
<entry>
Antérieur à cette version, &false; était retourné en cas d'échec.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Le caractère de format <literal>p</literal> a été ajouté.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemple avec <function>DateTime::format</function></title>
<para>&style.oop;</para>
<programlisting role="php">
<![CDATA[
<?php
$date = new DateTime('2000-01-01');
echo $date->format('Y-m-d H:i:s');
?>
]]>
</programlisting>
<para>&style.procedural;</para>
<programlisting role="php">
<![CDATA[
<?php
$date = date_create('2000-01-01');
echo date_format($date, 'Y-m-d H:i:s');
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
2000-01-01 00:00:00
]]>
</screen>
</example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<para>
Cette méthode n'utilise pas les locales. Tous les affichages
seront en anglais.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>date</function></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
-->
Reference in New Issue View Git Blame Copy Permalink