<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get the smallest local maximum for a field</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.getkeywordvaluesforlocale.html">IntlCalendar::getKeywordValuesForLocale</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlcalendar.getlocale.html">IntlCalendar::getLocale</a></div>
<div class="up"><a href="class.intlcalendar.html">IntlCalendar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="intlcalendar.getleastmaximum" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlCalendar::getLeastMaximum</h1>
<p class="verinfo">(PHP 5.5.0, PECL >= 3.0.0a1)</p><p class="refpurpose"><span class="refname">IntlCalendar::getLeastMaximum</span> — <span class="dc-title">Get the smallest local maximum for a field</span></p>
</div>
<div class="refsect1 description" id="refsect1-intlcalendar.getleastmaximum-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>IntlCalendar::getLeastMaximum</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$field</code></span>
)</div>
<p class="para rdfs-comment">
Returns the smallest local maximumw for a field. This should be a value
smaller or equal to that returned by
<span class="function"><strong>IntlCalendar::getActualMaxmimum()</strong></span>, which is in its turn
smaller or equal to that returned by
<span class="function"><a href="intlcalendar.getmaximum.html" class="function">IntlCalendar::getMaximum()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intlcalendar.getleastmaximum-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">field</code></em></span>
<dd>
<p class="para">
One of the <a href="class.intlcalendar.html" class="classname">IntlCalendar</a> date/time <a href="class.intlcalendar.html#intlcalendar.constants" class="link">field constants</a>. These are integer
values between <em>0</em> and
<strong><code>IntlCalendar::FIELD_COUNT</code></strong>.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-intlcalendar.getleastmaximum-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An <span class="type"><a href="language.types.integer.html" class="type int">int</a></span> representing a field value in the fieldʼs
unit or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-intlcalendar.getleastmaximum-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2606">
<p><strong>Example #1 Maxima examples</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />ini_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'date.timezone'</span><span style="color: #007700">, </span><span style="color: #DD0000">'UTC'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ini_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'intl.default_locale'</span><span style="color: #007700">, </span><span style="color: #DD0000">'it_IT'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$cal </span><span style="color: #007700">= new </span><span style="color: #0000BB">IntlGregorianCalendar</span><span style="color: #007700">(</span><span style="color: #0000BB">2013</span><span style="color: #007700">, </span><span style="color: #0000BB">3 </span><span style="color: #FF8000">/* April */</span><span style="color: #007700">, </span><span style="color: #0000BB">6</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">getLeastMaximum</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_DAY_OF_MONTH</span><span style="color: #007700">), </span><span style="color: #FF8000">// 28<br /> </span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">getActualMaximum</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_DAY_OF_MONTH</span><span style="color: #007700">), </span><span style="color: #FF8000">// 30<br /> </span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">getMaximum</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_DAY_OF_MONTH</span><span style="color: #007700">) </span><span style="color: #FF8000">// 31<br /></span><span style="color: #007700">);</span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
int(28)
int(30)
int(31)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-intlcalendar.getleastmaximum-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="intlcalendar.getactualmaximum.html" class="methodname" rel="rdfs-seeAlso">IntlCalendar::getActualMaximum()</a> - The maximum value for a field, considering the objectʼs current time</span></li>
<li class="member"> <span class="methodname"><a href="intlcalendar.getmaximum.html" class="methodname" rel="rdfs-seeAlso">IntlCalendar::getMaximum()</a> - Get the global maximum value for a field</span></li>
<li class="member"> <span class="methodname"><a href="intlcalendar.getgreatestminimum.html" class="methodname" rel="rdfs-seeAlso">IntlCalendar::getGreatestMinimum()</a> - Get the largest local minimum value for a field</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.getkeywordvaluesforlocale.html">IntlCalendar::getKeywordValuesForLocale</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlcalendar.getlocale.html">IntlCalendar::getLocale</a></div>
<div class="up"><a href="class.intlcalendar.html">IntlCalendar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
