dateinterval.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9154789dfc9cb8aa5df644bfba5e86c2deba4cb8 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<reference xml:id="class.dateinterval" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>DateInterval クラス</title>
 <titleabbrev>DateInterval</titleabbrev>

 <partintro>

<!-- {{{ DateInterval intro -->
  <section xml:id="dateinterval.intro">
   &reftitle.intro;
   <para>
    日付の間隔をあらわします。
   </para>
   <para>
    格納方式は、固定値 (年、月、日、時など)
    あるいは相対時刻 (<classname>DateTimeImmutable</classname> と
    <classname>DateTime</classname> のコンストラクタがサポートしている書式)
    となります。
   </para>
   <para>
    さらに厳密に言うと、
    <classname>DateInterval</classname> オブジェクトが保持している情報は、
    ある date/time オブジェクトから別の date/time オブジェクトに情報を移す手順です。
    この過程は必ずしも可逆ではありません。
   </para>
   <para>
    <classname>DateInterval</classname> オブジェクトを生成する一般的なやり方は、
    2つの date/time オブジェクトの差分を
    <methodname>DateTimeInterface::diff</methodname> 経由で計算することです。
   </para>
   <para>
    日付の間隔を比較する良い方法は定義されていません。
    よって、<classname>DateInterval</classname>
    のインスタンスは
    <link linkend="language.operators.comparison.incomparable">比較できません</link>。
   </para>
  </section>
<!-- }}} -->

  <section xml:id="dateinterval.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>DateInterval</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="dateinterval.props.y">y</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="dateinterval.props.m">m</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="dateinterval.props.d">d</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="dateinterval.props.h">h</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="dateinterval.props.i">i</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="dateinterval.props.s">s</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>float</type>
     <varname linkend="dateinterval.props.f">f</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="dateinterval.props.invert">invert</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>mixed</type>
     <varname linkend="dateinterval.props.days">days</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="dateinterval.props.from-string">from_string</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="dateinterval.props.date-string">date_string</varname>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateinterval')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='DateInterval'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateinterval')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DateInterval'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>
  
  <section xml:id="dateinterval.props">
   &reftitle.properties;
   <warning>
    <para>
     以下に示すプロパティが使えるかどうかは、
     PHP のバージョンに依存します。
     そして、<emphasis>readonly</emphasis> と見なすべきです。
    </para>
   </warning>
   <variablelist>
    <varlistentry xml:id="dateinterval.props.y">
     <term><varname>y</varname></term>
     <listitem>
      <para>
       年。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.m">
     <term><varname>m</varname></term>
     <listitem>
      <para>
       月。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.d">
     <term><varname>d</varname></term>
     <listitem>
      <para>
       日。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.h">
     <term><varname>h</varname></term>
     <listitem>
      <para>
       時間。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.i">
     <term><varname>i</varname></term>
     <listitem>
      <para>
       分。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.s">
     <term><varname>s</varname></term>
     <listitem>
      <para>
       秒。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.f">
     <term><varname>f</varname></term>
     <listitem>
      <para>
       マイクロ秒。1秒の100万分の1です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.invert">
     <term><varname>invert</varname></term>
     <listitem>
      <para>
       間隔が負の数になっている場合は <literal>1</literal>、そうでない場合は
       <literal>0</literal>。
       <methodname>DateInterval::format</methodname> を参照ください。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.days">
     <term><varname>days</varname></term>
     <listitem>
      <para>
       <methodname>DateTimeImmutable::diff</methodname> や
       <methodname>DateTime::diff</methodname> で作られた DateInterval
       オブジェクトの場合は、開始日と終了日の間の(丸一日、つまり0時から24時までの一日全体という意味での)日の数。
       それ以外の場合は <varname>days</varname> は &false; となります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.from-string">
     <term><varname>from_string</varname></term>
     <listitem>
      <para>
       <methodname>DateInterval::createFromDateString</methodname>
       で作られた DateInterval オブジェクトの場合は、
       このプロパティの値は &true; になり、
       <varname>date_string</varname> の値が収集されます。
       そうでない場合、この値は &false; になり、
       <varname>y</varname>,
       <varname>f</varname>, <varname>invert</varname>,
       <varname>days</varname> の値が収集されます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateinterval.props.date-string">
     <term><varname>date_string</varname></term>
     <listitem>
      <para>
       <methodname>DateInterval::createFromDateString</methodname>
       の引数として使われる文字列。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>

  <section role="changelog" xml:id="dateinterval.changelog"><!-- {{{ -->
   &reftitle.changelog;
   <para>
    <informaltable>
     <tgroup cols="2">
      <thead>
       <row>
        <entry>&Version;</entry>
        <entry>&Description;</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>8.2.0</entry>
        <entry>
         <methodname>DateInterval::createFromDateString</methodname> 
         で作られた <classname>DateInterval</classname>
         のインスタンスのために、
         プロパティ <varname>from_string</varname> と
         <varname>date_string</varname> が追加されました。
        </entry>
       </row>
       <row>
        <entry>8.2.0</entry>
        <entry>
         プロパティ <literal>y</literal> から <literal>f</literal>,
         <literal>invert</literal>, <literal>days</literal>
         のみがアクセス可能になりました。
        </entry>
       </row>
       <row>
        <entry>7.4.0</entry>
        <entry>
         <classname>DateInterval</classname> インスタンスは、
         比較できなくなりました。
         これより前のバージョンでは、
         全ての <classname>DateInterval</classname>
         のインスタンスが等しいとみなされていました。
        </entry>
       </row>
       <row>
        <entry>7.1.0</entry>
        <entry><varname>f</varname> プロパティが追加されました</entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </para>
  </section><!-- }}} -->

 </partintro>

 &reference.datetime.entities.dateinterval;

</reference>
<!-- 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
-->