mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 15:12:22 +01:00
0a15f1bb57
Closes #310 Co-authored-by: KentarouTakeda <4785040+KentarouTakeda@users.noreply.github.com>
299 lines
7.3 KiB
XML
299 lines
7.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: takagi Status: ready -->
|
|
<!-- Credits: mumumu -->
|
|
|
|
<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">
|
|
<![CDATA[
|
|
<?php
|
|
// セットになっているふたつは、それぞれ同じ間隔を表します。
|
|
$i = new DateInterval('P1D');
|
|
$i = DateInterval::createFromDateString('1 day');
|
|
|
|
$i = new DateInterval('P2W');
|
|
$i = DateInterval::createFromDateString('2 weeks');
|
|
|
|
$i = new DateInterval('P3M');
|
|
$i = DateInterval::createFromDateString('3 months');
|
|
|
|
$i = new DateInterval('P4Y');
|
|
$i = DateInterval::createFromDateString('4 years');
|
|
|
|
$i = new DateInterval('P1Y1D');
|
|
$i = DateInterval::createFromDateString('1 year + 1 day');
|
|
|
|
$i = new DateInterval('P1DT12H');
|
|
$i = DateInterval::createFromDateString('1 day + 12 hours');
|
|
|
|
$i = new DateInterval('PT3600S');
|
|
$i = DateInterval::createFromDateString('3600 seconds');
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>パース処理の組み合わせと、負の間隔</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$i = DateInterval::createFromDateString('62 weeks + 1 day + 2 weeks + 2 hours + 70 minutes');
|
|
echo $i->format('%d %h %i'), "\n";
|
|
|
|
$i = DateInterval::createFromDateString('1 year - 10 days');
|
|
echo $i->format('%y %d'), "\n";
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
449 2 70
|
|
1 -10
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>特別な相対書式の間隔をパースする</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$i = DateInterval::createFromDateString('last day of next month');
|
|
var_dump($i);
|
|
|
|
$i = DateInterval::createFromDateString('last weekday');
|
|
var_dump($i);
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.82;
|
|
<screen role="php">
|
|
<![CDATA[
|
|
object(DateInterval)#1 (2) {
|
|
["from_string"]=>
|
|
bool(true)
|
|
["date_string"]=>
|
|
string(22) "last day of next month"
|
|
}
|
|
object(DateInterval)#2 (2) {
|
|
["from_string"]=>
|
|
bool(true)
|
|
["date_string"]=>
|
|
string(12) "last weekday"
|
|
}
|
|
]]>
|
|
</screen>
|
|
&example.outputs.8.similar;
|
|
<screen role="php">
|
|
<![CDATA[
|
|
object(DateInterval)#1 (16) {
|
|
["y"]=>
|
|
int(0)
|
|
["m"]=>
|
|
int(1)
|
|
["d"]=>
|
|
int(0)
|
|
["h"]=>
|
|
int(0)
|
|
["i"]=>
|
|
int(0)
|
|
["s"]=>
|
|
int(0)
|
|
["f"]=>
|
|
float(0)
|
|
["weekday"]=>
|
|
int(0)
|
|
["weekday_behavior"]=>
|
|
int(0)
|
|
["first_last_day_of"]=>
|
|
int(2)
|
|
["invert"]=>
|
|
int(0)
|
|
["days"]=>
|
|
bool(false)
|
|
["special_type"]=>
|
|
int(0)
|
|
["special_amount"]=>
|
|
int(0)
|
|
["have_weekday_relative"]=>
|
|
int(0)
|
|
["have_special_relative"]=>
|
|
int(0)
|
|
}
|
|
object(DateInterval)#2 (16) {
|
|
["y"]=>
|
|
int(0)
|
|
["m"]=>
|
|
int(0)
|
|
["d"]=>
|
|
int(0)
|
|
["h"]=>
|
|
int(0)
|
|
["i"]=>
|
|
int(0)
|
|
["s"]=>
|
|
int(0)
|
|
["f"]=>
|
|
float(0)
|
|
["weekday"]=>
|
|
int(0)
|
|
["weekday_behavior"]=>
|
|
int(0)
|
|
["first_last_day_of"]=>
|
|
int(0)
|
|
["invert"]=>
|
|
int(0)
|
|
["days"]=>
|
|
bool(false)
|
|
["special_type"]=>
|
|
int(1)
|
|
["special_amount"]=>
|
|
int(-1)
|
|
["have_weekday_relative"]=>
|
|
int(0)
|
|
["have_special_relative"]=>
|
|
int(1)
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|