downloads | documentation | faq | getting help | mailing lists | licenses | wiki | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

DatePeriod> <DateInterval::createFromDateString
Last updated: Fri, 05 Feb 2010

view this page in

DateInterval::format

(PHP 5 >= 5.3.0)

DateInterval::formatFormats the interval

Description

public string DateInterval::format ( string $format )

Formats the interval.

Parameters

format

The following characters are recognized in the format parameter string. Each format character must be proceeded by a percent sign (%).
format character Description Example values
% Literal % %
Y Years, numeric, at least 2 digits with leading 0 01, 03
y Years, numeric 1, 3
M Months, numeric, at least 2 digits with leading 0 01, 03, 12
m Months, numeric 1, 3, 12
D Days, numeric, at least 2 digits with leading 0 01, 03, 31
d Days, numeric 1, 3, 31
a Total amount of days 4, 18, 8123
H Hours, numeric, at least 2 digits with leading 0 01, 03, 23
h Hours, numeric 1, 3, 23
I Minutes, numeric, at least 2 digits with leading 0 01, 03, 59
i Minutes, numeric 1, 3, 59
S Seconds, numeric, at least 2 digits with leading 0 01, 03, 57
s Seconds, numeric 1, 3, 57
R Sign "-" when negative, "+" when positive -, +
r Sign "-" when negative, empty when positive -,

Return Values

Returns the formatted interval.

Examples

Example #1 DateInterval example

<?php

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

?>

The above example will output:

4 days



add a note add a note User Contributed Notes
DateInterval::format
There are no user contributed notes for this page.

DatePeriod> <DateInterval::createFromDateString
Last updated: Fri, 05 Feb 2010
 
 
show source | credits | stats | sitemap | contact | advertising | mirror sites