File: cal-from-jd.xml

package info (click to toggle)
php-doc 20250827~git.abe740d%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 71,968 kB
  • sloc: xml: 985,760; php: 25,504; javascript: 671; sh: 177; makefile: 37
file content (130 lines) | stat: -rw-r--r-- 3,399 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.cal-from-jd" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>cal_from_jd</refname>
  <refpurpose>Converts from Julian Day Count to a supported calendar</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>cal_from_jd</methodname>
   <methodparam><type>int</type><parameter>julian_day</parameter></methodparam>
   <methodparam><type>int</type><parameter>calendar</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>cal_from_jd</function> converts the Julian day given in
   <parameter>julian_day</parameter> into a date of the specified
   <parameter>calendar</parameter>. Supported
   <parameter>calendar</parameter> values 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>julian_day</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 (<literal>dow</literal>), abbreviated and full names of weekday and month and the
   date in string form "month/day/year".
   The day of week ranges from <literal>0</literal> (Sunday) to
   <literal>6</literal> (Saturday).
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>cal_from_jd</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$today = unixtojd(mktime(0, 0, 0, 8, 16, 2003));
print_r(cal_from_jd($today, CAL_GREGORIAN));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [date] => 8/16/2003
    [month] => 8
    [day] => 16
    [year] => 2003
    [dow] => 6
    [abbrevdayname] => Sat
    [dayname] => Saturday
    [abbrevmonth] => Aug
    [monthname] => August
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <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>
<!-- 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
-->