php-doc-en/reference/datetime/datetime.xml

310 lines
9.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.datetime" 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 DateTime class</title>
<titleabbrev>DateTime</titleabbrev>
<partintro>
<!-- {{{ DateTime intro -->
<section xml:id="datetime.intro">
&reftitle.intro;
<para>
Representation of date and time.
</para>
</section>
<!-- }}} -->
<section xml:id="datetime.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DateTime</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DateTime</classname>
</ooclass>
<oointerface>
<interfacename>DateTimeInterface</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.atom">DateTime::ATOM</varname>
<initializer>"Y-m-d\TH:i:sP"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.cookie">DateTime::COOKIE</varname>
<initializer>"l, d-M-Y H:i:s T"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.iso8601">DateTime::ISO8601</varname>
<initializer>"Y-m-d\TH:i:sO"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.rfc822">DateTime::RFC822</varname>
<initializer>"D, d M y H:i:s O"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.rfc850">DateTime::RFC850</varname>
<initializer>"l, d-M-y H:i:s T"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.rfc1036">DateTime::RFC1036</varname>
<initializer>"D, d M y H:i:s O"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.rfc1123">DateTime::RFC1123</varname>
<initializer>"D, d M Y H:i:s O"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.rfc2822">DateTime::RFC2822</varname>
<initializer>"D, d M Y H:i:s O"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.rfc3339">DateTime::RFC3339</varname>
<initializer>"Y-m-d\TH:i:sP"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.rss">DateTime::RSS</varname>
<initializer>"D, d M Y H:i:s O"</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="datetime.constants.w3c">DateTime::W3C</varname>
<initializer>"Y-m-d\TH:i:sP"</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetime')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
<!--
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetime')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
-->
<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>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimeinterface')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='oop'])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DateTime constants -->
<section xml:id="datetime.constants.types">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="datetime.constants.atom">
<term><constant>DateTime::ATOM</constant></term>
<term><constant>DATE_ATOM</constant></term>
<listitem>
<simpara>
Atom (example: 2005-08-15T15:52:01+00:00)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.cookie">
<term><constant>DateTime::COOKIE</constant></term>
<term><constant>DATE_COOKIE</constant></term>
<listitem>
<simpara>
HTTP Cookies (example: Monday, 15-Aug-2005 15:52:01 UTC)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.iso8601">
<term><constant>DateTime::ISO8601</constant></term>
<term><constant>DATE_ISO8601</constant></term>
<listitem>
<simpara>
ISO-8601 (example: 2005-08-15T15:52:01+0000)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.rfc822">
<term><constant>DateTime::RFC822</constant></term>
<term><constant>DATE_RFC822</constant></term>
<listitem>
<simpara>
RFC 822 (example: Mon, 15 Aug 05 15:52:01 +0000)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.rfc850">
<term><constant>DateTime::RFC850</constant></term>
<term><constant>DATE_RFC850</constant></term>
<listitem>
<simpara>
RFC 850 (example: Monday, 15-Aug-05 15:52:01 UTC)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.rfc1036">
<term><constant>DateTime::RFC1036</constant></term>
<term><constant>DATE_RFC1036</constant></term>
<listitem>
<simpara>
RFC 1036 (example: Mon, 15 Aug 05 15:52:01 +0000)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.rfc1123">
<term><constant>DateTime::RFC1123</constant></term>
<term><constant>DATE_RFC1123</constant></term>
<listitem>
<simpara>
RFC 1123 (example: Mon, 15 Aug 2005 15:52:01 +0000)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.rfc2822">
<term><constant>DateTime::RFC2822</constant></term>
<term><constant>DATE_RFC2822</constant></term>
<listitem>
<simpara>
RFC 2822 (example: Mon, 15 Aug 2005 15:52:01 +0000)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.rfc3339">
<term><constant>DateTime::RFC3339</constant></term>
<term><constant>DATE_RFC3339</constant></term>
<listitem>
<simpara>
Same as <constant>DATE_ATOM</constant> (since PHP 5.1.3)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.rss">
<term><constant>DateTime::RSS</constant></term>
<term><constant>DATE_RSS</constant></term>
<listitem>
<simpara>
RSS (example: Mon, 15 Aug 2005 15:52:01 +0000)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="datetime.constants.w3c">
<term><constant>DateTime::W3C</constant></term>
<term><constant>DATE_W3C</constant></term>
<listitem>
<simpara>
World Wide Web Consortium (example: 2005-08-15T15:52:01+00:00)
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<section role="changelog" xml:id="datetime.changelog"><!-- {{{ -->
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.5.0</entry>
<entry>
The class now implements <classname>DateTimeInterface</classname>.
</entry>
</row>
<row>
<entry>5.4.24</entry>
<entry>
The COOKIE constant was changed to reflect RFC 1036 using a four digit
year rather than a two digit year (RFC 850) as prior versions.
</entry>
</row>
<row>
<entry>5.2.2</entry>
<entry>
DateTime object comparison with the
<link linkend="language.operators.comparison">comparison operators</link>
changed to work as expected. Previously, all DateTime objects were
considered equal (using <literal>==</literal>).
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section><!-- }}} -->
</partintro>
&reference.datetime.entities.datetime;
</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
-->