php-doc-en/reference/intl/dateformatter-constants.xml
Christoph Michael Becker 80858f3bd0 Add new IntlDateFormatter constants
Closes GH-267.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351939 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-06 23:34:08 +00:00

158 lines
5.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="intl.intldateformatter-constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
<para>
These constants are used to specify different formats
in the constructor for DateType and TimeType.
<variablelist>
<varlistentry xml:id="intldateformatter.constants.none">
<term>
<constant>IntlDateFormatter::NONE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Do not include this element</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.full">
<term>
<constant>IntlDateFormatter::FULL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Completely specified style (Tuesday, April 12, 1952 AD or 3:30:42pm PST)</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.long">
<term>
<constant>IntlDateFormatter::LONG</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Long style (January 12, 1952 or 3:30:32pm)</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.medium">
<term>
<constant>IntlDateFormatter::MEDIUM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Medium style (Jan 12, 1952)</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.short">
<term>
<constant>IntlDateFormatter::SHORT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Most abbreviated style, only essential data (12/13/52 or 3:30pm)</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.relative_full">
<term>
<constant>IntlDateFormatter::RELATIVE_FULL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The same as <constant>IntlDateFormatter::FULL</constant>, but yesterday, today, and tomorrow
show as <literal>yesterday</literal>, <literal>today</literal>, and <literal>tomorrow</literal>,
respectively. Available as of PHP 8.0.0, for <parameter>dateType</parameter> only.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.relative_long">
<term>
<constant>IntlDateFormatter::RELATIVE_LONG</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The same as <constant>IntlDateFormatter::LONG</constant>, but yesterday, today, and tomorrow
show as <literal>yesterday</literal>, <literal>today</literal>, and <literal>tomorrow</literal>,
respectively. Available as of PHP 8.0.0, for <parameter>dateType</parameter> only.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.relative_medium">
<term>
<constant>IntlDateFormatter::RELATIVE_MEDIUM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The same as <constant>IntlDateFormatter::MEDIUM</constant>, but yesterday, today, and tomorrow
show as <literal>yesterday</literal>, <literal>today</literal>, and <literal>tomorrow</literal>,
respectively. Available as of PHP 8.0.0, for <parameter>dateType</parameter> only.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.relative_short">
<term>
<constant>IntlDateFormatter::RELATIVE_SHORT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The same as <constant>IntlDateFormatter::SHORT</constant>, but yesterday, today, and tomorrow
show as <literal>yesterday</literal>, <literal>today</literal>, and <literal>tomorrow</literal>,
respectively. Available as of PHP 8.0.0, for <parameter>dateType</parameter> only.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para xml:id="intl.intldateformatter-constants.calendartypes">
The following int constants are used to specify the calendar.
These calendars are all based directly on the Gregorian calendar.
Non-Gregorian calendars need to be specified in locale.
Examples might include locale="hi@calendar=BUDDHIST".
<variablelist>
<varlistentry xml:id="intldateformatter.constants.traditional">
<term>
<constant>IntlDateFormatter::TRADITIONAL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Non-Gregorian Calendar</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="intldateformatter.constants.gregorian">
<term>
<constant>IntlDateFormatter::GREGORIAN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Gregorian Calendar</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- 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
-->