archived-doc-ja/reference/datetime/functions/localtime.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a4ba07f273fd7d34520a8d02052a746076094e32 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.localtime" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>localtime</refname>
  <refpurpose>ローカルタイムを得る</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>localtime</methodname>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>timestamp</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>associative</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>localtime</function> 関数は、C 言語の
   同名の関数コールにより返される構造体と同じ内容の配列を返します。
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    
    &date.timestamp.description;
   
    <varlistentry>
     <term><parameter>associative</parameter></term>
     <listitem>
      <para>
       この関数が数値のインデックスによる通常の配列を返すか、
       連想配列を返すかを指定します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>associative</parameter> が &false;
   に設定されるか省略された場合は、
   数値のインデックスにょる通常の配列を返します。
   <parameter>associative</parameter> が &true; に設定された場合は、
   <function>localtime</function> は C 言語の関数 localtime
   のコールにより返される構造体の全ての要素を有する連想配列を返します。
   この連想配列の各キーの名前は次のようになります。
  </para>
  <para>
   <itemizedlist>
    <listitem>
     <simpara>
      "tm_sec" - 秒 (<literal>0</literal> から <literal>59</literal>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_min" - 分 (<literal>0</literal> から <literal>59</literal>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_hour" - 時 (<literal>0</literal> から <literal>23</literal>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_mday" - 月の日付 (<literal>1</literal> から <literal>31</literal>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_mon" - 月 (<literal>0</literal> (1月) から <literal>11</literal> (12月))
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_year" - 1900 年からの年数
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_wday" - 曜日 (<literal>0</literal> (日曜日) から <literal>6</literal> (土曜日))
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_yday" - 年単位の日付 (<literal>0</literal> から <literal>365</literal>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_isdst" - 夏時間の適用中かどうか
     </simpara>
     <simpara>
      適用中なら正の数、そうでなければ <literal>0</literal>、不明なら負の数。
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
   
   &date.timezone.errors.description;
 
 </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>time</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$localtime = localtime();
$localtime_assoc = localtime(time(), true);
print_r($localtime);
print_r($localtime_assoc);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [0] => 24
    [1] => 3
    [2] => 19
    [3] => 3
    [4] => 3
    [5] => 105
    [6] => 0
    [7] => 92
    [8] => 1
)

Array
(
    [tm_sec] => 24
    [tm_min] => 3
    [tm_hour] => 19
    [tm_mday] => 3
    [tm_mon] => 3
    [tm_year] => 105
    [tm_wday] => 0
    [tm_yday] => 92
    [tm_isdst] => 1
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>getdate</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
-->