From 1a891a9b986d5c82611b8e28d423d834618f39d6 Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Mon, 28 Jun 2004 15:04:02 +0000
Subject: [PATCH] add an explanation and an example about problems in two
 digits years

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@162237 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/datetime/functions/idate.xml | 35 +++++++++++++++++++++++---
 1 file changed, 31 insertions(+), 4 deletions(-)

diff --git a/reference/datetime/functions/idate.xml b/reference/datetime/functions/idate.xml
index f1743f7e2d..e593a64b7f 100644
--- a/reference/datetime/functions/idate.xml
+++ b/reference/datetime/functions/idate.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
   <refentry id="function.idate">
    <refnamediv>
     <refname>idate</refname>
@@ -17,14 +17,18 @@
     <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>
+     if no timestamp is given. In other words, <parameter>timestamp</parameter>
      is optional and defaults to the value of <function>time</function>.
     </para>
+    <para>
+     Unlike the function <function>date</function>, <function>idate</function>
+     accepts just one char in the <parameter>format</parameter> parameter.
+    </para>
     <para>
      <table>
       <title>The following characters are recognized in the 
       <parameter>format</parameter> parameter string</title>
-      <tgroup cols="3">
+      <tgroup cols="2">
        <thead>
         <row>
          <entry><parameter>format</parameter> character</entry>
@@ -90,7 +94,7 @@
         </row>
         <row>
          <entry><literal>y</literal></entry>
-         <entry>Year (2 digits)</entry>
+         <entry>Year (1 or 2 digits - check note below)</entry>
         </row>
         <row>
          <entry><literal>Y</literal></entry>
@@ -108,6 +112,29 @@
       </tgroup>
      </table>
     </para>
+    <note>
+     <para>
+      As <function>idate</function> returns always an <type>integer</type> and
+      as they can't start with a "0", <function>idate</function> may return less
+      digits then you would expect. See the example below:
+     </para>
+    </note>
+    <para>
+     <informalexample>
+      <programlisting role="php">
+<![CDATA[
+<?php
+$timestamp = strtotime('1st January 2004'); //1072915200
+
+// this prints the year in a two digit format
+// however, as this would start with a "0", it
+// only prints "4"
+echo idate('y', $timestamp);
+?>
+]]>
+      </programlisting>
+     </informalexample>
+    </para>
     <para>
      See also <function>date</function> and
      <function>time</function>.