php-doc-en/reference/intl/intlcalendar/setminimaldaysinfirstweek.xml
2014-09-23 12:08:23 +00:00

89 lines
2.7 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlcalendar.setminimaldaysinfirstweek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlCalendar::setMinimalDaysInFirstWeek</refname>
<refpurpose>Set minimal number of days the first week in a year or month can have</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setMinimalDaysInFirstWeek</methodname>
<methodparam><type>int</type><parameter>minimalDays</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_get_minimal_days_in_first_week</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>minimalDays</parameter></methodparam>
</methodsynopsis>
<para>
Sets the smallest number of days the first week of a year or month must
have in the new year or month. For instance, in the Gregorian calendar, if
this value is 1, then the first week of the year will necessarily include
January 1st, while if this value is 7, then the week with January 1st will
be the first week of the year only if the day of the week for January 1st
matches the day of the week returned by
<function>IntlCalendar::getFirstDayOfWeek</function>; otherwise it will be
the previous yearʼs last week.
</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>minimalDays</parameter></term>
<listitem>
<para>
The number of minimal days to set.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; on success, &false; on failure.
</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
-->