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

INTLCALENDAR.GETFIRSTDAYOFWEEK(3)					 1					 INTLCALENDAR.GETFIRSTDAYOFWEEK(3)

IntlCalendar::getFirstDayOfWeek - Get the first day of the week for the calendars locale

	Object oriented style

SYNOPSIS
       public int IntlCalendar::getFirstDayOfWeek (void  )

DESCRIPTION
	Procedural style
       int intlcal_get_first_day_of_week (IntlCalendar	$cal)

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

PARAMETERS
	      o $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(3)

	      <?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

	      The above example will output:

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

SEE ALSO
       IntlCalendar::setFirstDayOfWeek.

PHP Documentation Group 											 INTLCALENDAR.GETFIRSTDAYOFWEEK(3)