DateInterval::format

(PHP 5 >= 5.3.0, PHP 7)

DateInterval::formatFormata um intervalo

Descrição

public string DateInterval::format ( string $format )

Formata um intervalo.

Parâmetros

format

Os caracteres a seguir são reconhecidos como string no parâmetro format. Cada um dos caracteres de formato deve ser precedidos com o sinal de porcento (%).
Caracter de format Descrição Exemplo de valores
% % literal %
Y Anos, em representação numérica, com dois dígitos e zero à esquerda Years, numeric, at least 2 digits with leading 0 01, 03
y Anos, em representação numérica 1, 3
M Meses, em presentação numérica, com dois dígitos e zero à esquerda 01, 03, 12
m Meses, em presentação numérica 1, 3, 12
D Dias, em presentação numérica, com dois dígitos e zero à esquerda 01, 03, 31
d Dias, em presentação numérica 1, 3, 31
a Número total de dias resultante de DateTime::diff() ou (unknown), caso contrário 4, 18, 8123
H Horas, em presentação numérica, com dois dígitos e zero à esquerda 01, 03, 23
h Horas, em presentação numérica 1, 3, 23
I Minutos, em presentação numérica, com dois dígitos e zero à esquerda 01, 03, 59
i Minutos, em presentação numérica 1, 3, 59
S Segundos, em presentação numérica, com dois dígitos e zero à esquerda 01, 03, 57
s Segundos, em presentação numérica 1, 3, 57
R Sinal "-" quando negativo, "+" quando positivo -, +
r Sinal "-" quando negativo, sem sinal quando positivo -,

Valor Retornado

Retorna o intervalo formatado.

Notas

Nota:

O método DateInterval::format() não recalcula os pontos de transferência em strings de tempo que não estejam no segmento da data. Isso é esperado por que não é possível extrapolar valores como em "32 dias" que pode ser interpretado como "1 mês e 4 dias" e até "1 mês e 1 dia".

Exemplos

Exemplo #1 Exemplo da classe DateInterval

<?php

$interval 
= new DateInterval('P2Y4DT6H8M');
echo 
$interval->format('%d days');

?>

O exemplo acima irá imprimir:

4 days

Exemplo #2 A classe DateInterval e os pontos de transferência

<?php

$interval 
= new DateInterval('P32D');
echo 
$interval->format('%d days');

?>

O exemplo acima irá imprimir:

32 days

Exemplo #3 DateInterval e DateTime::diff() com os modificadores %a e %d

<?php

$january 
= new DateTime('2010-01-01');
$february = new DateTime('2010-02-01');
$interval $february->diff($january);

// %a will output the total number of days.
echo $interval->format('%a total days')."\n";

// While %d will only output the number of days not already covered by the
// month.
echo $interval->format('%m month, %d days');

?>

O exemplo acima irá imprimir:

31 total days
1 month, 0 days

Veja Também

add a note add a note

User Contributed Notes 10 notes

up
36
glavic at gmail dot com
4 years ago
How to easy recalculate carry over points:

<?php
class DateIntervalEnhanced extends DateInterval {

    public function
recalculate()
    {
       
$from = new DateTime;
       
$to = clone $from;
       
$to = $to->add($this);
       
$diff = $from->diff($to);
        foreach (
$diff as $k => $v) $this->$k = $v;
        return
$this;
    }

}

$di = new DateIntervalEnhanced('PT3600S');
echo
"Instead of " . $di->format('%h:%i:%s') . " it outputs " . $di->recalculate()->format('%h:%i:%s');
# output will be: "Instead of 0:0:3600 it outputs 1:0:0"
up
14
baptiste dot place at utopiaweb dot fr
7 years ago
With php 5.3, DateTime is sweet !
Here is one quick example :

<?php
/**
* A sweet interval formatting, will use the two biggest interval parts.
* On small intervals, you get minutes and seconds.
* On big intervals, you get months and days.
* Only the two biggest parts are used.
*
* @param DateTime $start
* @param DateTime|null $end
* @return string
*/
public function formatDateDiff($start, $end=null) {
    if(!(
$start instanceof DateTime)) {
       
$start = new DateTime($start);
    }
   
    if(
$end === null) {
       
$end = new DateTime();
    }
   
    if(!(
$end instanceof DateTime)) {
       
$end = new DateTime($start);
    }
   
   
$interval = $end->diff($start);
   
$doPlural = function($nb,$str){return $nb>1?$str.'s':$str;}; // adds plurals
   
   
$format = array();
    if(
$interval->y !== 0) {
       
$format[] = "%y ".$doPlural($interval->y, "year");
    }
    if(
$interval->m !== 0) {
       
$format[] = "%m ".$doPlural($interval->m, "month");
    }
    if(
$interval->d !== 0) {
       
$format[] = "%d ".$doPlural($interval->d, "day");
    }
    if(
$interval->h !== 0) {
       
$format[] = "%h ".$doPlural($interval->h, "hour");
    }
    if(
$interval->i !== 0) {
       
$format[] = "%i ".$doPlural($interval->i, "minute");
    }
    if(
$interval->s !== 0) {
        if(!
count($format)) {
            return
"less than a minute ago";
        } else {
           
$format[] = "%s ".$doPlural($interval->s, "second");
        }
    }
   
   
// We use the two biggest parts
   
if(count($format) > 1) {
       
$format = array_shift($format)." and ".array_shift($format);
    } else {
       
$format = array_pop($format);
    }
   
   
// Prepend 'since ' or whatever you like
   
return $interval->format($format);
}
?>
up
3
balaclark at gmail dot com
6 years ago
Be aware that your default timezone can sometimes alter the result of a diff so that the returned months/days are incorrect.

There is a bug report at: http://bugs.php.net/bug.php?id=52480
up
6
kuzb
6 years ago
Quick class to allow you to input a time in any unit, and have it recalculate in to different denominations (for example, seconds to hours, minutes and seconds):

<?php
   
class DateIntervalEnhanced extends DateInterval
   
{

     
/* Keep in mind that a year is seen in this class as 365 days, and a month is seen as 30 days.        
         It is not possible to calculate how many days are in a given year or month without a point of 
         reference in time.*/
     
public function to_seconds()
      {
        return (
$this->y * 365 * 24 * 60 * 60) +
               (
$this->m * 30 * 24 * 60 * 60) +
               (
$this->d * 24 * 60 * 60) +
               (
$this->h * 60 * 60) +
               (
$this->i * 60) +
              
$this->s;
      }
     
      public function
recalculate()
      {
       
$seconds = $this->to_seconds();
       
$this->y = floor($seconds/60/60/24/365);
       
$seconds -= $this->y * 31536000;
       
$this->m = floor($seconds/60/60/24/30);
       
$seconds -= $this->m * 2592000;
       
$this->d = floor($seconds/60/60/24);
       
$seconds -= $this->d * 86400;
       
$this->h = floor($seconds/60/60);
       
$seconds -= $this->h * 3600;
       
$this->i = floor($seconds/60);
       
$seconds -= $this->i * 60;
       
$this->s = $seconds;
      }
    }

   
// Example usage
   
$di = new DateIntervalEnhanced('PT3600S');
   
$di->recalculate();
   
// outputs 1:0:0 instead of 0:0:3600 now!
   
echo $di->format('%H:%i:%s');
?>
up
1
kulakov74 at yandex dot ru
3 years ago
glavic, this does not eliminate the problem of "32 days", if you use your class for normalizing intervals of days, because the result will depend on the current month which is used for DateTime by default. And if that does not matter (because the interval is not that long) you don't have to call diff() to get the same recalculation:
$DT=new DateTime('0000-01-01'); $DT->add($oInt); echo($DT->format('Y-m-d H:i:s'));
up
1
me at unreal4u dot com
2 years ago
If you want the difference between two timestamps in HOURS, do not forget to add the number of days:

<?php
// Bad example
$lastEntryDate = new \DateTime('2015-05-23 00:10:20', new \DateTimeZone('UTC'));
$dateDifference = $lastEntryDate->diff(new \DateTime('2015-05-25 02:35:45', new \DateTimeZone('UTC')));

var_dump((int)$dateDifference->format('%H'));
// Returns 2
if ((int)$dateDifference->format('%H') > 24) {
       
// Will never enter here, (int)$dateDifference->format('%H') will contain 0-23 ONLY
}
?>

Instead, sum the days:
<?php
// Bad example
$lastEntryDate = new \DateTime('2015-05-23 00:10:20', new \DateTimeZone('UTC'));
$dateDifference = $lastEntryDate->diff(new \DateTime('2015-05-25 02:35:45', new \DateTimeZone('UTC')));

var_dump(($dateDifference->days * 24 + (int)$dateDifference->format('%H')));
// Returns 50
if (($dateDifference->days * 24 + (int)$dateDifference->format('%H')) > 24) {
       
// Will enter here now :)
}
?>

Hope this saves somebody some time and possible bugs :)
up
0
pankajs7590 at gmail dot com
5 months ago
public function getTotalInterval($interval, $type){
        switch($type){
            case 'years':
                return $interval->format('%Y');
                break;
            case 'months':
                $years = $interval->format('%Y');
                $months = 0;
                if($years){
                    $months += $years*12;
                }
                $months += $interval->format('%m');
                return $months;
                break;
            case 'days':
                return $interval->format('%a');
                break;
            case 'hours':
                $days = $interval->format('%a');
                $hours = 0;
                if($days){
                    $hours += 24 * $days;
                }
                $hours += $interval->format('%H');
                return $hours;
                break;
            case 'minutes':
                $days = $interval->format('%a');
                $minutes = 0;
                if($days){
                    $minutes += 24 * 60 * $days;
                }
                $hours = $interval->format('%H');
                if($hours){
                    $minutes += 60 * $hours;
                }
                $minutes += $interval->format('%i');
                return $minutes;
                break;
            case 'seconds':
                $days = $interval->format('%a');
                $seconds = 0;
                if($days){
                    $seconds += 24 * 60 * 60 * $days;
                }
                $hours = $interval->format('%H');
                if($hours){
                    $seconds += 60 * 60 * $hours;
                }
                $minutes = $interval->format('%i');
                if($minutes){
                    $seconds += 60 * $minutes;
                }
                $seconds += $interval->format('%s');
                return $seconds;
                break;
            case 'milliseconds':
                $days = $interval->format('%a');
                $seconds = 0;
                if($days){
                    $seconds += 24 * 60 * 60 * $days;
                }
                $hours = $interval->format('%H');
                if($hours){
                    $seconds += 60 * 60 * $hours;
                }
                $minutes = $interval->format('%i');
                if($minutes){
                    $seconds += 60 * $minutes;
                }
                $seconds += $interval->format('%s');
                $milliseconds = $seconds * 1000;
                return $milliseconds;
                break;
            default:
                return NULL;
        }
    }
up
0
zell1285 at gmail dot com
1 year ago
I was doing this: $endDate->diff($startDate)->format('%a’)
to get the number of the days between the end date and the start date. This is correct, but if I subtract 2016-04-23 00:00:00 to 2016-04-02 09:39:01 (note that in only one of the datetime values we have the time) the result is 21 (and not 20 as I expected). This is because the result of the diff is 20 days AND 14 hours, 20 mins and 59 secs. If you use the %a to get the days from a dateinterval, it will round the days (and if the hours are greater than 12, it will round days up).

So, DO NOT USE the %a formatting to get the difference in days between 2 datetime unless you are 100% sure that both the Datetime objects don't have the time.

You can solve easily with $valueDate->diff($startDate)->days that will return only the days in a dateinterval (without the fuc***g rounding).
up
0
pekka at gmx dot de
6 years ago
Note that `%a` is broken on Windows on VC6 builds. http://bugs.php.net/bug.php?id=51184
up
-1
beowolve at gmail dot com
4 years ago
German Version of formatDateDiff:

function formatDateDiff($start, $end=null) {
    if(!($start instanceof DateTime)) {
        $start = new DateTime($start);
    }

    if($end === null) {
        $end = new DateTime();
    }

    if(!($end instanceof DateTime)) {
        $end = new DateTime($start);
    }

    $interval = $end->diff($start);
    $doPlural = function($nb,$str){
        if ($nb > 1) {
            switch ($str) {
                case 'Jahr':
                case 'Monat':
                case 'Tag':
                    return $str.'e';
                case 'Stunde':
                case 'Minute':
                case 'Sekunde':
                    return $str.'n';
            }
        } else
            return $str;
    }; // adds plurals

    $format = array();
    if($interval->y !== 0) {
        $format[] = "%y ".$doPlural($interval->y, "Jahr");
    }
    if($interval->m !== 0) {
        $format[] = "%m ".$doPlural($interval->m, "Monat");
    }
    if($interval->d !== 0) {
        $format[] = "%d ".$doPlural($interval->d, "Tag");
    }
    if($interval->h !== 0) {
        $format[] = "%h ".$doPlural($interval->h, "Stunde");
    }
    if($interval->i !== 0) {
        $format[] = "%i ".$doPlural($interval->i, "Minute");
    }
    if($interval->s !== 0) {
        $format[] = "%s ".$doPlural($interval->s, "Sekunde");
    }
   
    if(count($format)==0 || (count($format)==1 && $interval->s !== 0)) {
        return "weniger als eine Minute";
    }

    // We use the two biggest parts
    if(count($format) > 1) {
        $format = array_shift($format).", ".array_shift($format);
    } else {
        $format = array_pop($format);
    }

    // Prepend 'since ' or whatever you like
    return $interval->format($format);
}
To Top