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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id='function.cal-info' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>cal_info</refname>
<refpurpose>Returns information about a particular calendar</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>cal_info</methodname>
<methodparam choice="opt"><type>int</type><parameter>calendar</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
<function>cal_info</function> returns information on the
specified <parameter>calendar</parameter>.
</para>
<para>
Calendar information is returned as an array containing the
elements <literal>calname</literal>, <literal>calsymbol</literal>,
<literal>month</literal>, <literal>abbrevmonth</literal> and
<literal>maxdaysinmonth</literal>. The names of the different calendars
which can be used as <parameter>calendar</parameter> are as follows:
<itemizedlist>
<listitem>
<simpara>
0 or <constant>CAL_GREGORIAN</constant> - Gregorian Calendar
</simpara>
</listitem>
<listitem>
<simpara>
1 or <constant>CAL_JULIAN</constant> - Julian Calendar
</simpara>
</listitem>
<listitem>
<simpara>
2 or <constant>CAL_JEWISH</constant> - Jewish Calendar
</simpara>
</listitem>
<listitem>
<simpara>
3 or <constant>CAL_FRENCH</constant> - French Revolutionary Calendar
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
If no <parameter>calendar</parameter> is specified information on all
supported calendars is returned as an array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
Calendar to return information for. If no calendar is specified
information about all calendars is returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Since 5.0</entry>
<entry>
The <parameter>calendar</parameter> parameter becomes optional
and defaults to "all calendars" if omitted.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>cal_info</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$info = cal_info(0);
print_r($info);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[months] => Array
(
[1] => January
[2] => February
[3] => March
[4] => April
[5] => May
[6] => June
[7] => July
[8] => August
[9] => September
[10] => October
[11] => November
[12] => December
)
[abbrevmonths] => Array
(
[1] => Jan
[2] => Feb
[3] => Mar
[4] => Apr
[5] => May
[6] => Jun
[7] => Jul
[8] => Aug
[9] => Sep
[10] => Oct
[11] => Nov
[12] => Dec
)
[maxdaysinmonth] => 31
[calname] => Gregorian
[calsymbol] => CAL_GREGORIAN
)
]]>
</screen>
</example>
</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:"~/.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
-->
|
