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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlcalendar.getactualmaximum" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlCalendar::getActualMaximum</refname>
<refpurpose>The maximum value for a field, considering the objectʼs current time</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::getActualMaximum</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>intlcal_get_actual_maximum</methodname>
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Returns a fieldʼs relative maximum value around the current time. The exact
semantics vary by field, but in the general case this is the value that
would be obtained if one would set the field value into the
<link linkend="intlcalendar.getleastmaximum">smallest relative maximum</link> for
the field and would increment it until reaching the
<link linkend="intlcalendar.getmaximum">global maximum</link> or the field value
wraps around, in which the value returned would be the global maximum
or the value before the wrapping, respectively.
</para>
<para>
For instance, in the gregorian calendar, the actual maximum value for the
<link linkend="intlcalendar.constants.field-day-of-month">day of
month</link> would vary between <literal>28</literal> and
<literal>31</literal>, depending on the month and year of the current time.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
&intl.parameter.intl-calendar;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
&reference.intl.incfieldparam;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>int</type> representing the maximum value in the units associated
with the given <parameter>field</parameter>&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>IntlCalendar::getActualMaximum</function></title>
<programlisting role="php">
<![CDATA[
<?php
ini_set('date.timezone', 'Europe/Lisbon');
$cal = IntlCalendar::fromDateTime('2013-02-15');
var_dump($cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //28
$cal->add(IntlCalendar::FIELD_EXTENDED_YEAR, -1);
var_dump($cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //29
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(28)
int(29)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>IntlCalendar::getMaximum</methodname></member>
<member><methodname>IntlCalendar::getLeastMaximum</methodname></member>
<member><methodname>IntlCalendar::getActualMinimum</methodname></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
-->
|
