mirror of
https://github.com/php/doc-en.git
synced 2026-03-27 01:02:08 +01:00
91 lines
2.5 KiB
XML
91 lines
2.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="datetime.sub" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>DateTime::sub</refname>
|
|
<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;
|
|
<para>&style.oop;</para>
|
|
<methodsynopsis role="DateTime">
|
|
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::sub</methodname>
|
|
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>&style.procedural;</para>
|
|
<methodsynopsis>
|
|
<type>DateTime</type><methodname>date_sub</methodname>
|
|
<methodparam><type>DateTime</type><parameter>object</parameter></methodparam>
|
|
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Modifies the specified DateTime object, by subtracting the specified
|
|
<classname>DateInterval</classname> object.
|
|
</para>
|
|
<para>
|
|
Like <methodname>DateTimeImmutable::sub</methodname> but works with
|
|
<classname>DateTime</classname>.
|
|
</para>
|
|
<para>
|
|
The procedural version takes the <classname>DateTime</classname> object as
|
|
its first argument.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
&date.datetime.description.modified;
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>interval</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
A <classname>DateInterval</classname> object
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&date.datetime.return.modifiedobject;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>DateTimeImmutable::sub</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|