php-doc-en/reference/calendar/functions/cal-to-jd.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

117 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.cal-to-jd' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>cal_to_jd</refname>
<refpurpose>Converts from a supported calendar to Julian Day Count</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>cal_to_jd</methodname>
<methodparam><type>int</type><parameter>calendar</parameter></methodparam>
<methodparam><type>int</type><parameter>month</parameter></methodparam>
<methodparam><type>int</type><parameter>day</parameter></methodparam>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
</methodsynopsis>
<para>
<function>cal_to_jd</function> calculates the Julian day count
for a date in the specified <parameter>calendar</parameter>.
Supported <parameter>calendar</parameter>s are
<constant>CAL_GREGORIAN</constant>,
<constant>CAL_JULIAN</constant>,
<constant>CAL_JEWISH</constant> and
<constant>CAL_FRENCH</constant>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
Calendar to convert from, one of
<constant>CAL_GREGORIAN</constant>,
<constant>CAL_JULIAN</constant>,
<constant>CAL_JEWISH</constant> or
<constant>CAL_FRENCH</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
The month as a number, the valid range depends
on the <parameter>calendar</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
The day as a number, the valid range depends
on the <parameter>calendar</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year as a number, the valid range depends
on the <parameter>calendar</parameter>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A Julian Day number.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>cal_from_jd</function></member>
<member><function>frenchtojd</function></member>
<member><function>gregoriantojd</function></member>
<member><function>jewishtojd</function></member>
<member><function>juliantojd</function></member>
<member><function>unixtojd</function></member>
</simplelist>
</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
-->