mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 23:38:56 +00:00
d8fc668de6
provide a set of examples of the sort of format DateInterval::createFromDateString() expects. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@326736 c90b9560-bf6c-de11-be94-00142212c4b1
106 lines
2.8 KiB
XML
106 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Sets up a DateInterval from the relative parts of the string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="oop">
|
|
<modifier>public</modifier> <modifier>static</modifier> <type>DateInterval</type><methodname>DateInterval::createFromDateString</methodname>
|
|
<methodparam><type>string</type><parameter>time</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Uses the normal date parsers and sets up a DateInterval from the relative
|
|
parts of the parsed string.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>time</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A date with relative parts. Specifically, the
|
|
<link linkend="datetime.formats.relative">relative formats</link>
|
|
supported by the parser used for <function>strtotime</function> and
|
|
<classname>DateTime</classname> will be used to construct the
|
|
DateInterval.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Parsing valid date intervals</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Each set of intervals is equal.
|
|
$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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a new <classname>DateInterval</classname> instance.
|
|
</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
|
|
-->
|