The DateInterval class

(PHP 5 >= 5.3.0, PHP 7)

Introduction

Represents a date interval.

A date interval stores either a fixed amount of time (in years, months, days, hours etc) or a relative time string in the format that DateTime's constructor supports.

Class synopsis

DateInterval {

/* Properties */

public integer $y ;

public integer $m ;

public integer $d ;

public integer $h ;

public integer $i ;

public integer $s ;

public integer $invert ;

public mixed $days ;

/* Methods */

public __construct ( string $interval_spec )

public static DateInterval createFromDateString ( string $time )

public string format ( string $format )

}

Properties

y

Number of years.

m

Number of months.

d

Number of days.

h

Number of hours.

i

Number of minutes.

s

Number of seconds.

invert

Is 1 if the interval represents a negative time period and 0 otherwise. See DateInterval::format().

days

If the DateInterval object was created by DateTime::diff(), then this is the total number of days between the start and end dates. Otherwise, days will be FALSE.

Before PHP 5.4.20/5.5.4 instead of FALSE you will receive -99999 upon accessing the property.

DateInterval::__construct — Creates a new DateInterval object
DateInterval::createFromDateString — Sets up a DateInterval from the relative parts of the string
DateInterval::format — Formats the interval

The DateInterval class

Introduction

Class synopsis

Properties

Table of Contents