<!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 time of the day at which weekend begins or ends</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.gettype.html">IntlCalendar::getType</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlcalendar.indaylighttime.html">IntlCalendar::inDaylightTime</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.getweekendtransition" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlCalendar::getWeekendTransition</h1>
<p class="verinfo">(PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1)</p><p class="refpurpose"><span class="refname">IntlCalendar::getWeekendTransition</span> — <span class="dc-title">Get time of the day at which weekend begins or ends</span></p>
</div>
<div class="refsect1 description" id="refsect1-intlcalendar.getweekendtransition-description">
<h3 class="title">Description</h3>
<p class="para">
Object oriented style
</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>IntlCalendar::getWeekendTransition</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$dayOfWeek</code></span>
)</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>intlcal_get_weekend_transition</strong></span>
( <span class="methodparam"><span class="type"><a href="class.intlcalendar.html" class="type IntlCalendar">IntlCalendar</a></span> <code class="parameter">$cal</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dayOfWeek</code></span>
)</div>
<p class="para rdfs-comment">
Returns the number of milliseconds after midnight at which the weekend
begins or ends.
</p>
<p class="para">
This is only applicable for days of the week for which
<span class="function"><a href="intlcalendar.getdayofweektype.html" class="function">IntlCalendar::getDayOfWeekType()</a></span> returns either
<strong><code>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</code></strong> or
<strong><code>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</code></strong>. Calling this
function for other days of the week is an error condition.
</p>
<p class="para">
This function requires ICU 4.4 or later.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intlcalendar.getweekendtransition-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">cal</code></dt>
<dd>
<p class="para">
The IntlCalendar resource.
</p>
</dd>
<dt>
<code class="parameter">dayOfWeek</code></dt>
<dd>
<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>.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-intlcalendar.getweekendtransition-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The number of milliseconds into the day at which the weekend begins or
ends or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-intlcalendar.getweekendtransition-examples">
<h3 class="title">Examples</h3>
<p class="para">
See example on <span class="function"><a href="intlcalendar.getdayofweektype.html" class="function">IntlCalendar::getDayOfWeekType()</a></span>.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.gettype.html">IntlCalendar::getType</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlcalendar.indaylighttime.html">IntlCalendar::inDaylightTime</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>
