<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.dateinterval.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'zh',
),
'this' =>
array (
0 => 'dateinterval.createfromdatestring.php',
1 => 'DateInterval::createFromDateString',
2 => 'Sets up a DateInterval from the relative parts of the string',
),
'up' =>
array (
0 => 'class.dateinterval.php',
1 => 'DateInterval',
),
'prev' =>
array (
0 => 'dateinterval.construct.php',
1 => 'DateInterval::__construct',
),
'next' =>
array (
0 => 'dateinterval.format.php',
1 => 'DateInterval::format',
),
'alternatives' =>
array (
),
'source' =>
array (
'lang' => 'en',
'path' => 'reference/datetime/dateinterval/createfromdatestring.xml',
),
'history' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);
contributors($setup);
?>
<div id="dateinterval.createfromdatestring" class="refentry">
<div class="refnamediv">
<h1 class="refname">DateInterval::createFromDateString</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">DateInterval::createFromDateString</span> — <span class="dc-title">Sets up a DateInterval from the relative parts of the string</span></p>
</div>
<div class="refsect1 description" id="refsect1-dateinterval.createfromdatestring-description">
<h3 class="title">说明</h3>
<p class="para">面向对象风格</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><strong>DateInterval::createFromDateString</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$datetime</code></span>): <span class="type"><a href="class.dateinterval.php" class="type DateInterval">DateInterval</a></span></div>
<p class="para rdfs-comment">过程化风格</p>
<div class="methodsynopsis dc-description"><span class="methodname"><a href="function.date-interval-create-from-date-string.php" class="methodname">date_interval_create_from_date_string</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$datetime</code></span>): <span class="type"><span class="type"><a href="class.dateinterval.php" class="type DateInterval">DateInterval</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<p class="para rdfs-comment">
Uses the date/time parsers as used in the
<span class="classname"><a href="class.datetimeimmutable.php" class="classname">DateTimeImmutable</a></span> constructor to create a
<span class="classname"><a href="class.dateinterval.php" class="classname">DateInterval</a></span> from the relative parts of the parsed
string.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-dateinterval.createfromdatestring-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt><code class="parameter">datetime</code></dt>
<dd>
<p class="para">
A date with relative parts. Specifically, the <a href="datetime.formats.php#datetime.formats.relative" class="link">relative formats</a> supported
by the parser used for <span class="classname"><a href="class.datetimeimmutable.php" class="classname">DateTimeImmutable</a></span>,
<span class="classname"><a href="class.datetime.php" class="classname">DateTime</a></span>, and <span class="function"><a href="function.strtotime.php" class="function">strtotime()</a></span>
will be used to construct the DateInterval.
</p>
<p class="para">
To use an ISO-8601 format string like <code class="literal">P7D</code>, you must
use the <span class="methodname"><a href="dateinterval.construct.php" class="methodname">DateInterval::__construct()</a></span>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-dateinterval.createfromdatestring-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
Returns <span class="classname"><a href="class.dateinterval.php" class="classname">DateInterval</a></span> on success.
过程化风格在失败时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
</p>
</div>
<div class="refsect1 errors" id="refsect1-dateinterval.createfromdatestring-errors">
<h3 class="title">错误／异常</h3>
<p class="para">
Object Oriented API only: If an invalid Date/Time string is passed,
<span class="exceptionname"><a href="class.datemalformedstringexception.php" class="exceptionname">DateMalformedStringException</a></span> is thrown.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-dateinterval.createfromdatestring-changelog">
<h3 class="title">更新日志</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>版本</th>
<th>说明</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>8.3.0</td>
<td>
<span class="methodname"><strong>DateInterval::createFromDateString()</strong></span> now throws
<span class="exceptionname"><a href="class.datemalformedstringexception.php" class="exceptionname">DateMalformedStringException</a></span> if an
invalid string is passed. Previously, it returned <code class="literal">false</code>,
and a warning was emitted.
<span class="function"><a href="function.date-interval-create-from-date-string.php" class="function">date_interval_create_from_date_string()</a></span> has not been
changed.
</td>
</tr>
<tr>
<td>8.2.0</td>
<td>
Only the <code class="literal">from_string</code> and
<code class="literal">date_string</code> properties will be visible when a
<span class="classname"><a href="class.dateinterval.php" class="classname">DateInterval</a></span> is created with this method.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 examples" id="refsect1-dateinterval.createfromdatestring-examples">
<h3 class="title">示例</h3>
<p class="para">
<div class="example" id="example-2227">
<p><strong>示例 #1 Parsing valid date intervals</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Each set of intervals is equal.<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'P1D'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'1 day'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'P2W'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'2 weeks'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'P3M'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'3 months'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'P4Y'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'4 years'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'P1Y1D'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'1 year + 1 day'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'P1DT12H'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'1 day + 12 hours'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'PT3600S'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'3600 seconds'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span></span></code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-2228">
<p><strong>示例 #2 Parsing combinations and negative intervals</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br />$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'62 weeks + 1 day + 2 weeks + 2 hours + 70 minutes'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$i</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #DD0000">'%d %h %i'</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'1 year - 10 days'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$i</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #DD0000">'%y %d'</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span></span></code></div>
</div>
<div class="example-contents"><p>以上示例会输出：</p></div>
<div class="example-contents screen"><br />
449 2 70<br />
1 -10<br />
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-2229">
<p><strong>示例 #3 Parsing special relative date intervals</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br />$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'last day of next month'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromDateString</span><span style="color: #007700">(</span><span style="color: #DD0000">'last weekday'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$i</span><span style="color: #007700">);</span></span></code></div>
</div>
<div class="example-contents"><p>以上示例在 PHP 8.2 中的输出：</p></div>
<div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">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"
}</pre>
</div>
</div>
<div class="example-contents"><p>以上示例在 PHP 8 中的输出类似于：</p></div>
<div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">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)
}</pre>
</div>
</div>
</div>
</p>
</div>
</div><?php manual_footer($setup); ?>