mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
fc1383edb3
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332615 c90b9560-bf6c-de11-be94-00142212c4b1
135 lines
3.9 KiB
XML
135 lines
3.9 KiB
XML
<?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>
|
||
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getActualMaximum</methodname>
|
||
<methodparam><type>int</type><parameter>field</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
&style.procedural;
|
||
</para>
|
||
<methodsynopsis>
|
||
<type>int</type><methodname>intlcal_get_actual_maximum</methodname>
|
||
<methodparam><type>IntlCalendar</type><parameter>cal</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>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 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
|
||
-->
|