php-doc-en/reference/calendar/functions/jdtojewish.xml
Christoph Michael Becker 789af83432 Generate calendar methodsynopses based on stubs
Based on a patch contributed by Máté Kocsis <kocsismate@woohoolabs.com>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351553 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-23 22:36:15 +00:00

125 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.jdtojewish" xmlns="http://docbook.org/ns/docbook">
<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>julian_day</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>hebrew</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</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>flags</parameter> parameter is used for Hebrew, ISO-8859-8 encoded string based,
output format.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask which may consist of
<constant>CAL_JEWISH_ADD_ALAFIM_GERESH</constant>,
<constant>CAL_JEWISH_ADD_ALAFIM</constant> and
<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", or an ISO-8859-8
encoded Hebrew date string, according to the <parameter>hebrew</parameter>
parameter.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>jdtojewish</function> Example</title>
<programlisting role="php">
<![CDATA[
<?php
$jd = gregoriantojd(10, 8, 2002);
echo jdtojewish($jd, true), PHP_EOL,
jdtojewish($jd, true, CAL_JEWISH_ADD_GERESHAYIM), PHP_EOL,
jdtojewish($jd, true, CAL_JEWISH_ADD_ALAFIM), PHP_EOL,
jdtojewish($jd, true,CAL_JEWISH_ADD_ALAFIM_GERESH), PHP_EOL;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
ב חשון התשסג
ב' חשון התשס"ג
ב חשון ה אלפים תשסג
ב חשון ה'תשסג
]]>
</screen>
</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
-->