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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlcalendar.setminimaldaysinfirstweek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlCalendar::setMinimalDaysInFirstWeek</refname>
<refpurpose>Set minimal number of days the first week in a year or month can have</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis role="IntlCalendar">
<modifier>public</modifier> <type>true</type><methodname>IntlCalendar::setMinimalDaysInFirstWeek</methodname>
<methodparam><type>int</type><parameter>days</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>true</type><methodname>intlcal_set_minimal_days_in_first_week</methodname>
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>int</type><parameter>days</parameter></methodparam>
</methodsynopsis>
<para>
Sets the smallest number of days the first week of a year or month must
have in the new year or month. For instance, in the Gregorian calendar, if
this value is 1, then the first week of the year will necessarily include
January 1st, while if this value is 7, then the week with January 1st will
be the first week of the year only if the day of the week for January 1st
matches the day of the week returned by
<function>IntlCalendar::getFirstDayOfWeek</function>; otherwise it will be
the previous yearʼs last week.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
&intl.parameter.intl-calendar;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>days</parameter></term>
<listitem>
<para>
The number of minimal days to set.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.true.always;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<classname>ValueError</classname> if <parameter>days</parameter> is out of range
(less than <literal>1</literal> or more than <literal>7</literal>).
</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>8.0.0</entry>
<entry>
A <classname>ValueError</classname> is now thrown on invalid input. Previously, &false; was returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->
|
