php-internal-docs 8.4.8
Unofficial docs for php/php-src
Loading...
Searching...
No Matches
DatePeriod Class Reference
Inheritance diagram for DatePeriod:
IteratorAggregate Traversable

Public Member Functions

 __construct ($start, $interval=UNKNOWN, $end=UNKNOWN, $options=UNKNOWN)
 
 getStartDate ()
 
 getEndDate ()
 
 getDateInterval ()
 
 getRecurrences ()
 
 __serialize ()
 
 __unserialize (array $data)
 
 __wakeup ()
 
 getIterator ()
 

Static Public Member Functions

static createFromISO8601String (string $specification, int $options=0)
 
static __set_state (array $array)
 

Data Fields

const int EXCLUDE_START_DATE = UNKNOWN
 
const int INCLUDE_END_DATE = UNKNOWN
 
DateTimeInterface $start
 
DateTimeInterface $current
 
DateTimeInterface $end
 
DateInterval $interval
 
int $recurrences
 
bool $include_start_date
 
bool $include_end_date
 

Detailed Description

Definition at line 669 of file php_date.stub.php.

Constructor & Destructor Documentation

◆ __construct()

DatePeriod::__construct ( $start,
$interval = UNKNOWN,
$end = UNKNOWN,
$options = UNKNOWN )
Parameters
DateTimeInterface | string$start
DateInterval | int$interval
DateTimeInterface | int$end
int$options

Definition at line 699 of file php_date.stub.php.

Member Function Documentation

◆ __serialize()

DatePeriod::__serialize ( )

◆ __set_state()

static DatePeriod::__set_state ( array $array)
static

@tentative-return-type

Definition at line 721 of file php_date.stub.php.

◆ __unserialize()

DatePeriod::__unserialize ( array $data)

◆ __wakeup()

DatePeriod::__wakeup ( )

@tentative-return-type

Definition at line 718 of file php_date.stub.php.

◆ createFromISO8601String()

static DatePeriod::createFromISO8601String ( string $specification,
int $options = 0 )
static

Definition at line 691 of file php_date.stub.php.

◆ getDateInterval()

DatePeriod::getDateInterval ( )

@tentative-return-type

Definition at line 708 of file php_date.stub.php.

◆ getEndDate()

DatePeriod::getEndDate ( )

@tentative-return-type

Definition at line 705 of file php_date.stub.php.

◆ getIterator()

DatePeriod::getIterator ( )

@tentative-return-type

Implements IteratorAggregate.

Definition at line 723 of file php_date.stub.php.

◆ getRecurrences()

DatePeriod::getRecurrences ( )

@tentative-return-type

Definition at line 711 of file php_date.stub.php.

◆ getStartDate()

DatePeriod::getStartDate ( )

@tentative-return-type

Definition at line 702 of file php_date.stub.php.

Field Documentation

◆ $current

DateTimeInterface DatePeriod::$current

@readonly

Definition at line 679 of file php_date.stub.php.

◆ $end

DateTimeInterface DatePeriod::$end

@readonly

Definition at line 681 of file php_date.stub.php.

◆ $include_end_date

bool DatePeriod::$include_end_date

@readonly

Definition at line 689 of file php_date.stub.php.

◆ $include_start_date

bool DatePeriod::$include_start_date

@readonly

Definition at line 687 of file php_date.stub.php.

◆ $interval

DateInterval DatePeriod::$interval

@readonly

Definition at line 683 of file php_date.stub.php.

◆ $recurrences

int DatePeriod::$recurrences

@readonly

Definition at line 685 of file php_date.stub.php.

◆ $start

DateTimeInterface DatePeriod::$start

@readonly

Definition at line 677 of file php_date.stub.php.

◆ EXCLUDE_START_DATE

const int DatePeriod::EXCLUDE_START_DATE = UNKNOWN

@cvalue PHP_DATE_PERIOD_EXCLUDE_START_DATE

Definition at line 672 of file php_date.stub.php.

◆ INCLUDE_END_DATE

const int DatePeriod::INCLUDE_END_DATE = UNKNOWN

@cvalue PHP_DATE_PERIOD_INCLUDE_END_DATE

Definition at line 674 of file php_date.stub.php.


The documentation for this class was generated from the following file: