cvs: phpdoc /en/reference/datetime/functions idate.xml

nlopess Sat May 29 10:02:46 2004 EDT Modified files: /phpdoc/en/reference/datetime/functions idate.xml Log: initial docs for idate http://cvs.php.net/diff.php/phpdoc/en/reference/datetime/functions/idate.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/datetime/functions/idate.xml diff -u phpdoc/en/reference/datetime/functions/idate.xml:1.1 phpdoc/en/reference/datetime/functions/idate.xml:1.2 --- phpdoc/en/reference/datetime/functions/idate.xml:1.1 Tue Apr 27 18:09:18 2004 +++ phpdoc/en/reference/datetime/functions/idate.xml Sat May 29 10:02:46 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.idate"> <refnamediv> <refname>idate</refname> @@ -14,9 +14,104 @@ <methodparam><type>string</type><parameter>format</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Returns a string formatted according to the given format string using the + given integer <parameter>timestamp</parameter> or the current local time + if no timestamp is given. In otherwords, <parameter>timestamp</parameter> + is optional and defaults to the value of <function>time</function>. + </para> + <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> + </row> + </thead> + <tbody> + <row> + <entry><literal>B</literal></entry> + <entry>Swatch Beat/Internet Time</entry> + </row> + <row> + <entry><literal>d</literal></entry> + <entry>Day of the month</entry> + </row> + <row> + <entry><literal>h</literal></entry> + <entry>Hour (12 hour format)</entry> + </row> + <row> + <entry><literal>H</literal></entry> + <entry>Hour (24 hour format)</entry> + </row> + <row> + <entry><literal>i</literal></entry> + <entry>Minutes</entry> + </row> + <row> + <entry><literal>I</literal></entry> + <entry>returns <literal>1</literal> if DST is activated, + <literal>0</literal> otherwise</entry> + </row> + <row> + <entry><literal>L</literal></entry> + <entry>returns <literal>1</literal> for leap year, + <literal>0</literal> otherwise</entry> + </row> + <row> + <entry><literal>m</literal></entry> + <entry>Month number</entry> + </row> + <row> + <entry><literal>s</literal></entry> + <entry>Seconds</entry> + </row> + <row> + <entry><literal>t</literal></entry> + <entry>Days in current month</entry> + </row> + <row> + <entry><literal>U</literal></entry> + <entry>Seconds since the Unix Epoch - January 1 1970 00:00:00 GMT - + this is the same as <function>time</function></entry> + </row> + <row> + <entry><literal>w</literal></entry> + <entry>Day of the week (<literal>0</literal> on Sunday)</entry> + </row> + <row> + <entry><literal>W</literal></entry> + <entry>ISO-8601 week number of year, weeks starting on + Monday</entry> + </row> + <row> + <entry><literal>y</literal></entry> + <entry>Year (2 digits)</entry> + </row> + <row> + <entry><literal>Y</literal></entry> + <entry>Year (4 digits)</entry> + </row> + <row> + <entry><literal>z</literal></entry> + <entry>Day of the year</entry> + </row> + <row> + <entry><literal>Z</literal></entry> + <entry>Timezone offset in seconds</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + See also <function>date</function> and + <function>time</function>. + </para> </refsect1> </refentry>