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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlcalendar.getdayofweektype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlCalendar::getDayOfWeekType</refname>
<refpurpose>Tell whether a day is a weekday, weekend or a day that has a transition between the two</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis role="IntlCalendar">
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>IntlCalendar::getDayOfWeekType</methodname>
<methodparam><type>int</type><parameter>dayOfWeek</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>intlcal_get_day_of_week_type</methodname>
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>int</type><parameter>dayOfWeek</parameter></methodparam>
</methodsynopsis>
<para>
Returns whether the passed day is a weekday
(<constant>IntlCalendar::DOW_TYPE_WEEKDAY</constant>), a weekend day
(<constant>IntlCalendar::DOW_TYPE_WEEKEND</constant>), a day during which a
transition occurs into the weekend
(<constant>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</constant>) or a day during
which the weekend ceases
(<constant>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</constant>).
</para>
<para>
If the return is either
<constant>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</constant> or
<constant>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</constant>, then
<function>IntlCalendar::getWeekendTransition</function> can be called to
obtain the time of the transition.
</para>
<para>
This function requires ICU 4.4 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
&intl.parameter.intl-calendar;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dayOfWeek</parameter></term>
<listitem>
<para>
One of the constants <constant>IntlCalendar::DOW_SUNDAY</constant>,
<constant>IntlCalendar::DOW_MONDAY</constant>, …,
<constant>IntlCalendar::DOW_SATURDAY</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns one of the constants
<constant>IntlCalendar::DOW_TYPE_WEEKDAY</constant>,
<constant>IntlCalendar::DOW_TYPE_WEEKEND</constant>,
<constant>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</constant> or
<constant>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</constant>&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>IntlCalendar::getDayOfWeekType</function></title>
<programlisting role="php">
<![CDATA[
<?php
foreach (array('en_US', 'ar_SA') as $locale) {
echo "Locale: ", Locale::getDisplayName($locale, "en_US"), "\n";
$cal = IntlCalendar::createInstance('UTC', $locale);
for ($i = IntlCalendar::DOW_SUNDAY; $i <= IntlCalendar::DOW_SATURDAY; $i++) {
$type = $cal->getDayOfWeekType($i);
$transition = ($type !== IntlCalendar::DOW_TYPE_WEEKDAY)
? $cal->getWeekendTransition($i)
: '';
echo $i, " ", $type, " ", $transition, "\n";
}
echo "\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Locale: English (United States)
1 1 86400000
2 0
3 0
4 0
5 0
6 0
7 1 0
Locale: Arabic (Saudi Arabia)
1 0
2 0
3 0
4 0
5 0
6 1 0
7 1 86400000
]]>
</screen>
</example>
</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
-->
|
