File: cal-info.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 (131 lines) | stat: -rw-r--r-- 3,447 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!-- splitted from ./en/functions/calendar.xml, last change in rev 1.19 -->
  <refentry id='function.cal-info'>
   <refnamediv>
    <refname>cal_info</refname>
    <refpurpose>Returns information about a particular calendar</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>cal_info</methodname>
      <methodparam choice="opt"><type>int</type><parameter>calendar</parameter></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. This functionality
     is available beginning with PHP 5.
    </para>
    <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:"../../../../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
-->