php-doc-en/reference/calendar/functions/cal-info.xml
Jakub Vrana 3ddd190e40 <constant> (thanks to Didou)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183735 c90b9560-bf6c-de11-be94-00142212c4b1
2005-04-06 07:57:26 +00:00

131 lines
3.4 KiB
XML

<?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
-->