PHP DateInterval Class

Represents an interval of time between two dates.

class DateInterval {
/* Properties */
public int $y;
public int $m;
public int $d;
public int $h;
public int $i;
public int $s;
public float $f;
public int $invert;
public mixed $days;
public bool $from_string;
public string $date_string;
/* Methods */
public __construct(string $duration)
public static createFromDateString(string $datetime): DateInterval|false
public format(string $format): string
}

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.
$f – Number of microseconds, where 1000000 microseconds is 1 second.

$invert – If the interval represents a negative period of time, its value will be 1, otherwise it will be 0.
$days – If the DateInterval object was created by DateTimeImmutable::diff() or DateTime::diff(), then this is the total number of full days between the start and end dates. Otherwise, $days will be false.

$from_string – If the DateInterval object was created by DateInterval::createFromDateString(), then this property will have a value of true, and the $date_string property will be populated. Otherwise, the value will be false and the $y, $m, $d, $h, $i, $s, $f, $invert, and $days properties will be populated.

$date_string – The string used as argument to DateInterval::createFromDateString().

$one_year = new DateInterval('P1Y');

$one_year_ago = new DateTime();
$one_year_ago->sub($one_year);
echo $one_year_ago->format("d-m-Y");
echo "\n".$one_year->y;
echo "\n".$one_year->m;
echo "\n".$one_year->d;

26-04-2022
 years: 1
 months:0
 days: 0

Methods

__construct

Create a new DateInterval object

public DateInterval::__construct(string $duration)

$dinterval = new DateInterval($duration);

$duration – should be a string representing a format that must begin with P(period) followed by an integer value and one of the following values from the table:

Please note that the value of the $duration string must be an accepted format; it cannot be an empty string or left unspecified.

$one_year = new DateInterval('P1Y');

$one_year_ago = new DateTime();
$one_year_ago->sub($one_year);
echo $one_year_ago->format("d-m-Y");

createFromDateString

Set a DateInterval from the relative parts of the string.

Returns a new DateInterval object if successful, false on failure.

 public static DateInterval::createFromDateString(string $datetime): DateInterval|false

$dinterval = DateInterval::createFromDateString('2 weeks');

In the string, you can use:

• year/s
• month/s
• week/s
• day/s
• second/s
• + en caso de tener que sumar valor
• – en caso de restar otro valor
• ‘first’ | ‘second’ | ‘third’ | ‘fourth’ | ‘fifth’ | ‘sixth’ | ‘seventh’ | ‘eighth’ | ‘ninth’ | ‘tenth’ | ‘eleventh’ | ‘twelfth’ | ‘next’ | ‘last’ | ‘previous’ | ‘this’

format

Format the time interval.

 public DateInterval::format(string $format): string

Here is a fairly comprehensive example of how to use the characters:

$interval = new DateInterval('P1Y2M3DT4H5M6S');
echo $interval->format('La duración es de %r%y años, %m meses, %d días, %h horas, %i minutos y %s segundos.');

La duración es de 1 años, 2 meses, 3 días, 4 horas, 5 minutos y 6 segundos.