date-parse.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 50dcf55ce543220dd8375df2fdb4f7db702b9c9f Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.date-parse" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>date_parse</refname>
  <refpurpose>指定した日付/時刻の詳細な情報を連想配列で返す</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>date_parse</methodname>
   <methodparam><type>string</type><parameter>datetime</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>date_parse</function> は、
   <function>strtotime</function> や
   <function>DateTimeImmutable::__construct</function>
   と同じルールに従って
   <parameter>datetime</parameter> をパースします。
   Unixタイムスタンプ (<function>strtotime</function> の場合)
   や <classname>DateTimeImmutable</classname>
   (<function>DateTimeImmutable::__construct</function> の場合)
   を返す代わりに、指定した <parameter>datetime</parameter>
   から検知できた情報を連想配列として返します。
  </para>
  <para>
   あるグループの要素に関する情報が見つからなかった場合、
   そうした情報は &false; に設定されたり、存在しない状態になります。
   <parameter>datetime</parameter> に指定する文字列から、
   同等のタイムスタンプや <classname>DateTimeImmutable</classname>
   オブジェクトを構築する必要がある場合、
   より多くのフィールドを &false; でない値に設定できます。
   そうしたことが起こる場合については、
   以下に示す例を参照ください。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>datetime</parameter></term>
     <listitem>
      <para>
       <function>DateTimeImmutable::__construct</function> が理解できる書式の日付/時刻。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   パースした日付/時刻情報を含む配列を返します。
  </para>
  <para>
   返される配列は、
   <literal>year</literal>,
   <literal>month</literal>, <literal>day</literal>, <literal>hour</literal>,
   <literal>minute</literal>, <literal>second</literal>,
   <literal>fraction</literal>,
   <literal>is_localtime</literal> というキーを持ちます。
  </para>
  <para>
   <literal>is_localtime</literal> が存在する場合、
   <literal>zone_type</literal> がタイムゾーンのタイプを示します。
   タイプ <literal>1</literal> (UTC オフセット) の場合、
   <literal>zone</literal> と <literal>is_dst</literal>
   フィールドが追加されます。
   タイプ <literal>2</literal> (省略形) の場合、
   <literal>tz_abbr</literal> と <literal>is_dst</literal>
   フィールドが追加されます。
   タイプ <literal>3</literal> (タイムゾーン識別子) の場合、
   <literal>tz_abbr</literal>, <literal>tz_id</literal> が追加されます。
  </para>
  <para>
   <literal>+3 days</literal> のような、
   相対時刻の文字列が <parameter>datetime</parameter>
   に存在する場合、返される配列には、<literal>relative</literal> をキーとしたネストされた配列が含まれます。
   この配列には、<literal>year</literal>, <literal>month</literal>,
   <literal>day</literal>,
   <literal>hour</literal>, <literal>minute</literal>,
   <literal>second</literal> が含まれ、
   渡される文字列に応じて、必要があれば
   <literal>weekday</literal>, <literal>weekdays</literal> も含まれます。
  </para>
  <para>
   <literal>warning_count</literal> と <literal>warnings</literal>
   が配列に含まれます。
   最初のフィールドは、警告が何個発生したかを示します。
   <literal>warnings</literal> 配列は、
   警告を説明する文字列と一緒に、指定された <parameter>datetime</parameter>
   のどの場所で警告が発生したかの位置を示します。
  </para>
  <para>
   <literal>error_count</literal>,
   <literal>errors</literal> フィールドも配列に含まれます。
   最初のフィールドは、エラーが何個発生したかを示します。
   <literal>errors</literal> 配列は、
   警告を説明する文字列と一緒に、指定された <parameter>datetime</parameter>
   のどの場所でエラーが発生したかの位置を示します。
  </para>
  <warning>
   <para>
    <literal>warnings</literal> と
    <literal>errors</literal> に含まれる配列の要素数は、
    同じ箇所でエラーや警告が発生した場合、
    <literal>warning_count</literal> や <literal>error_count</literal>
    よりも少なくなる可能性があります。
   </para>
  </warning>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   日付/時刻フォーマットにエラーがある場合は、
   'errors' 要素にエラーメッセージが格納されます。
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.2.0</entry>
      <entry>
       返される配列の <literal>zone</literal> 要素が、
       分ではなく秒を表すようになり、
       符号が逆になりました。
       たとえば、
       <literal>-120</literal> は <literal>7200</literal> を表すようになります。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><parameter>datetime</parameter> に包括的な情報を指定した <function>date_parse</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(date_parse("2006-12-12 10:00:00.5"));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(12) {
  ["year"]=>
  int(2006)
  ["month"]=>
  int(12)
  ["day"]=>
  int(12)
  ["hour"]=>
  int(10)
  ["minute"]=>
  int(0)
  ["second"]=>
  int(0)
  ["fraction"]=>
  float(0.5)
  ["warning_count"]=>
  int(0)
  ["warnings"]=>
  array(0) {
  }
  ["error_count"]=>
  int(0)
  ["errors"]=>
  array(0) {
  }
  ["is_localtime"]=>
  bool(false)
}
]]>
    </screen>
   </example>
  </para>

  <para>
   指定された <parameter>datetime</parameter>
   にタイムゾーン情報が含まれた場合にのみ、
   タイムゾーンの要素が現れるようになります。
   この場合、<literal>zone_type</literal> 要素が常に存在し、
   値によっては少し多くの要素が含まれます。
   <example>
    <title>タイムゾーンの省略形を与えた場合の <function>date_parse</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(date_parse("June 2nd, 2022, 10:28:17 BST"));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(16) {
  ["year"]=>
  int(2022)
  ["month"]=>
  int(6)
  ["day"]=>
  int(2)
  ["hour"]=>
  int(10)
  ["minute"]=>
  int(28)
  ["second"]=>
  int(17)
  ["fraction"]=>
  float(0)
  ["warning_count"]=>
  int(0)
  ["warnings"]=>
  array(0) {
  }
  ["error_count"]=>
  int(0)
  ["errors"]=>
  array(0) {
  }
  ["is_localtime"]=>
  bool(true)
  ["zone_type"]=>
  int(2)
  ["zone"]=>
  int(0)
  ["is_dst"]=>
  bool(true)
  ["tz_abbr"]=>
  string(3) "BST"
}
]]>
    </screen>
   </example>
   <example>
    <title>タイムゾーン情報を与えた <function>date_parse</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(date_parse("June 2nd, 2022, 10:28:17 Europe/London"));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(14) {
  ["year"]=>
  int(2022)
  ["month"]=>
  int(6)
  ["day"]=>
  int(2)
  ["hour"]=>
  int(10)
  ["minute"]=>
  int(28)
  ["second"]=>
  int(17)
  ["fraction"]=>
  float(0)
  ["warning_count"]=>
  int(0)
  ["warnings"]=>
  array(0) {
  }
  ["error_count"]=>
  int(0)
  ["errors"]=>
  array(0) {
  }
  ["is_localtime"]=>
  bool(true)
  ["zone_type"]=>
  int(3)
  ["tz_id"]=>
  string(13) "Europe/London"
}
]]>
    </screen>
   </example>
  </para>

  <para>
   さらに最低限の文字列を <parameter>datetime</parameter>
   に与えてパースさせた場合、
   情報量はさらに少なくなります。以下の例では、
   全ての時刻に関する情報が &false; になります。
   <example>
    <title>最低限の文字列だけを与えた <function>date_parse</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(date_parse("June 2nd, 2022"));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(12) {
  ["year"]=>
  int(2022)
  ["month"]=>
  int(6)
  ["day"]=>
  int(2)
  ["hour"]=>
  bool(false)
  ["minute"]=>
  bool(false)
  ["second"]=>
  bool(false)
  ["fraction"]=>
  bool(false)
  ["warning_count"]=>
  int(0)
  ["warnings"]=>
  array(0) {
  }
  ["error_count"]=>
  int(0)
  ["errors"]=>
  array(0) {
  }
  ["is_localtime"]=>
  bool(false)
}
]]>
    </screen>
   </example>
  </para>

  <para>
    <link linkend="datetime.formats.relative">相対的な書式</link> は
    絶対的な書式のパース結果に影響を及ぼさず、別途
    "relative" 要素にまとめられます。
   <example>
    <title>"relative" フォーマットを使った <function>date_parse</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(date_parse("2006-12-12 10:00:00.5 +1 week +1 hour"));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(13) {
  ["year"]=>
  int(2006)
  ["month"]=>
  int(12)
  ["day"]=>
  int(12)
  ["hour"]=>
  int(10)
  ["minute"]=>
  int(0)
  ["second"]=>
  int(0)
  ["fraction"]=>
  float(0.5)
  ["warning_count"]=>
  int(0)
  ["warnings"]=>
  array(0) {
  }
  ["error_count"]=>
  int(0)
  ["errors"]=>
  array(0) {
  }
  ["is_localtime"]=>
  bool(false)
  ["relative"]=>
  array(6) {
    ["year"]=>
    int(0)
    ["month"]=>
    int(0)
    ["day"]=>
    int(7)
    ["hour"]=>
    int(1)
    ["minute"]=>
    int(0)
    ["second"]=>
    int(0)
  }
}
]]>
    </screen>
   </example>
  </para>

  <para>
   <literal>Thursday</literal> のように、
   語句によっては、文字列の時刻の部分に <literal>0</literal>
   を設定するものがあります。
   <literal>Thursday</literal> を
   <function>DateTimeImmutable::__construct</function>
   に与えた場合、hour, minute, second は
   <literal>0</literal> に設定されます。
   以下の例では、year の要素は &false; に設定されます。
   <example>
    <title><function>date_parse</function> の副作用</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(date_parse("Thursday, June 2nd"));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(13) {
  ["year"]=>
  bool(false)
  ["month"]=>
  int(6)
  ["day"]=>
  int(2)
  ["hour"]=>
  int(0)
  ["minute"]=>
  int(0)
  ["second"]=>
  int(0)
  ["fraction"]=>
  float(0)
  ["warning_count"]=>
  int(0)
  ["warnings"]=>
  array(0) {
  }
  ["error_count"]=>
  int(0)
  ["errors"]=>
  array(0) {
  }
  ["is_localtime"]=>
  bool(false)
  ["relative"]=>
  array(7) {
    ["year"]=>
    int(0)
    ["month"]=>
    int(0)
    ["day"]=>
    int(0)
    ["hour"]=>
    int(0)
    ["minute"]=>
    int(0)
    ["second"]=>
    int(0)
    ["weekday"]=>
    int(4)
  }
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>指定されたフォーマットに従って <parameter>datetime</parameter> をパースする <function>DateTimeImmutable::parseFromFormat</function></member>
    <member><function>checkdate</function></member>
    <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
-->