DateInterval::format

(PHP 5 >= 5.3.0)

DateInterval::formatFormatea el intervalo

Descripción

public string DateInterval::format ( string $format )

Formatea el intervalo.

Parámetros

format

Los siguietes caracteres están reconocidos en el parámetro de cadena format. Cada carácter de formato debe ser prefijado con un signo (%).
Carácter format Descripción Valores de ejemplo
% Literal % %
Y Años, numérico, al menos 2 dígitos empezando con 0 01, 03
y Años, numérico 1, 3
M Meses, numérico, al menos 2 dígitos empezando con 0 01, 03, 12
m Meses, numérico 1, 3, 12
D Días, numérico, al menos 2 dígitos empezando con 0 01, 03, 31
d Días, numérico 1, 3, 31
a Número total de días como resultado de una operación con DateTime::diff(), o de lo contrario (unknown) 4, 18, 8123
H Horas, numérico, al menos 2 dígitos empezando con 0 01, 03, 23
h Horas, numérico 1, 3, 23
I Minutos, numérico, al menos 2 dígitos empezando con 0 01, 03, 59
i Minutos, numérico 1, 3, 59
S Segundos, numérico, al menos 2 dígitos empezando con 0 01, 03, 57
s Segundos, numérico 1, 3, 57
R Signo "-" cuando es negativo, "+" cuando es positivo -, +
r Signo "-" cuando es negativo, vacío cuando es positivo -,

Valores devueltos

Devuelve el intervalo formateado.

Notas

Nota:

El método DateInterval::format() no recalcula los excesos en cadenas de hora ni en segmentos de fecha. Esto es así porque no es posible analizar valores como "32 días" el cual podría ser interpretado como cualquier cosa desde "1 mes y 4 días" hasta "1 mes y un día".

Ejemplos

Ejemplo #1 Ejemplo de DateInterval

<?php

$intervalo 
= new DateInterval('P2Y4DT6H8M');
echo 
$intervalo->format('%d días');

?>

El resultado del ejemplo sería:

4 días

Ejemplo #2 DateInterval y excesos

<?php
 
$intervalo 
= new DateInterval('P32D');
echo 
$intervalo->format('%d días');

?>

El resultado del ejemplo sería:

32 días

Ejemplo #3 DateInterval and DateTime::diff() with the %a and %d modifiers

<?php

$enero 
= new DateTime('2010-01-01');
$febrero = new DateTime('2010-02-01');
$intervalo $febrero->diff($enero);

// %a imprimirá el múmero total de días.
echo $intervalo->format('%a total de días')."\n";

// Mientras que %d sólo imprimirá el múmero total de días no cubiertos por el
// mes.
echo $intervalo->format('%m mes, %d días');

?>

El resultado del ejemplo sería:

31 total days
1 month, 0 days

Ver también

add a note add a note

User Contributed Notes 7 notes

up
11
glavic at gmail dot com
1 year 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
5
baptiste dot place at utopiaweb dot fr
4 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
1
balaclark at gmail dot com
3 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
1
pekka at gmx dot de
3 years ago
Note that `%a` is broken on Windows on VC6 builds. http://bugs.php.net/bug.php?id=51184
up
1
kuzb
3 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
0
kulakov74 at yandex dot ru
9 months 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
0
beowolve at gmail dot com
1 year 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