IntlCalendar::roll()函数—用法及示例

函数名称：IntlCalendar::roll()

适用版本：PHP 5.5.0 及以上版本

函数描述：IntlCalendar::roll() 方法用于在国际化日历对象中滚动指定的字段。

用法：

bool IntlCalendar::roll ( int $field , mixed $amountOrUpOrDown )

参数：

• $field：指定要滚动的字段，可以是以下常量之一：

  • IntlCalendar::FIELD_ERA：时代字段
  • IntlCalendar::FIELD_YEAR：年份字段
  • IntlCalendar::FIELD_MONTH：月份字段
  • IntlCalendar::FIELD_WEEK_OF_YEAR：年中的周数字段
  • IntlCalendar::FIELD_WEEK_OF_MONTH：月中的周数字段
  • IntlCalendar::FIELD_DAY_OF_MONTH：月份中的日期字段
  • IntlCalendar::FIELD_DAY_OF_YEAR：年中的日期字段
  • IntlCalendar::FIELD_DAY_OF_WEEK：周中的日期字段
  • IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH：月中的日期字段
  • IntlCalendar::FIELD_AM_PM：上午/下午字段
  • IntlCalendar::FIELD_HOUR：小时字段
  • IntlCalendar::FIELD_HOUR_OF_DAY：一天中的小时字段
  • IntlCalendar::FIELD_MINUTE：分钟字段
  • IntlCalendar::FIELD_SECOND：秒字段
  • IntlCalendar::FIELD_MILLISECOND：毫秒字段

• $amountOrUpOrDown：滚动的数量或者滚动的方向，可以是以下常量之一：

  • IntlCalendar::RAISE：将字段的值增加给定数量
  • IntlCalendar::LOWER：将字段的值减少给定数量
  • IntlCalendar::KEEP：保持字段的值不变

返回值：

• 成功时返回 true，失败时返回 false。

示例：

$cal = IntlCalendar::createInstance('Asia/Tokyo', 'en_US');
$cal->set(2020, 12, 31); // 设置日期为 2020 年 12 月 31 日

$cal->roll(IntlCalendar::FIELD_MONTH, 1); // 将月份字段增加 1
echo $cal->get(IntlCalendar::FIELD_MONTH); // 输出 1

$cal->roll(IntlCalendar::FIELD_DAY_OF_MONTH, -1); // 将日期字段减少 1
echo $cal->get(IntlCalendar::FIELD_DAY_OF_MONTH); // 输出 30

上述示例中，我们创建了一个国际化日历对象 $cal，并将日期设置为 2020 年 12 月 31 日。然后，我们使用 roll() 方法将月份字段增加 1，输出结果为 1（因为月份是循环的）。接着，我们使用 roll() 方法将日期字段减少 1，输出结果为 30。