<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="dateinterval.createfromdatestring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>DateInterval::createFromDateString</refname>

<refpurpose>相対指定文字列から DateInterval を作成する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<para>&style.oop;</para>

<methodsynopsis role="DateInterval">

<modifier>public</modifier> <modifier>static</modifier> <type>DateInterval</type><methodname>DateInterval::createFromDateString</methodname>

<methodparam><type>string</type><parameter>datetime</parameter></methodparam>

</methodsynopsis>

<para>&style.procedural;</para>

<methodsynopsis>

<type class="union"><type>DateInterval</type><type>false</type></type><methodname>date_interval_create_from_date_string</methodname>

<methodparam><type>string</type><parameter>datetime</parameter></methodparam>

</methodsynopsis>

<para>

<classname>DateTimeImmutable</classname>

のコンストラクタで使われている日付パーサーを用いて、パースされた相対指定文字列から

<classname>DateInterval</classname> を作成します。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>datetime</parameter></term>

<listitem>

<para>

相対部分を含む日付。

特に、<function>strtotime</function> や

<classname>DateTimeImmutable</classname>、

<classname>DateTime</classname> が使うパーサーがサポートする

<link linkend="datetime.formats.relative">相対書式</link>

を使って DateInterval を作ることができます。

</para>

<para>

<literal>P7D</literal> のような ISO-8601

フォーマットの文字列を使うには、

<methodname>DateInterval::__construct</methodname>

を使わなければいけません。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

<classname>DateInterval</classname> のインスタンスを返します。

&return.falseforfailure.style.procedural;

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

オブジェクト指向のAPIのみ、

無効な日付/時刻の文字列が渡された場合に

<exceptionname>DateMalformedStringException</exceptionname>

がスローされます。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.3.0</entry>

<entry>

無効な文字列が渡された場合、

<methodname>DateInterval::createFromDateString</methodname>

は <exceptionname>DateMalformedStringException</exceptionname>

をスローするようになりました。

これより前のバージョンでは、

警告が発生して <literal>false</literal> を返していました。

<function>date_interval_create_from_date_string</function>

は変更されていません。

</entry>

</row>

<row>

<entry>8.2.0</entry>

<entry>

このメソッドを使って

<classname>DateInterval</classname> を作った場合、

アクセス可能なプロパティは

<literal>from_string</literal> と

<literal>date_string</literal> だけになりました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>日付の間隔のパース</title>

<programlisting role="php" annotations="non-interactive">

</programlisting>

</example>

</para>

<para>

<example>

<title>パース処理の組み合わせと、負の間隔</title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

<para>

<example>

<title>特別な相対書式の間隔をパースする</title>

<programlisting role="php">

</programlisting>

&example.outputs.82;

<screen role="php">

</screen>

&example.outputs.8.similar;

<screen role="php">

</screen>

</example>

</para>

</refsect1>

</refentry>