Document PHP 5.5 date classes

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330266 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2013-05-17 06:06:10 +00:00
parent ae00354249
commit f65a959cff
26 changed files with 812 additions and 32 deletions

View file

@ -1234,6 +1234,11 @@ String dereferencing: P
<classname>DateTimeImmutable</classname>
</simpara>
</listitem>
<listitem>
<simpara>
<classname>DateTimeInterface</classname>
</simpara>
</listitem>
</itemizedlist>
</sect2>

View file

@ -44,6 +44,8 @@
&reference.datetime.constants;
&reference.datetime.datetime;
&reference.datetime.datetimeimmutable;
&reference.datetime.datetimeinterface;
&reference.datetime.datetimezone;
&reference.datetime.dateinterval;
&reference.datetime.dateperiod;

View file

@ -29,6 +29,9 @@
<ooclass>
<classname>DateTime</classname>
</ooclass>
<oointerface>
<interfacename>DateTimeInterface</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
@ -111,6 +114,9 @@
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetime')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimeinterface')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
@ -248,6 +254,12 @@
</row>
</thead>
<tbody>
<row>
<entry>5.5.0</entry>
<entry>
The class now implements <classname>DateTimeInterface</classname>.
</entry>
</row>
<row>
<entry>5.2.2</entry>
<entry>

View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.datetimeimmutable" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DateTimeImmutable class</title>
<titleabbrev>DateTimeImmutable</titleabbrev>
<partintro>
<!-- {{{ DateTimeImmutable intro -->
<section xml:id="datetimeimmutable.intro">
&reftitle.intro;
<para>
This class behaves the same as <classname>DateTime</classname> except it
never modifies itself but returns a new object instead.
</para>
</section>
<!-- }}} -->
<section xml:id="datetimeimmutable.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DateTimeImmutable</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DateTimeImmutable</classname>
</ooclass>
<oointerface>
<interfacename>DateTimeInterface</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimeimmutable')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimeimmutable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimeinterface')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.datetime.entities.datetimeimmutable;
</phpdoc:classref>
<!-- 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
-->

View file

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::add</refname>
<refpurpose>
Adds an amount of days, months, years, hours, minutes and seconds
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::add</methodname>
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::add</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,52 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::__construct</refname>
<refname>date_create_immutable</refname>
<refpurpose>Returns new DateTimeImmutable object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<constructorsynopsis role="oop">
<modifier>public</modifier> <methodname>DateTimeImmutable::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>time</parameter><initializer>"now"</initializer></methodparam>
<methodparam choice="opt"><type>DateTimeZone</type><parameter>timezone</parameter><initializer>&null;</initializer></methodparam>
</constructorsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>DateTimeImmutable</type><methodname>date_create_immutable</methodname>
<methodparam choice="opt"><type>string</type><parameter>time</parameter><initializer>"now"</initializer></methodparam>
<methodparam choice="opt"><type>DateTimeZone</type><parameter>timezone</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::__construct</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.createfromformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::createFromFormat</refname>
<refname>date_create_immutable_from_format</refname>
<refpurpose>Returns new DateTimeImmutable object formatted according to the specified format</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::createFromFormat</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam><type>string</type><parameter>time</parameter></methodparam>
<methodparam choice="opt"><type>DateTimeZone</type><parameter>timezone</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>DateTimeImmutable</type><methodname>date_create_immutable_from_format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam><type>string</type><parameter>time</parameter></methodparam>
<methodparam choice="opt"><type>DateTimeZone</type><parameter>timezone</parameter></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::createFromFormat</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.getlasterrors" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::getLastErrors</refname>
<refpurpose>Returns the warnings and errors</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>DateTimeImmutable::getLastErrors</methodname>
<void />
</methodsynopsis>
<para>
Like <methodname>DateTime::getLastErrors</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.modify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::modify</refname>
<refpurpose>Alters the timestamp</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::modify</methodname>
<methodparam><type>string</type><parameter>modify</parameter></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::modify</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.set-state" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::__set_state</refname>
<refpurpose>The __set_state handler</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::__set_state</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::__set_state</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.setdate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::setDate</refname>
<refpurpose>Sets the date</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::setDate</methodname>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
<methodparam><type>int</type><parameter>month</parameter></methodparam>
<methodparam><type>int</type><parameter>day</parameter></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::setDate</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.setisodate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::setISODate</refname>
<refpurpose>Sets the ISO date</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::setISODate</methodname>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
<methodparam><type>int</type><parameter>week</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>day</parameter><initializer>1</initializer></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::setISODate</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.settime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::setTime</refname>
<refpurpose>Sets the time</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::setTime</methodname>
<methodparam><type>int</type><parameter>hour</parameter></methodparam>
<methodparam><type>int</type><parameter>minute</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::setTime</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.settimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::setTimestamp</refname>
<refpurpose>Sets the date and time based on an Unix timestamp</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::setTimestamp</methodname>
<methodparam><type>int</type><parameter>unixtimestamp</parameter></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::setTimestamp</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.settimezone" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::setTimezone</refname>
<refpurpose>Sets the time zone</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::setTimezone</methodname>
<methodparam><type>DateTimeZone</type><parameter>timezone</parameter></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::setTimezone</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.sub" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeImmutable::sub</refname>
<refpurpose>
Subtracts an amount of days, months, years, hours, minutes and seconds
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::sub</methodname>
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
</methodsynopsis>
<para>
Like <methodname>DateTime::sub</methodname> but works with
<classname>DateTimeImmutable</classname>.
</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
-->

View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.datetimeinterface" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DateTimeInterface interface</title>
<titleabbrev>DateTimeInterface</titleabbrev>
<partintro>
<!-- {{{ DateTimeInterface intro -->
<section xml:id="datetimeinterface.intro">
&reftitle.intro;
<para>
</para>
</section>
<!-- }}} -->
<section xml:id="datetimeinterface.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DateTimeInterface</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DateTimeInterface</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimeinterface')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.datetime.entities.datetimeinterface;
</phpdoc:classref>
<!-- 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
-->

View file

@ -3,7 +3,7 @@
<refentry xml:id="datetime.diff" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTime::diff</refname>
<refname>DateTimeInterface::diff</refname>
<refname>date_diff</refname>
<refpurpose>Returns the difference between two DateTime objects</refpurpose>
</refnamediv>
@ -12,19 +12,20 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateInterval</type><methodname>DateTime::diff</methodname>
<methodparam><type>DateTime</type><parameter>datetime2</parameter></methodparam>
<modifier>public</modifier> <type>DateInterval</type><methodname>DateTimeInterface::diff</methodname>
<methodparam><type>DateTimeInterface</type><parameter>datetime2</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>absolute</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>DateInterval</type><methodname>date_diff</methodname>
<methodparam><type>DateTime</type><parameter>datetime1</parameter></methodparam>
<methodparam><type>DateTime</type><parameter>datetime2</parameter></methodparam>
<methodparam><type>DateTimeInterface</type><parameter>datetime1</parameter></methodparam>
<methodparam><type>DateTimeInterface</type><parameter>datetime2</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>absolute</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Returns the difference between two DateTime objects.
Returns the difference between two <classname>DateTimeInterface</classname>
objects.
</para>
</refsect1>

View file

@ -3,7 +3,7 @@
<refentry xml:id="datetime.format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTime::format</refname>
<refname>DateTimeInterface::format</refname>
<refname>date_format</refname>
<refpurpose>Returns date formatted according to given format</refpurpose>
</refnamediv>
@ -12,13 +12,13 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>string</type><methodname>DateTime::format</methodname>
<modifier>public</modifier> <type>string</type><methodname>DateTimeInterface::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>string</type><methodname>date_format</methodname>
<methodparam><type>DateTime</type><parameter>object</parameter></methodparam>
<methodparam><type>DateTimeInterface</type><parameter>object</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -3,7 +3,7 @@
<refentry xml:id="datetime.getoffset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTime::getOffset</refname>
<refname>DateTimeInterface::getOffset</refname>
<refname>date_offset_get</refname>
<refpurpose>Returns the timezone offset</refpurpose>
</refnamediv>
@ -12,13 +12,13 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>int</type><methodname>DateTime::getOffset</methodname>
<modifier>public</modifier> <type>int</type><methodname>DateTimeInterface::getOffset</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>int</type><methodname>date_offset_get</methodname>
<methodparam><type>DateTime</type><parameter>object</parameter></methodparam>
<methodparam><type>DateTimeInterface</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
Returns the timezone offset.

View file

@ -3,7 +3,7 @@
<refentry xml:id="datetime.gettimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTime::getTimestamp</refname>
<refname>DateTimeInterface::getTimestamp</refname>
<refname>date_timestamp_get</refname>
<refpurpose>Gets the Unix timestamp</refpurpose>
</refnamediv>
@ -12,13 +12,13 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>int</type><methodname>DateTime::getTimestamp</methodname>
<modifier>public</modifier> <type>int</type><methodname>DateTimeInterface::getTimestamp</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>int</type><methodname>date_timestamp_get</methodname>
<methodparam><type>DateTime</type><parameter>object</parameter></methodparam>
<methodparam><type>DateTimeInterface</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
Gets the Unix timestamp.

View file

@ -3,7 +3,7 @@
<refentry xml:id="datetime.gettimezone" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTime::getTimezone</refname>
<refname>DateTimeInterface::getTimezone</refname>
<refname>date_timezone_get</refname>
<refpurpose>Return time zone relative to given DateTime</refpurpose>
</refnamediv>
@ -12,13 +12,13 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeZone</type><methodname>DateTime::getTimezone</methodname>
<modifier>public</modifier> <type>DateTimeZone</type><methodname>DateTimeInterface::getTimezone</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>DateTimeZone</type><methodname>date_timezone_get</methodname>
<methodparam><type>DateTime</type><parameter>object</parameter></methodparam>
<methodparam><type>DateTimeInterface</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
Return time zone relative to given DateTime.

View file

@ -3,14 +3,14 @@
<refentry xml:id="datetime.wakeup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTime::__wakeup</refname>
<refname>DateTimeInterface::__wakeup</refname>
<refpurpose>The __wakeup handler</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::__wakeup</methodname>
<modifier>public</modifier> <methodname>DateTimeInterface::__wakeup</methodname>
<void />
</methodsynopsis>
<para>

View file

@ -0,0 +1,38 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.date-create-immutable-from-format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>date_create_immutable_from_format</refname>
<refpurpose>&Alias; <methodname>DateTimeImmutable::createFromFormat</methodname></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&info.function.alias; <methodname>DateTimeImmutable::createFromFormat</methodname>
</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
-->

View file

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.date-create-immutable" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>date_create_immutable</refname>
<refpurpose>&Alias; <methodname>DateTimeImmutable::__construct</methodname></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&info.function.alias; <methodname>DateTimeImmutable::__construct</methodname>
</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
-->

View file

@ -8,16 +8,10 @@
<!-- Methods -->
<function name='datetime' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::__construct' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::__wakeup' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::__set_state' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::add' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetime::createfromformat' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetime::diff' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetime::format' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::getlasterrors' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetime::getoffset' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::gettimestamp' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetime::gettimezone' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::modify' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::setdate' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetime::setisodate' from='PHP 5 &gt;= 5.2.0'/>
@ -26,17 +20,19 @@
<function name='datetime::settimestamp' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetime::sub' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetimeinterface' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeinterface::__wakeup' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetimeinterface::diff' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetimeinterface::format' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetimeinterface::getoffset' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetimeinterface::gettimestamp' from='PHP 5 &gt;= 5.3.0'/>
<function name='datetimeinterface::gettimezone' from='PHP 5 &gt;= 5.2.0'/>
<function name='datetimeimmutable' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::__construct' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::__wakeup' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::__set_state' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::createfromformat' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::getlasterrors' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::format' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::gettimezone' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::getoffset' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::gettimestamp' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::diff' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::modify' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::add' from='PHP 5 &gt;= 5.5.0'/>
<function name='datetimeimmutable::sub' from='PHP 5 &gt;= 5.5.0'/>