getfirstdayofweek.xml

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

<refentry xml:id="intlcalendar.getfirstdayofweek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlCalendar::getFirstDayOfWeek</refname>
  <refpurpose>Get the first day of the week for the calendarʼs locale</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis>
   <modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getFirstDayOfWeek</methodname>
   <void />
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type>int</type><methodname>intlcal_get_first_day_of_week</methodname>
   <methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
  </methodsynopsis>
  <para>
   The week day deemed to start a week, either the default value for this
   locale or the value set with
   <function>IntlCalendar::setFirstDayOfWeek</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>cal</parameter></term>
    <listitem>
     <para>
      The IntlCalendar resource.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   One of the constants <constant>IntlCalendar::DOW_SUNDAY</constant>,
   <constant>IntlCalendar::DOW_MONDAY</constant>, …,
   <constant>IntlCalendar::DOW_SATURDAY</constant>&return.falseforfailure;.
  </para>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
   <title><function>IntlCalendar::getFirstDayOfWeek</function></title>
    <programlisting role="php">
<![CDATA[
<?php
ini_set('date.timezone', 'UTC');

$cal1 = IntlCalendar::createInstance(NULL, 'es_ES');
var_dump($cal1->getFirstDayOfWeek()); // Monday
$cal1->set(2013, 1 /* February */, 3); // a Sunday
var_dump($cal1->get(IntlCalendar::FIELD_WEEK_OF_YEAR)); // 5

$cal2 = IntlCalendar::createInstance(NULL, 'en_US');
var_dump($cal2->getFirstDayOfWeek()); // Sunday
$cal2->set(2013, 1 /* February */, 3); // a Sunday
var_dump($cal2->get(IntlCalendar::FIELD_WEEK_OF_YEAR)); // 6
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int(2)
int(5)
int(1)
int(6)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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