intlcalendar.setfirstdayofweek(3) php man page | unix.com

INTLCALENDAR.SETFIRSTDAYOFWEEK(3)					 1					 INTLCALENDAR.SETFIRSTDAYOFWEEK(3)

IntlCalendar::setFirstDayOfWeek - Set the day on which the week is deemed to start

	Object oriented style

SYNOPSIS
       public bool IntlCalendar::setFirstDayOfWeek (int  $dayOfWeek)

DESCRIPTION
	Procedural style
       bool intlcal_set_first_day_of_week (IntlCalendar  $cal, int  $dayOfWeek)

	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 IntlCalendar::FIELD_WEEK_OF_YEAR and IntlCalendar::FIELD_YEAR_WOY.

PARAMETERS
	      o $cal
		- The IntlCalendar resource.

	      o $dayOfWeek
		- One of the constants IntlCalendar::DOW_SUNDAY, IntlCalendar::DOW_MONDAY, , IntlCalendar::DOW_SATURDAY.

RETURN VALUES
	Returns TRUE on success. Failure can only happen due to invalid parameters.

EXAMPLES
       Example #1

	      IntlCalendar.setFirstDayOfWeek(3)

	      <?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
	      week of month    : 'W'
	      week of year     : 'ww
	      EOD
	      ), "
";

	      $cal->setFirstDayOfWeek(IntlCalendar::DOW_SUNDAY);

	      echo IntlDateFormatter::formatObject($cal, <<<EOD
	      week of month    : 'W'
	      week of year     : 'ww
	      EOD
	      ), "
";

	      The above example will output:

	      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

PHP Documentation Group 											 INTLCALENDAR.SETFIRSTDAYOFWEEK(3)