<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<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></methodpa
ram>
   <methodparam><type>DateInterval</type><parameter>object</parameter></meth
odparam>
  </methodsynopsis>
  <para>
   Subtracts the specified DateInterval object from the specified DateTime
object.
  </para>
 </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. "P5D2M" (D = Days, M = Months, Y = Years).
	   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('P5D5M5Y'));
echo '<br />'.$date->format("d-m-Y").' : 5Days, 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_dif</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
-->
