archived-doc-en/reference/datetime/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="datetime.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 <para>
  The <constant>DATE_<replaceable>*</replaceable></constant>
  constants are defined and offer standard
  date representations, which can be used along with the date format functions
  (like <function>date</function>).
 </para>

 <variablelist>
  <title>
   Available <parameter>returnFormat</parameter> for
   <function>date_sunrise</function> and
   <function>date_sunset</function>
  </title>

  <warning>
   <simpara>
    These constants are deprecated as of PHP 8.4.0.
    The corresponding <function>date_sunrise</function> and
    <function>date_sunset</function> functions are deprecated as of PHP 8.1.0.
   </simpara>
  </warning>

  <varlistentry xml:id="constant.sunfuncs-ret-timestamp">
   <term>
    <constant>SUNFUNCS_RET_TIMESTAMP</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Timestamp
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sunfuncs-ret-string">
   <term>
    <constant>SUNFUNCS_RET_STRING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Hours:minutes (example: <literal>08:02</literal>)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sunfuncs-ret-double">
   <term>
    <constant>SUNFUNCS_RET_DOUBLE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Hours as floating point number (example <literal>8.75</literal>)
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title><constant>DATE_<replaceable>*</replaceable></constant> constants</title>
  <varlistentry xml:id="constant.date-atom">
   <term>
    <constant>DATE_ATOM</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Atom (example: <literal>2005-08-15T15:52:01+00:00</literal>); compatible with ISO-8601, RFC 3339, and XML Schema
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-cookie">
   <term>
    <constant>DATE_COOKIE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     HTTP Cookies (example: <literal>Monday, 15-Aug-2005 15:52:01 UTC</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-iso8601">
   <term>
    <constant>DATE_ISO8601</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     ISO-8601-like (example: <literal>2005-08-15T15:52:01+0000</literal>)
    </simpara>
    <note>
     <simpara>
      This format is not compatible with ISO-8601, but is left this way for
      backward compatibility reasons. Use
      <constant>DATE_ISO8601_EXPANDED</constant>,
      <constant>DATE_ATOM</constant> for compatibility with ISO-8601
      instead (ref ISO8601:2004 section 4.3.3 clause d).
     </simpara>
    </note>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-iso8601-expanded">
   <term>
    <constant>DATE_ISO8601_EXPANDED</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     ISO-8601 Expanded (example: <literal>+10191-07-26T08:59:52+01:00</literal>)
    </simpara>
    <note>
     <simpara>
      This format allows for year ranges outside of ISO-8601's normal range
      of <literal>0000</literal>-<literal>9999</literal> by always
      including a sign character. It also ensures that the timezone part
      (<literal>+01:00</literal>) is compatible with ISO-8601.
     </simpara>
    </note>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc822">
   <term>
    <constant>DATE_RFC822</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 822 (example: <literal>Mon, 15 Aug 05 15:52:01 +0000</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc850">
   <term>
    <constant>DATE_RFC850</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 850 (example: <literal>Monday, 15-Aug-05 15:52:01 UTC</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc1036">
   <term>
    <constant>DATE_RFC1036</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 1036 (example: <literal>Mon, 15 Aug 05 15:52:01 +0000</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc1123">
   <term>
    <constant>DATE_RFC1123</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 1123 (example: <literal>Mon, 15 Aug 2005 15:52:01 +0000</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc7231">
   <term>
    <constant>DATE_RFC7231</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 7231 (as of PHP 7.0.19 and 7.1.5)
     (example: <literal>Sat, 30 Apr 2016 17:52:13 GMT</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc2822">
   <term>
    <constant>DATE_RFC2822</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 2822 (example: <literal>Mon, 15 Aug 2005 15:52:01 +0000</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc3339">
   <term>
    <constant>DATE_RFC3339</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Same as <constant>DATE_ATOM</constant>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rfc3339-extended">
   <term>
    <constant>DATE_RFC3339_EXTENDED</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RFC 3339 EXTENDED format
     (example: <literal>2005-08-15T15:52:01.000+00:00</literal>)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-rss">
   <term>
    <constant>DATE_RSS</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     RSS (example: <literal>Mon, 15 Aug 2005 15:52:01 +0000</literal>).
     &Alias; <constant>DATE_RFC1123</constant>.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.date-w3c">
   <term>
    <constant>DATE_W3C</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     World Wide Web Consortium (example: <literal>2005-08-15T15:52:01+00:00</literal>).
     &Alias; <constant>DATE_RFC3339</constant>.
    </simpara>
   </listitem>
  </varlistentry>

 </variablelist>
</appendix>
<!-- 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
-->