週の始まりと見なされる曜日を設定する

# IntlCalendar::setFirstDayOfWeek

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

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

### 説明

オブジェクト指向型

public function IntlCalendar::setFirstDayOfWeek(int `$dayOfWeek`): true

手続き型

function intlcal_set_first_day_of_week(IntlCalendar `$calendar`, int `$dayOfWeek`): true

週の始まりとみなされる曜日を定義します。 これは、 `IntlCalendar::FIELD_WEEK_OF_YEAR` や `IntlCalendar::FIELD_YEAR_WOY` のような、 週の始まりと終わりの概念に依存したフィールドの振る舞いに影響します。

### パラメータ

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

  `IntlCalendar::DOW_SUNDAY`, `IntlCalendar::DOW_MONDAY`, …, `IntlCalendar::DOW_SATURDAY` のうちのいずれか。

### 戻り値

常に `true` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.2.0 | 戻り値の型が、`true` になりました。これより前のバージョンでは、bool でした。

### 例

例1 IntlCalendar::setFirstDayOfWeek()

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

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

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

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

    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

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