gmstrftime.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5c951013ca04161992efed8b86fb40f55669958e Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xml:id="function.gmstrftime" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gmstrftime</refname>
  <refpurpose>
   ロケールの設定に基づいて GMT/UTC 時刻/日付をフォーマットする
  </refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  &warn.deprecated.function-8-1-0.alternatives;
  <simplelist role="alternatives">
   <member><function>gmdate</function></member>
   <member><methodname>IntlDateFormatter::format</methodname></member>
  </simplelist>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>gmstrftime</methodname>
   <methodparam><type>string</type><parameter>format</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>timestamp</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   グリニッジ標準時を返すこと以外は、
   <function>strftime</function> と同じ動作をします。例えば、東部標準時
   (GMT -0500) で実行した場合、以下の最初の行は "Dec 31 1998 20:00:00"
   を出力し、二行目は "Jan 01 1999 01:00:00" を出力します。
  </para>
  <warning>
   <para>
    この関数は、オペレーティングシステムのロケールの情報に依存しており、
    情報が一貫していなかったり、全く利用できない可能性があります。
    代わりに、<methodname>IntlDateFormatter::format</methodname>
    を使いましょう。
   </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <para>
       <function>strftime</function> の説明を参照ください。
      </para>
     </listitem>
    </varlistentry>
    &date.timestamp.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   指定した <parameter>timestamp</parameter> または timestamp
   が指定されていない場合に現在のローカル時間を用いて、
   指定したフォーマット文字列に基づき文字列をフォーマットして返します。
   月および曜日の名前、およびその他の言語依存の文字列は、
   <function>setlocale</function> で設定された現在のロケールを尊重して表示されます。
   失敗時には、&false; を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <parameter>timestamp</parameter> は、nullable になりました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>gmstrftime</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
setlocale(LC_TIME, 'en_US');
echo strftime("%b %d %Y %H:%M:%S", mktime(20, 0, 0, 12, 31, 98)) . "\n";
echo gmstrftime("%b %d %Y %H:%M:%S", mktime(20, 0, 0, 12, 31, 98)) . "\n";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>IntlDateFormatter::format</methodname></member>
    <member><methodname>DateTimeInterface::format</methodname></member>
    <member><function>strftime</function></member>
   </simplelist>
  </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
-->