<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get the first day of the week for the calendarʼs locale</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.geterrormessage.html">IntlCalendar::getErrorMessage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlcalendar.getgreatestminimum.html">IntlCalendar::getGreatestMinimum</a></div>
<div class="up"><a href="class.intlcalendar.html">IntlCalendar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="intlcalendar.getfirstdayofweek" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlCalendar::getFirstDayOfWeek</h1>
<p class="verinfo">(PHP 5.5.0, PECL >= 3.0.0a1)</p><p class="refpurpose"><span class="refname">IntlCalendar::getFirstDayOfWeek</span> — <span class="dc-title">Get the first day of the week for the calendarʼs locale</span></p>
</div>
<div class="refsect1 description" id="refsect1-intlcalendar.getfirstdayofweek-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>IntlCalendar::getFirstDayOfWeek</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
The week day deemed to start a week, either the default value for this
locale or the value set with
<span class="function"><a href="intlcalendar.setfirstdayofweek.html" class="function">IntlCalendar::setFirstDayOfWeek()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intlcalendar.getfirstdayofweek-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-intlcalendar.getfirstdayofweek-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
One of the constants <strong><code>IntlCalendar::DOW_SUNDAY</code></strong>,
<strong><code>IntlCalendar::DOW_MONDAY</code></strong>, …,
<strong><code>IntlCalendar::DOW_SATURDAY</code></strong> or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-intlcalendar.getfirstdayofweek-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2604">
<p><strong>Example #1 <span class="function"><strong>IntlCalendar::getFirstDayOfWeek()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />ini_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'date.timezone'</span><span style="color: #007700">, </span><span style="color: #DD0000">'UTC'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$cal1 </span><span style="color: #007700">= </span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">createInstance</span><span style="color: #007700">(</span><span style="color: #0000BB">NULL</span><span style="color: #007700">, </span><span style="color: #DD0000">'es_ES'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal1</span><span style="color: #007700">-></span><span style="color: #0000BB">getFirstDayOfWeek</span><span style="color: #007700">()); </span><span style="color: #FF8000">// Monday<br /></span><span style="color: #0000BB">$cal1</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #0000BB">2013</span><span style="color: #007700">, </span><span style="color: #0000BB">1 </span><span style="color: #FF8000">/* February */</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">); </span><span style="color: #FF8000">// a Sunday<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal1</span><span style="color: #007700">-></span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_WEEK_OF_YEAR</span><span style="color: #007700">)); </span><span style="color: #FF8000">// 5<br /><br /></span><span style="color: #0000BB">$cal2 </span><span style="color: #007700">= </span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">createInstance</span><span style="color: #007700">(</span><span style="color: #0000BB">NULL</span><span style="color: #007700">, </span><span style="color: #DD0000">'en_US'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal2</span><span style="color: #007700">-></span><span style="color: #0000BB">getFirstDayOfWeek</span><span style="color: #007700">()); </span><span style="color: #FF8000">// Sunday<br /></span><span style="color: #0000BB">$cal2</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #0000BB">2013</span><span style="color: #007700">, </span><span style="color: #0000BB">1 </span><span style="color: #FF8000">/* February */</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">); </span><span style="color: #FF8000">// a Sunday<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal2</span><span style="color: #007700">-></span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_WEEK_OF_YEAR</span><span style="color: #007700">)); </span><span style="color: #FF8000">// 6</span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
int(2)
int(5)
int(1)
int(6)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-intlcalendar.getfirstdayofweek-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="intlcalendar.setfirstdayofweek.html" class="methodname" rel="rdfs-seeAlso">IntlCalendar::setFirstDayOfWeek()</a> - Set the day on which the week is deemed to start</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.geterrormessage.html">IntlCalendar::getErrorMessage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlcalendar.getgreatestminimum.html">IntlCalendar::getGreatestMinimum</a></div>
<div class="up"><a href="class.intlcalendar.html">IntlCalendar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
