File: idate.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (162 lines) | stat: -rw-r--r-- 4,709 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.idate">
 <refnamediv>
  <refname>idate</refname>
  <refpurpose>Format a local time/date as integer</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>int</type><methodname>idate</methodname>
   <methodparam><type>string</type><parameter>format</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns a number 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 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="2">
     <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 (1 or 2 digits - check note below)</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>
  <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>.
  </para>
 </refsect1>
</refentry>

<!-- 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:"../../../../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
-->