sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Implemented the new doc style, new entities, and rewording where appropriate

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@235409 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2007-05-11 09:58:56 +00:00
parent b2c6dc0787
commit 9417ada4c2
18 changed files with 967 additions and 147 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
reference/calendar/functions/cal-days-in-month.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.cal-days-in-month">
<refnamediv>
<refname>cal_days_in_month</refname>
<refpurpose>Return the number of days in a month for a given year and calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>cal_days_in_month</methodname>
<methodparam><type>int</type><parameter>calendar</parameter></methodparam>
@ -18,6 +19,49 @@
<parameter>month</parameter> of <parameter>year</parameter> for
the specified <parameter>calendar</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
Calendar to use for calculation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
Month in the selected calendar
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
Year in the selected calendar
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The length in days of the selected month in the given calendar
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>cal_days_in_month</function> example</title>
@ -31,10 +75,8 @@ echo "There was $num days in August 2003";
</programlisting>
</example>
</para>
<para>
See also <function>jdtounix</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

57
reference/calendar/functions/cal-from-jd.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<refentry id='function.cal-from-jd'>
<refnamediv>
<refname>cal_from_jd</refname>
<refpurpose>Converts from Julian Day Count to a supported calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>cal_from_jd</methodname>
<methodparam><type>int</type><parameter>jd</parameter></methodparam>
@ -22,6 +23,43 @@
<constant>CAL_JEWISH</constant> and
<constant>CAL_FRENCH</constant>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>jd</parameter></term>
<listitem>
<para>
Julian day as integer
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
Calendar to convert to
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array containing calendar information like month, day, year,
day of week, abbreviated and full names of weekday and month and the
date in string form "month/day/year".
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>cal_from_jd</function> example</title>
@ -52,8 +90,19 @@ Array
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>cal_to_jd</function>.
<simplelist>
<member><function>cal_to_jd</function></member>
<member><function>jdtofrench</function></member>
<member><function>jdtogregorian</function></member>
<member><function>jdtojewish</function></member>
<member><function>jdtojulian</function></member>
<member><function>jdtounix</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

62
reference/calendar/functions/cal-info.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- $Revision: 1.15 $ -->
<refentry id='function.cal-info'>
<refnamediv>
<refname>cal_info</refname>
<refpurpose>Returns information about a particular calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>cal_info</methodname>
<methodparam choice="opt"><type>int</type><parameter>calendar</parameter></methodparam>
@ -46,9 +47,60 @@
</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.
supported calendars is returned as an array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
Calendar to return information for. If no calendar is specified
information about all calendars is returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</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>Since 5.0</entry>
<entry>
The <parameter>calendar</parameter> parameter becomes optional
and defaults to "all calendars" if omitted.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>cal_info</function> example</title>

74
reference/calendar/functions/cal-to-jd.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<refentry id='function.cal-to-jd'>
<refnamediv>
<refname>cal_to_jd</refname>
<refpurpose>Converts from a supported calendar to Julian Day Count</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>cal_to_jd</methodname>
<methodparam><type>int</type><parameter>calendar</parameter></methodparam>
@ -23,8 +24,73 @@
<constant>CAL_JEWISH</constant> and
<constant>CAL_FRENCH</constant>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>cal_from_jd</function>.
<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>

117
reference/calendar/functions/easter-date.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!-- $Revision: 1.14 $ -->
<refentry id="function.easter-date">
<refnamediv>
<refname>easter_date</refname>
<refpurpose>Get Unix timestamp for midnight on Easter of a given year</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>easter_date</methodname>
<methodparam choice="opt"><type>int</type><parameter>year</parameter></methodparam>
@ -15,27 +16,6 @@
Returns the Unix timestamp corresponding to midnight on Easter of
the given year.
</para>
<para>
Since PHP 4.3.0, the <parameter>year</parameter>
parameter is optional and defaults to the current year according to the
localtime if omitted.
</para>
<para>
<example>
<title><function>easter_date</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo date("M-d-Y", easter_date(1999)); // Apr-04-1999
echo date("M-d-Y", easter_date(2000)); // Apr-23-2000
echo date("M-d-Y", easter_date(2001)); // Apr-15-2001
?>
]]>
</programlisting>
</example>
</para>
<warning>
<para>
This function will generate a warning if the year is outside
@ -61,9 +41,94 @@ echo date("M-d-Y", easter_date(2001)); // Apr-15-2001
(The code is based on a C program by Simon Kershaw,
&lt;webmaster at ely.anglican dot org&gt;)
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See <function>easter_days</function> for calculating Easter
before 1970 or after 2037.
<variablelist>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year as a number between 1970 an 2037
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The easter date as a unix timestamp.
</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>Since 4.3.0</entry>
<entry>
The <parameter>year</parameter> parameter is optional and defaults
to the current year according to the local time if omitted.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>easter_date</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo date("M-d-Y", easter_date(1999)); // Apr-04-1999
echo date("M-d-Y", easter_date(2000)); // Apr-23-2000
echo date("M-d-Y", easter_date(2001)); // Apr-15-2001
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
<function>easter_days</function> for calculating Easter
before 1970 or after 2037
</member>
</simplelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>easter_days</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

122
reference/calendar/functions/easter-days.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<refentry id="function.easter-days">
<refnamediv>
<refname>easter_days</refname>
<refpurpose>Get number of days after March 21 on which Easter falls for a given year</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>easter_days</methodname>
<methodparam choice="opt"><type>int</type><parameter>year</parameter></methodparam>
@ -17,38 +18,11 @@
for a given year. If no year is specified, the current year is
assumed.
</para>
<para>
Since PHP 4.3.0, the <parameter>year</parameter>
parameter is optional and defaults to the current year according to the
localtime if omitted.
</para>
<para>
The <parameter>method</parameter> parameter was also introduced in
PHP 4.3.0 and allows to calculate easter dates based
on the Gregorian calendar during the years 1582 - 1752 when set to
<constant>CAL_EASTER_ROMAN</constant>. See the <link
linkend="calendar.constants">calendar constants</link> for more valid
constants.
</para>
<para>
This function can be used instead of
<function>easter_date</function> to calculate Easter for years
which fall outside the range of Unix timestamps (i.e. before 1970
or after 2037).
<example>
<title><function>easter_days</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo easter_days(1999); // 14, i.e. April 4
echo easter_days(1492); // 32, i.e. April 22
echo easter_days(1913); // 2, i.e. March 23
?>
]]>
</programlisting>
</example>
</para>
<para>
The date of Easter Day was defined by the Council of Nicaea in
@ -69,8 +43,94 @@ echo easter_days(1913); // 2, i.e. March 23
(The code is based on a C program by Simon Kershaw,
&lt;webmaster at ely.anglican dot org&gt;)
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>easter_date</function>.
<variablelist>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year as a number between 1970 an 2037
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The number of days after March 21st that the Easter Sunday
is in the given <parameter>year</parameter>.
</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>Since 4.3.0</entry>
<entry>
The <parameter>year</parameter> parameter is optional and defaults
to the current year according to the local time if omitted.
</entry>
</row>
<row>
<entry>Since 4.3.0</entry>
<entry>
The <parameter>method</parameter> parameter was introduced
and allows to calculate easter dates based
on the Gregorian calendar during the years 1582 - 1752 when set to
<constant>CAL_EASTER_ROMAN</constant>. See the <link
linkend="calendar.constants">calendar constants</link> for more valid
constants.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>easter_days</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo easter_days(1999); // 14, i.e. April 4
echo easter_days(1492); // 32, i.e. April 22
echo easter_days(1913); // 2, i.e. March 23
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>easter_date</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

56
reference/calendar/functions/frenchtojd.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.frenchtojd">
<refnamediv>
<refname>FrenchToJD</refname>
<refpurpose>Converts a date from the French Republican Calendar to a Julian Day Count</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>frenchtojd</methodname>
<methodparam><type>int</type><parameter>month</parameter></methodparam>
@ -24,6 +25,55 @@
use.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
The month as a number from 1 (for Vendémiaire) to 13 (for the period of 5-6 days at the end of each year)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
The day as a number from 1 to 30
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year as a number between 1 and 14
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The julian day for the given french revolution date as an integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>jdtofrench</function></member>
<member><function>cal_to_jd</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

62
reference/calendar/functions/gregoriantojd.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.gregoriantojd">
<refnamediv>
<refname>GregorianToJD</refname>
<refpurpose>Converts a Gregorian date to Julian Day Count</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>gregoriantojd</methodname>
<methodparam><type>int</type><parameter>month</parameter></methodparam>
@ -23,6 +24,51 @@
later. For example, Britain converted in 1752, The USSR in 1918
and Greece in 1923. Most European countries used the Julian
calendar prior to the Gregorian.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
The month as a number from 1 (for January) to 12 (for December)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
The day as a number from 1 to 31
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year as a number between -4714 and 9999
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The julian day for the given gregorian date as an integer.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Calendar functions</title>
<programlisting role="php">
@ -38,6 +84,16 @@ echo "$gregorian\n";
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>jdtogregorian</function></member>
<member><function>cal_to_jd</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

124
reference/calendar/functions/jddayofweek.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.jddayofweek">
<refnamediv>
<refname>JDDayOfWeek</refname>
<refpurpose>Returns the day of the week</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>jddayofweek</methodname>
<methodparam><type>int</type><parameter>julianday</parameter></methodparam>
@ -15,39 +16,90 @@
<para>
Returns the day of the week. Can return a string or an integer
depending on the mode.
<table>
<title>Calendar week modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Mode</entry>
<entry>Meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>0 (Default)</entry>
<entry>
Returns the day number as an int (0=Sunday, 1=Monday, etc)
</entry>
</row>
<row>
<entry>1</entry>
<entry>
Returns string containing the day of week
(English-Gregorian)
</entry>
</row>
<row>
<entry>2</entry>
<entry>
Returns a string containing the abbreviated day of week
(English-Gregorian)
</entry>
</row>
</tbody>
</tgroup>
</table>
</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>mode</parameter></term>
<listitem>
<table>
<title>Calendar week modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Mode</entry>
<entry>Meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>0 (Default)</entry>
<entry>
Return the day number as an int (0=Sunday, 1=Monday, etc)
</entry>
</row>
<row>
<entry>1</entry>
<entry>
Returns string containing the day of week
(English-Gregorian)
</entry>
</row>
<row>
<entry>2</entry>
<entry>
Return a string containing the abbreviated day of week
(English-Gregorian)
</entry>
</row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The french revolution date as a string in the form "month/day/year"
</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>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The gregorian weekday as either an integer or string.
</para>
</refsect1>
</refentry>

39
reference/calendar/functions/jdmonthname.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.jdmonthname">
<refnamediv>
<refname>JDMonthName</refname>
<refpurpose>Returns a month name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>jdmonthname</methodname>
<methodparam><type>int</type><parameter>julianday</parameter></methodparam>
@ -63,6 +64,38 @@
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>jday</parameter></term>
<listitem>
<para>
The Julian Day to operate on
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
The calendar to take the month name from
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The month name for the given Julian Day and <parameter>calendar</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/calendar/functions/jdtofrench.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.jdtofrench">
<refnamediv>
<refname>JDToFrench</refname>
<refpurpose>Converts a Julian Day Count to the French Republican Calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>jdtofrench</methodname>
<methodparam><type>int</type><parameter>juliandaycount</parameter></methodparam>
@ -15,6 +15,39 @@
Converts a Julian Day Count to the French Republican 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>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The french revolution date as a string in the form "month/day/year"
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>frenchtojd</function></member>
<member><function>cal_from_jd</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/calendar/functions/jdtogregorian.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.jdtogregorian">
<refnamediv>
<refname>JDToGregorian</refname>
<refpurpose>Converts Julian Day Count to Gregorian date</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>jdtogregorian</methodname>
<methodparam><type>int</type><parameter>julianday</parameter></methodparam>
@ -16,6 +16,39 @@
date in the format of "month/day/year".
</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>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The gregorian date as a string in the form "month/day/year"
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>gregoriantojd</function></member>
<member><function>cal_from_jd</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

43
reference/calendar/functions/jdtojewish.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<refentry id="function.jdtojewish">
<refnamediv>
<refname>jdtojewish</refname>
<refpurpose>Converts a Julian day count to a Jewish calendar date</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>jdtojewish</methodname>
<methodparam><type>int</type><parameter>juliandaycount</parameter></methodparam>
@ -28,6 +28,33 @@
<constant>CAL_JEWISH_ADD_ALAFIM</constant>,
<constant>CAL_JEWISH_ADD_GERESHAYIM</constant>.
</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>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The julian date as a string in the form "month/day/year"
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>jdtojewish</function> Example</title>
@ -42,6 +69,16 @@ echo jdtojewish(gregoriantojd(10, 8, 2002), true,
</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>

40
reference/calendar/functions/jdtojulian.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.jdtojulian">
<refnamediv>
<refname>JDToJulian</refname>
<refpurpose>Converts a Julian Day Count to a Julian Calendar Date</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>jdtojulian</methodname>
<methodparam><type>int</type><parameter>julianday</parameter></methodparam>
@ -16,6 +17,39 @@
Calendar Date in the format of "month/day/year".
</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>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The julian date as a string in the form "month/day/year"
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>juliantojd</function></member>
<member><function>cal_from_jd</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

38
reference/calendar/functions/jdtounix.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.jdtounix">
<refnamediv>
<refname>jdtounix</refname>
<refpurpose>Convert Julian Day to Unix timestamp</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>jdtounix</methodname>
<methodparam><type>int</type><parameter>jday</parameter></methodparam>
@ -19,8 +20,37 @@
<parameter>jday</parameter> &lt;= 2465342 ). The time returned is
localtime (and not GMT).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>unixtojd</function>.
<variablelist>
<varlistentry>
<term><parameter>jday</parameter></term>
<listitem>
<para>
A julian day number between 2440588 and 2465342.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The unix timestamp for the start of the given julian day.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>unixtojd</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

55
reference/calendar/functions/jewishtojd.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.jewishtojd">
<refnamediv>
<refname>JewishToJD</refname>
<refpurpose>Converts a date in the Jewish Calendar to Julian Day Count</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>jewishtojd</methodname>
<methodparam><type>int</type><parameter>month</parameter></methodparam>
@ -21,6 +21,55 @@
when the new moon was first observed.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
The month as a number from 1 to 13
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
The day as a number from 1 to 30
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year as a number between 1 and 9999
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The julian day for the given jewish date as an integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>jdtojewish</function></member>
<member><function>cal_to_jd</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

55
reference/calendar/functions/juliantojd.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.juliantojd">
<refnamediv>
<refname>JulianToJD</refname>
<refpurpose>Converts a Julian Calendar date to Julian Day Count</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>juliantojd</methodname>
<methodparam><type>int</type><parameter>month</parameter></methodparam>
@ -32,6 +32,55 @@
</para>
</caution>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
The month as a number from 1 (for January) to 12 (for December)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
The day as a number from 1 to 31
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year as a number between -4713 and 9999
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The julian day for the given julian date as an integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>jdtojulian</function></member>
<member><function>cal_to_jd</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

38
reference/calendar/functions/unixtojd.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.unixtojd">
<refnamediv>
<refname>unixtojd</refname>
<refpurpose>Convert Unix timestamp to Julian Day</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>unixtojd</methodname>
<methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam>
@ -16,8 +17,37 @@
(seconds since 1.1.1970), or for the current day if no
<parameter>timestamp</parameter> is given.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>jdtounix</function>.
<variablelist>
<varlistentry>
<term><parameter>timestamp</parameter></term>
<listitem>
<para>
A unix timestamp to convert.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A julian day number as integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>jdtounix</function></member>
</simplelist>
</para>
</refsect1>
</refentry>