IntlCalendar::getFirstDayOfWeek

(PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1)

IntlCalendar::getFirstDayOfWeekGet the first day of the week for the calendarʼs locale

Description

Object oriented style

public IntlCalendar::getFirstDayOfWeek ( void ) : int

Procedural style

intlcal_get_first_day_of_week ( IntlCalendar $cal ) : int

The week day deemed to start a week, either the default value for this locale or the value set with IntlCalendar::setFirstDayOfWeek().

Parameters

cal

The IntlCalendar resource.

Return Values

One of the constants IntlCalendar::DOW_SUNDAY, IntlCalendar::DOW_MONDAY, …, IntlCalendar::DOW_SATURDAY or FALSE on failure.

Examples

Example #1 IntlCalendar::getFirstDayOfWeek()

<?php
ini_set
('date.timezone''UTC');

$cal1 IntlCalendar::createInstance(NULL'es_ES');
var_dump($cal1->getFirstDayOfWeek()); // Monday
$cal1->set(2013/* 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/* February */3); // a Sunday
var_dump($cal2->get(IntlCalendar::FIELD_WEEK_OF_YEAR)); // 6

The above example will output:

int(2)
int(5)
int(1)
int(6)

See Also