php-doc-en/reference/calendar/functions/jdtojewish.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

143 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.jdtojewish">
<refnamediv>
<refname>jdtojewish</refname>
<refpurpose>Converts a Julian day count to a Jewish calendar date</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>jdtojewish</methodname>
<methodparam><type>int</type><parameter>juliandaycount</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>hebrew</parameter><initializer>false</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>fl</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Converts a Julian Day Count to the Jewish Calendar.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>julianday</parameter></term>
<listitem>
<para>
A julian day number as integer
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hebrew</parameter></term>
<listitem>
<para>
If the <parameter>hebrew</parameter> parameter is set to &true;, the
<parameter>fl</parameter> parameter is used for Hebrew, string based,
output format.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fl</parameter></term>
<listitem>
<para>
The available formats are:
<constant>CAL_JEWISH_ADD_ALAFIM_GERESH</constant>,
<constant>CAL_JEWISH_ADD_ALAFIM</constant>,
<constant>CAL_JEWISH_ADD_GERESHAYIM</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The jewish date as a string in the form "month/day/year"
</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>5.0.0</entry>
<entry>
The <parameter>fl</parameter> parameter was added.
</entry>
</row>
<row>
<entry>4.3.0</entry>
<entry>
The <parameter>hebrew</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>jdtojewish</function> Example</title>
<programlisting role="php">
<![CDATA[
<?php
echo jdtojewish(gregoriantojd(10, 8, 2002), true,
CAL_JEWISH_ADD_GERESHAYIM + CAL_JEWISH_ADD_ALAFIM + CAL_JEWISH_ADD_ALAFIM_GERESH);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>jewishtojd</function></member>
<member><function>cal_from_jd</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
-->