formatobject.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->

<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>オブジェクトの書式を設定する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="IntlDateFormatter">
   <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>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>
   &style.procedural;
  </para>
  <methodsynopsis>
   <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>
   この関数は、<classname>IntlCalendar</classname> オブジェクトや
   <classname>DateTime</classname> オブジェクトをフォーマットします。その際、明示的に
   <classname>IntlDateFormatter</classname> オブジェクトを作る必要はありません。
  </para>
  <para>
   一時的な <classname>IntlDateFormatter</classname> が作られ、
   渡されたオブジェクトのタイムゾーンを受け取ります。PHP に組み込まれているタイムゾーンデータベースは使いません。
   そのかわりに、ICU のタイムゾーンデータベースを使います。
   したがって、<classname>DateTime</classname> オブジェクトで使うタイムゾーン ID は
   ICU のデータベースに存在するものでなければいけません。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>datetime</parameter></term>
    <listitem>
     <para>
      <classname>IntlCalendar</classname> あるいは
      <classname>DateTime</classname> 型のオブジェクト。
      このオブジェクトの中のタイムゾーン情報を使います。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>format</parameter></term>
    <listitem>
     <para>
      日付/時刻のフォーマット方法。二つの要素からなる配列
      (最初の要素が日付のスタイル、二番目の要素が時刻のスタイル。それぞれ、定数
      <constant>IntlDateFormatter::NONE</constant>、
      <constant>IntlDateFormatter::SHORT</constant>、
      <constant>IntlDateFormatter::MEDIUM</constant>、
      <constant>IntlDateFormatter::LONG</constant>、
      <constant>IntlDateFormatter::FULL</constant> のいずれか)、
      これらの定数のいずれかの値を表す <type>int</type> 型
      (日付と時刻の両方に使います)、あるいは
      <link xlink:href="&url.icu.dateformat2;">ICU
      のドキュメント</link> にあるフォーマットを表す文字列を指定します。&null; を渡した場合はデフォルトのスタイルを使います。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>locale</parameter></term>
    <listitem>
     <para>
      利用するロケール。&null; を渡した場合は <link
      linkend="ini.intl.default-locale">デフォルトのロケール</link> を使います。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   結果を文字列で返します。&return.falseforfailure;。
  </para>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>IntlDateFormatter::formatObject</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
/* デフォルトのタイムゾーンは利用せず、オブジェクトのタイムゾーンを取得します */
ini_set('date.timezone', 'UTC');
/* デフォルトのロケールは、この ini 設定から取得します */
ini_set('intl.default_locale', 'fr_FR');

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

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

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

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

echo "with 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[
default:
    6 juin 2013 17:05:06
long $format (full):
    jeudi 6 juin 2013 17:05:06 heure d’été irlandaise
array $format (none, full):
    17:05:06 heure d’été irlandaise
string $format (d 'of' MMMM y):
    6 of June 2013
with 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
-->