カレンダーのロケールに基づいて、週の始めの日を返す

# IntlCalendar::getFirstDayOfWeek

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

IntlCalendar::getFirstDayOfWeek — カレンダーのロケールに基づいて、週の始めの日を返す

### 説明

オブジェクト指向型

public function IntlCalendar::getFirstDayOfWeek(): int|false

手続き型

function intlcal_get_first_day_of_week(IntlCalendar `$calendar`): int|false

週の始めにあたる平日を返します。 これはロケールに基づくデフォルト値か、 IntlCalendar::setFirstDayOfWeek() で設定された値です。

### パラメータ

`calendar`
  IntlCalendar クラスのインスタンス。

### 戻り値

`IntlCalendar::DOW_SUNDAY`, `IntlCalendar::DOW_MONDAY`, …, `IntlCalendar::DOW_SATURDAY` の定数のうち、いずれかを返します。 失敗した場合に `false` を返します.

### 例

例1 IntlCalendar::getFirstDayOfWeek()

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

上の例の出力は以下となります。

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

### 参考

- IntlCalendar::setFirstDayOfWeek() - 週の始まりと見なされる曜日を設定する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open