doc-fr/reference/intl/dateformatter/formatobject.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ce46b05403346a4b21937db0b923173431104145 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DAnnebicque -->
<refentry xml:id="intldateformatter.formatobject" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlDateFormatter::formatObject</refname>
  <refname>datefmt_format_object</refname>
  <refpurpose>Formate un objet</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="oop">
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>IntlDateFormatter::formatObject</methodname>
   <methodparam><type class="union"><type>IntlCalendar</type><type>DateTime</type></type><parameter>datetime</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>int</type><type>string</type><type>null</type></type><parameter>format</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>locale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis role="procedural">
   <type class="union"><type>string</type><type>false</type></type><methodname>datefmt_format_object</methodname>
   <methodparam><type class="union"><type>IntlCalendar</type><type>DateTimeInterface</type></type><parameter>datetime</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>int</type><type>string</type><type>null</type></type><parameter>format</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>locale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Cette fonction permet le formatage d'un objet <classname>IntlCalendar</classname> ou
   d'un objet <classname>DateTime</classname> sans avoir créé auparavant un objet
   <classname>IntlDateFormatter</classname>.
  </para>
  <para>
   L'objet <classname>IntlDateFormatter</classname> temporaire créé prendra le décalage
   horaire depuis l'objet passé. La base de données des décalages horaires interne
   à PHP ne sera pas utilisée - ICU sera utilisé à la place. L'identifiant
   de décalage horaire utilisé dans les objets <classname>DateTime</classname>
   doit toutefois exister également dans la base de données ICU.
  </para>
  
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>datetime</parameter></term>
    <listitem>
     <para>
      Un objet de type <classname>IntlCalendar</classname> ou de type
      <classname>DateTime</classname>. L'information de décalage horaire dans
      l'objet sera utilisée.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>format</parameter></term>
    <listitem>
     <para>
      Format de la date/heure. Peut-être soit un tableau avec deux éléments (d'abord
      le style de la date, puis, le style de l'heure, en utilisant une des constantes
      suivantes : <constant>IntlDateFormatter::NONE</constant>,
      <constant>IntlDateFormatter::SHORT</constant>,
      <constant>IntlDateFormatter::MEDIUM</constant>,
      <constant>IntlDateFormatter::LONG</constant>,
      <constant>IntlDateFormatter::FULL</constant>), soit un type <type>int</type>
      avec la valeur de l'une de ces constantes (auquel cas, il sera utilisé
      à la fois pour la date et l'heure), ou un type <type>string</type>
      avec le format décrit dans la <link xlink:href="&url.icu.dateformat2;">documentation
      ICU</link>. Si &null; est fourni, le style par défaut sera utilisé.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>locale</parameter></term>
    <listitem>
     <para>
      La locale à utiliser, ou &null; pour utiliser la <link
      linkend="ini.intl.default-locale">locale par défaut</link>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Une chaîne de caractères contenant le résultat&return.falseforfailure;.
  </para>
 </refsect1>
 
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>IntlDateFormatter::formatObject</function></title>
    <programlisting role="php">
<![CDATA[
<?php
/* Le décalage horaire par défaut n'est pas significatif ;
   il est pris depuis l'objet */
ini_set('date.timezone', 'UTC');

/* La locale par défaut est prise depuis la configuration ini */
ini_set('intl.default_locale', 'fr_FR');

$cal = IntlCalendar::fromDateTime("2013-06-06 17:05:06 Europe/Dublin");
echo "défault :\n\t",
        IntlDateFormatter::formatObject($cal),
        "\n";

echo "long \$format (complet) :\n\t",
        IntlDateFormatter::formatObject($cal, IntlDateFormatter::FULL),
        "\n";

echo "array \$format (aucun, complet) :\n\t",
        IntlDateFormatter::formatObject($cal, array(
                IntlDateFormatter::NONE,
                IntlDateFormatter::FULL)),
        "\n";

echo "string \$format (d 'de' MMMM y):\n\t",
        IntlDateFormatter::formatObject($cal, "d 'de' MMMM y", 'en_US'),
        "\n";

echo "avec DateTime :\n\t",
        IntlDateFormatter::formatObject(
                new DateTime("2013-09-09 09:09:09 Europe/Madrid"),
                IntlDateFormatter::FULL,
                'es_ES'),
        "\n";

]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
défault :
    6 juin 2013 17:05:06
long $format (complet):
    jeudi 6 juin 2013 17:05:06 heure d’été irlandaise
array $format (aucun, complet):
    17:05:06 heure d’été irlandaise
string $format (d 'de' MMMM y):
    6 de June 2013
avec DateTime :
    lunes, 9 de septiembre de 2013 09:09:09 Hora de verano de Europa central

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