getleastmaximum.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="intlcalendar.getleastmaximum" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlCalendar::getLeastMaximum</refname>
  <refpurpose>Get the smallest local maximum for a field</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis>
   <modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getLeastMaximum</methodname>
   <methodparam><type>int</type><parameter>field</parameter></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type>int</type><methodname>intlcal_get_least_maximum</methodname>
   <methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
   <methodparam><type>int</type><parameter>field</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the smallest local maximumw for a field. This should be a value
   smaller or equal to that returned by
   <function>IntlCalendar::getActualMaxmimum</function>, which is in its turn
   smaller or equal to that returned by
   <function>IntlCalendar::getMaximum</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>cal</parameter></term>
    <listitem>
     <para>
      The IntlCalendar resource.
     </para>
    </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 a field value in the fieldʼs
   unit&return.falseforfailure;.
  </para>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
   <title>Maxima examples</title>
    <programlisting role="php">
<![CDATA[
<?php
ini_set('date.timezone', 'UTC');
ini_set('intl.default_locale', 'it_IT');

$cal = new IntlGregorianCalendar(2013, 3 /* April */, 6);
var_dump(
    $cal->getLeastMaximum(IntlCalendar::FIELD_DAY_OF_MONTH),  // 28
    $cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH), // 30
    $cal->getMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)        // 31
);
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int(28)
int(30)
int(31)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>IntlCalendar::getActualMaximum</methodname></member>
    <member><methodname>IntlCalendar::getMaximum</methodname></member>
    <member><methodname>IntlCalendar::getGreatestMinimum</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
-->