date-add and date-sub (with thanks to Andy J Belamy)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@263784 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Richard Quadling 2008-07-29 16:15:27 +00:00
parent ea8ba4228d
commit 85f148bd0a
2 changed files with 293 additions and 0 deletions

View file

@ -0,0 +1,146 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.date-add" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>date_add</refname>
<refpurpose>
Adds an amount of days, months, years, hours, minutes and seconds to a
DateTime object
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>date_add</methodname>
<methodparam>
<type>DateTime</type>
<parameter>object</parameter>
</methodparam>
<methodparam>
<type>DateInterval</type>
<parameter>object</parameter>
</methodparam>
</methodsynopsis>
<para>
Adds the specified DateInterval object to the specified DateTime object.
</para>
<note>
<para>
Works in PHP 5.3+ ONLY
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>object</parameter>
</term>
<listitem>
<para>
A date as returned by <function>DateTime</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>object</parameter>
</term>
<listitem>
<para>
The amount to be added. For the date use "P3D", "P3M", "P3Y" or a
combination of the three e.g. "P2M5D" (Y = Years, M = Months, D = Days.)
MUST BE YEAR MONTH DAY FORMAT "P5Y", "P5M2D", "P5Y4D". For the time use
"T3H", "T3M", "T3S" or or a combination of the three e.g. "T5H20M" (H =
Hours, M = Minutes, S = Seconds). For dateTime us "P5D2M4YT5H20M". The
digit before the letter (NOT P or T) can be any amount.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>date_add</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$date = new DateTime("18-July-2008 16:30:30");
echo $date->format("d-m-Y H:i:s").'<br />';
date_add($date, new DateInterval("P5D"));
echo '<br />'.$date->format("d-m-Y").' : 5 Days';
date_add($date, new DateInterval("P5M"));
echo '<br />'.$date->format("d-m-Y").' : 5 Months';
date_add($date, new DateInterval("P5Y"));
echo '<br />'.$date->format("d-m-Y").' : 5 Years';
date_add($date, new DateInterval("P5Y5M5D"));
echo '<br />'.$date->format("d-m-Y").' : 5 Days, 5 Months, 5 Years';
date_add($date, new DateInterval("P5YT5H"));
echo '<br />'.$date->format("d-m-Y H:i:s").' : 5 Years, 5 Hours';
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>date_sub</function></member>
<member><function>date_diff</function></member>
</simplelist>
</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:"../../../../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
-->

View file

@ -0,0 +1,147 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.date-sub" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>date_sub</refname>
<refpurpose>
Subtracts an amount of days, months, years, hours, minutes and seconds from
a DateTime object
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>date_sub</methodname>
<methodparam>
<type>DateTime</type>
<parameter>object</parameter>
</methodparam>
<methodparam>
<type>DateInterval</type>
<parameter>object</parameter>
</methodparam>
</methodsynopsis>
<para>
Subtracts the specified DateInterval object from the specified DateTime
object.
</para>
<note>
<para>
Works in PHP 5.3+ ONLY
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>object</parameter>
</term>
<listitem>
<para>
A date as returned by <function>DateTime</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>object</parameter>
</term>
<listitem>
<para>
The amount to be subtracted. For the date use "P3D", "P3M", "P3Y" or a
combination of the three e.g. "P2M5D" (Y = Years, M = Months, D = Days.)
MUST BE YEAR MONTH DAY FORMAT "P5Y", "P5M2D", "P5Y4D". For the time use
"T3H", "T3M", "T3S" or or a combination of the three e.g. "T5H20M" (H =
Hours, M = Minutes, S = Seconds). For dateTime us "P5D2M4YT5H20M". The
digit before the letter (NOT P or T) can be any amount.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>date_sub</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$date = new DateTime("18-July-2008 16:30:30");
echo $date->format("d-m-Y H:i:s").'<br />';
date_sub($date, new DateInterval("P5D"));
echo '<br />'.$date->format("d-m-Y").' : 5 Days';
date_sub($date, new DateInterval("P5M"));
echo '<br />'.$date->format("d-m-Y").' : 5 Months';
date_sub($date, new DateInterval("P5Y"));
echo '<br />'.$date->format("d-m-Y").' : 5 Years';
date_sub($date, new DateInterval("P5Y5M5D"));
echo '<br />'.$date->format("d-m-Y").' : 5 Days, 5 Months, 5 Years';
date_sub($date, new DateInterval("P5YT5H"));
echo '<br />'.$date->format("d-m-Y H:i:s").' : 5 Years, 5 Hours';
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>date_add</function></member>
<member><function>date_diff</function></member>
</simplelist>
</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:"../../../../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
-->