cvs: phpdoc /en/reference/datetime/dateinterval format.xml
| From: | Hannes Magnusson | Date: | Sun, 21 Jun 2009 21:19:05 +0000 |
| Subject: | cvs: phpdoc /en/reference/datetime/dateinterval format.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-4190@lists.php.net to get a copy of this message | ||
bjori Sun Jun 21 21:19:05 2009 UTC
Modified files:
/phpdoc/en/reference/datetime/dateinterval format.xml
Log:
Document the format specifiers (shamelessly "copy&pasted" from Dericks
book)
# Fixes bug#48333
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/datetime/dateinterval/format.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/datetime/dateinterval/format.xml
diff -u phpdoc/en/reference/datetime/dateinterval/format.xml:1.2
phpdoc/en/reference/datetime/dateinterval/format.xml:1.3
--- phpdoc/en/reference/datetime/dateinterval/format.xml:1.2 Tue May 19 19:29:15 2009
+++ phpdoc/en/reference/datetime/dateinterval/format.xml Sun Jun 21 21:19:05 2009
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry xml:id="dateinterval.format" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -26,8 +26,110 @@
<term><parameter>format</parameter></term>
<listitem>
<para>
-
+ <table>
+ <title>
+ The following characters are recognized in the
+ <parameter>format</parameter> parameter string.
+ </title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry><parameter>format</parameter> character</entry>
+ <entry>Description</entry>
+ <entry>Example values</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>Y</literal></entry>
+ <entry>Years, numeric, at least 2 digits with leading 0</entry>
+ <entry><literal>01</literal>,
<literal>03</literal></entry>
+ </row>
+ <row>
+ <entry><literal>y</literal></entry>
+ <entry>Years, numeric</entry>
+ <entry><literal>1</literal>,
<literal>3</literal></entry>
+ </row>
+ <row>
+ <entry><literal>M</literal></entry>
+ <entry>Months, numeric, at least 2 digits with leading 0</entry>
+ <entry><literal>01</literal>, <literal>03</literal>,
<literal>12</literal></entry>
+ </row>
+ <row>
+ <entry><literal>m</literal></entry>
+ <entry>Months, numeric</entry>
+ <entry><literal>01</literal>, <literal>03</literal>,
<literal>12</literal></entry>
+ </row>
+ <row>
+ <entry><literal>D</literal></entry>
+ <entry>Days, numeric, at least 2 digits with leading 0</entry>
+ <entry><literal>01</literal>, <literal>03</literal>,
<literal>31</literal></entry>
+ </row>
+ <row>
+ <entry><literal>d</literal></entry>
+ <entry>Days, numeric</entry>
+ <entry><literal>1</literal>, <literal>3</literal>,
<literal>31</literal></entry>
+ </row>
+ <row>
+ <entry><literal>a</literal></entry>
+ <entry>Total amount of days</entry>
+ <entry><literal>4</literal>, <literal>18</literal>,
<literal>8123</literal></entry>
+ </row>
+ <row>
+ <entry><literal>H</literal></entry>
+ <entry>Hours, numeric, at least 2 digits with leading 0</entry>
+ <entry><literal>01</literal>, <literal>03</literal>,
<literal>23</literal></entry>
+ </row>
+ <row>
+ <entry><literal>h</literal></entry>
+ <entry>Hours, numeric</entry>
+ <entry><literal>1</literal>, <literal>3</literal>,
<literal>23</literal></entry>
+ </row>
+ <row>
+ <entry><literal>I</literal></entry>
+ <entry>Minutes, numeric, at least 2 digits with leading 0</entry>
+ <entry><literal>01</literal>, <literal>03</literal>,
<literal>59</literal></entry>
+ </row>
+ <row>
+ <entry><literal>i</literal></entry>
+ <entry>Minutes, numeric</entry>
+ <entry><literal>1</literal>, <literal>3</literal>,
<literal>59</literal></entry>
+ </row>
+ <row>
+ <entry><literal>S</literal></entry>
+ <entry>Seconds, numeric, at least 2 digits with leading 0</entry>
+ <entry><literal>01</literal>, <literal>03</literal>,
<literal>57</literal></entry>
+ </row>
+ <row>
+ <entry><literal>s</literal></entry>
+ <entry>Seconds, numeric</entry>
+ <entry><literal>1</literal>, <literal>3</literal>,
<literal>57</literal></entry>
+ </row>
+ <row>
+ <entry><literal>R</literal></entry>
+ <entry>Sign "<literal>-</literal>" when negative,
"<literal>+</literal>" when positive</entry>
+ <entry><literal>-</literal>,
<literal>+</literal></entry>
+ </row>
+ <row>
+ <entry><literal>r</literal></entry>
+ <entry>Sign "<literal>-</literal>" when negative, empty when
positive</entry>
+ <entry><literal>-</literal>,
<literal></literal></entry>
+ </row>
+ <row>
+ <entry><literal>%</literal></entry>
+ <entry>Literal <literal>%</literal></entry>
+ <entry><literal>%</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</para>
+ <note>
+ <para>
+ The prefix <literal>%</literal> is required in order for the format
+ specifiers to work correctly.
+ </para>
+ </note>
</listitem>
</varlistentry>
</variablelist>