mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
fc1383edb3
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332615 c90b9560-bf6c-de11-be94-00142212c4b1
137 lines
3.4 KiB
XML
137 lines
3.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="intlcalendar.setfirstdayofweek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>IntlCalendar::setFirstDayOfWeek</refname>
|
|
<refpurpose>Set the day on which the week is deemed to start</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>
|
|
&style.oop;
|
|
</para>
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setFirstDayOfWeek</methodname>
|
|
<methodparam><type>int</type><parameter>dayOfWeek</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
&style.procedural;
|
|
</para>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>intlcal_set_first_day_of_week</methodname>
|
|
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>dayOfWeek</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Defines the day of week deemed to start the week. This affects the behavior
|
|
of fields that depend on the concept of week start and end such as
|
|
<constant>IntlCalendar::FIELD_WEEK_OF_YEAR</constant> and
|
|
<constant>IntlCalendar::FIELD_YEAR_WOY</constant>.
|
|
</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>dayOfWeek</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of the constants <constant>IntlCalendar::DOW_SUNDAY</constant>,
|
|
<constant>IntlCalendar::DOW_MONDAY</constant>, …,
|
|
<constant>IntlCalendar::DOW_SATURDAY</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &true; on success. Failure can only happen due to invalid parameters.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>IntlCalendar::setFirstDayOfWeek</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
ini_set('date.timezone', 'Europe/Lisbon');
|
|
ini_set('intl.default_locale', 'es_ES');
|
|
|
|
$cal = IntlCalendar::createInstance();
|
|
$cal->set(2013, 5 /* June */, 30); // A Sunday
|
|
|
|
var_dump($cal->getFirstDayOfWeek()); // 2 (Monday)
|
|
|
|
echo IntlDateFormatter::formatObject($cal, <<<EOD
|
|
'local day of week: 'cc'
|
|
week of month : 'W'
|
|
week of year : 'ww
|
|
EOD
|
|
), "\n";
|
|
|
|
$cal->setFirstDayOfWeek(IntlCalendar::DOW_SUNDAY);
|
|
|
|
echo IntlDateFormatter::formatObject($cal, <<<EOD
|
|
'local day of week: 'cc'
|
|
week of month : 'W'
|
|
week of year : 'ww
|
|
EOD
|
|
), "\n";
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
int(2)
|
|
local day of week: 7
|
|
week of month : 4
|
|
week of year : 26
|
|
local day of week: 1
|
|
week of month : 5
|
|
week of year : 27
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|