PHP - Manual: DatePeriod::__construct

2024-12-21

DatePeriod::__construct

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

DatePeriod::__construct — Creates a new DatePeriod object

说明

public DatePeriod::__construct(
    DateTimeInterface $start,
    DateInterval $interval,
    int $recurrences,
    int $options = 0
)

public DatePeriod::__construct(
    DateTimeInterface $start,
    DateInterval $interval,
    DateTimeInterface $end,
    int $options = 0
)

public DatePeriod::__construct(string $isostr, int $options = 0)

Creates a new DatePeriod object.

参数

start: The start date of the period.
interval: The interval between recurrences within the period.
recurrences: The number of recurrences. Must be greater than 0.
end: The end date of the period.
isostr: An » ISO 8601 repeating interval specification. Zero occurrences (R0/) are not supported.
options: Can be set to DatePeriod::EXCLUDE_START_DATE to exclude the start date from the set of recurring dates within the period.

更新日志

版本	说明
7.2.19, 7.3.6, 7.4.0	`recurrences` must be greater than `0` now.

范例

示例 #1 DatePeriod example


<?php
$start = new DateTime('2012-07-01');
$interval = new DateInterval('P7D');
$end = new DateTime('2012-07-31');
$recurrences = 4;
$iso = 'R4/2012-07-01T00:00:00Z/P7D';

// All of these periods are equivalent.
$period = new DatePeriod($start, $interval, $recurrences);
$period = new DatePeriod($start, $interval, $end);
$period = new DatePeriod($iso);

// By iterating over the DatePeriod object, all of the
// recurring dates within that period are printed.
foreach ($period as $date) {
    echo $date->format('Y-m-d')."\n";
}
?>

以上例程会输出：

示例 #2 DatePeriod example with DatePeriod::EXCLUDE_START_DATE


<?php
$start = new DateTime('2012-07-01');
$interval = new DateInterval('P7D');
$end = new DateTime('2012-07-31');

$period = new DatePeriod($start, $interval, $end,
                         DatePeriod::EXCLUDE_START_DATE);

// By iterating over the DatePeriod object, all of the
// recurring dates within that period are printed.
// Note that, in this case, 2012-07-01 is not printed.
foreach ($period as $date) {
    echo $date->format('Y-m-d')."\n";
}
?>

以上例程会输出：

注释

Unbound numbers of repetitions as specified by ISO 8601 section 4.5 "Recurring time interval" are not supported, i.e. neither passing "R/..." as isostr nor passing null as end would work.

add a note

User Contributed Notes 4 notes

down

simon dot kohlmeyer at mayflower dot de ¶

11 years ago


I found two things useful to know that aren't covered here.


1. endDate is excluded:


<?php

$i = new DateInterval('P1D');

$d1 = new Datetime();

$d2 = clone $d1; $d2->add($i);

foreach(new DatePeriod($d1, $i, $d2) as $d) {

    echo $d->format('Y-m-d H:i:s') . "\n";

}

?>



Will output:

2010-11-03 12:39:53


(Another one because I got it wrong at first)

2. For the first form, recurrences really means REcurrences, not occurences.


<?php

$i = new DateInterval('P1D');

$d = new Datetime();

foreach(new DatePeriod($d, $i, 1) as $d) {

    echo $d->format('Y-m-d H:i:s') . "\n";

}

?>



Will output:

2010-11-03 12:41:05

2010-11-04 12:41:05

down

lars at hp-designs dot com ¶

9 years ago


When you add the time 23:59:59 to the end DateTime object something like the following then the end date will be included in the period:


<?php

$date_start = new DateTime('2012-03-12');

$date_end = new DateTime('2012-03-22 23:59:59');


$interval = '+2 days';

$date_interval = DateInterval::createFromDateString($interval);


$period = new DatePeriod($date_start, $date_interval, $date_end, DatePeriod::EXCLUDE_START_DATE);


foreach($period as $dt) {

 echo $dt->format('d/m');

}

?>



OUTPUT:

14/03

16/03

18/03

20/03

22/03

down

bill at bwi dot com ¶

7 months ago


With reference to the Changelog above, 'recurrences' must be greater than 0 now.

This was not the case in PHP5 ( >= 5.3.0). A foreach loop over a DatePeriod with recurrences == 0 would
execute one time. A function could accept a $count parameter which represented the number of times to execute
the code in a foreach loop, and then initialize a DatePeriod with 'recurrences' == ($count-1) to get the desired
number of iterations.

The following example adds a special case for PHP7 and above to handle the situation where a single
iteration is desired.

Note that an alternative solution to subracting 1 from the desired count is to subtract one month from the desired starting month,       
and then intialize the DatePeriod with the option DatePeriod::EXCLUDE_START_DATE.

<?php
        // displayCalender() is a stub.
        // In a real application, this would generate a displayable calendar for the specified month.
        // 
        // $tp is a DateTime object used to specify the month for which a calendar will be displayed
        function displayCalendar($tp)
        {
                $format = "F, Y";
                echo "Display Calendar for " . $tp->format($format) . "\n";
        }

        // $date is the first month to show
        // $count is the number of months to show
        // NOTE: the number of "recurrences" is one less than the number of months to display
        function showMonths($date = false, $count = 1)
        {
                $format = "Y-m-d 00:00:00";
                $init = ($date ? $date : date($format));
                $one_month = new DateInterval("P1M");

                // get the starting month and day
                $start = new DateTime($init);

                echo "Show $count month" . ($count > 1 ? "s" : "") . "\n";
                //check for PHP7 or greater
                if ($count == 1 && (substr(phpversion(), 0, 1) >= 7) )
                {
                        // Special case for PHP7 when $count == 1
                        displayCalendar($start);
                }   
                else
                {
                        // PHP5 does not need special case, because 0 is accepted value
                        //      for number of recurrences
                        $time_period = new DatePeriod($start, $one_month, ($count-1));
                        foreach ($time_period as $tp)
                        {
                                displayCalendar($tp);
                        }
                }
                echo "\n";
        }
        
        // Show calendar for specific month
        $first_month = "2021-11";
        showMonths($first_month);
        
        // Show calendars for a full year
        $first_month = "2021-01";
        showMonths($first_month, 12);
?>

The above example will output:

Show 1 month
Display Calendar for November, 2021

Show 12 months
Display Calendar for January, 2021
Display Calendar for February, 2021
Display Calendar for March, 2021
Display Calendar for April, 2021
Display Calendar for May, 2021
Display Calendar for June, 2021
Display Calendar for July, 2021
Display Calendar for August, 2021
Display Calendar for September, 2021
Display Calendar for October, 2021
Display Calendar for November, 2021
Display Calendar for December, 2021

down

youssef dot benhssaien at gmail dot com ¶

2 years ago


The parameter isostr should accept an ISO 8601 format, but doing this is not work :
<?php
      $dateStart = date_create('first day of next month this year');

      $isoStr = $dateStart ->format(DateTimeInterface::ISO8601);
      $datePeriod = new DatePeriod("R10/{$isoStr}/P1M");
     // Throw Exception : DatePeriod::__construct(): Unknown or bad format (R10/2020-02-01T22:52:26+0000Z/P1M)
     
     // While doing it by this way works
    $datePeriod = new DatePeriod($dateStart , \DateInterval::createFromDateString("+1 month"), 10);
?>

add a note

官方地址：https://www.php.net/manual/en/dateperiod.construct.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络数据库 JAVA 面试 NoSQL C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 PHP 8.1 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 adodb手册 ADORecordSet对象 opcache预加载 Composer的Packagist资源 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet PHP json解析（json_decode）页面工具 mysql面试题纯php实现DES以及TripleDES加密算法 php 修改图片大小两千行PHP学习笔记支持php7的性能采集扩展利用PHP SOAP实现WEB SERVICE [原创]诡异的php-fpm超时问题

略微加速

PHP官方手册 - 互联网笔记

DatePeriod::__construct

说明

参数

更新日志

范例

注释

User Contributed Notes 4 notes