<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Format the date/time value as a string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intldateformatter.create.html">IntlDateFormatter::create</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intldateformatter.formatobject.html">IntlDateFormatter::formatObject</a></div>
<div class="up"><a href="class.intldateformatter.html">IntlDateFormatter</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="intldateformatter.format" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlDateFormatter::format</h1>
<h1 class="refname">datefmt_format</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">IntlDateFormatter::format</span> -- <span class="refname">datefmt_format</span> — <span class="dc-title">Format the date/time value as a string</span></p>
</div>
<div class="refsect1 description" id="refsect1-intldateformatter.format-description">
<h3 class="title">Description</h3>
<p class="para">
Object oriented style
</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>IntlDateFormatter::format</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>datefmt_format</strong></span>
( <span class="methodparam"><span class="type"><a href="class.intldateformatter.html" class="type IntlDateFormatter">IntlDateFormatter</a></span> <code class="parameter">$fmt</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
Formats the time value as a string.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intldateformatter.format-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">fmt</code></em></span>
<dd>
<p class="para">
The date formatter resource.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
Value to format. This may be a <a href="class.datetime.html" class="classname">DateTime</a> object, an
<a href="class.intlcalendar.html" class="classname">IntlCalendar</a> object, a <span class="type"><span class="type numeric">numeric</span></span> type
representing a (possibly fractional) number of seconds since epoch or an
<span class="type"><a href="language.types.array.html" class="type array">array</a></span> in the format output by
<span class="function"><a href="function.localtime.html" class="function">localtime()</a></span>.
</p>
<p class="para">
If a <a href="class.datetime.html" class="classname">DateTime</a> or an
<a href="class.intlcalendar.html" class="classname">IntlCalendar</a> object is passed, its timezone is not
considered. The object will be formatted using the formaterʼs configured
timezone. If one wants to use the timezone of the object to be formatted,
<span class="function"><a href="intldateformatter.settimezone.html" class="function">IntlDateFormatter::setTimeZone()</a></span> must be called before
with the objectʼs timezone. Alternatively, the static function
<span class="function"><a href="intldateformatter.formatobject.html" class="function">IntlDateFormatter::formatObject()</a></span> may be used instead.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-intldateformatter.format-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The formatted string or, if an error occurred, <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-intldateformatter.format-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.5.0/PECL 3.0.0</td>
<td>
Support for providing <a href="class.intlcalendar.html" class="classname">IntlCalendar</a> objects to the
<em><code class="parameter">value</code></em> parameter was added.
</td>
</tr>
<tr>
<td>5.3.4</td>
<td>
Support for providing <a href="class.datetime.html" class="classname">DateTime</a> objects to the
<em><code class="parameter">value</code></em> parameter was added.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-intldateformatter.format-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2627">
<p><strong>Example #1 <span class="function"><strong>datefmt_format()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fmt </span><span style="color: #007700">= </span><span style="color: #0000BB">datefmt_create</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'en_US'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'America/Los_Angeles'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN<br /></span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'First Formatted output is ' </span><span style="color: #007700">. </span><span style="color: #0000BB">datefmt_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fmt </span><span style="color: #007700">= </span><span style="color: #0000BB">datefmt_create</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'America/Los_Angeles'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN<br /></span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'Second Formatted output is ' </span><span style="color: #007700">. </span><span style="color: #0000BB">datefmt_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fmt </span><span style="color: #007700">= </span><span style="color: #0000BB">datefmt_create</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'en_US'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'America/Los_Angeles'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'MM/dd/yyyy'<br /></span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'First Formatted output with pattern is ' </span><span style="color: #007700">. </span><span style="color: #0000BB">datefmt_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fmt </span><span style="color: #007700">= </span><span style="color: #0000BB">datefmt_create</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'America/Los_Angeles'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'MM/dd/yyyy'<br /></span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Second Formatted output with pattern is " </span><span style="color: #007700">. </span><span style="color: #0000BB">datefmt_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-2628">
<p><strong>Example #2 OO example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fmt </span><span style="color: #007700">= new </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'en_US'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'America/Los_Angeles'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN<br /></span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'First Formatted output is ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fmt </span><span style="color: #007700">= new </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'America/Los_Angeles'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN<br /></span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'Second Formatted output is ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fmt </span><span style="color: #007700">= new </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'en_US'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'America/Los_Angeles'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'MM/dd/yyyy'<br /></span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'First Formatted output with pattern is ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fmt </span><span style="color: #007700">= new </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'America/Los_Angeles'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'MM/dd/yyyy'<br /></span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'Second Formatted output with pattern is ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<p class="para">The above example will output:</p>
<div class="example-contents screen">
<div class="cdata"><pre>
First Formatted output is Wednesday, December 31, 1969 4:00:00 PM PT
Second Formatted output is Mittwoch, 31. Dezember 1969 16:00 Uhr GMT-08:00
First Formatted output with pattern is 12/31/1969
Second Formatted output with pattern is 12/31/1969
</pre></div>
</div>
<div class="example" id="example-2629">
<p><strong>Example #3 With <a href="class.intlcalendar.html" class="classname">IntlCalendar</a> object</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$tz </span><span style="color: #007700">= </span><span style="color: #0000BB">reset</span><span style="color: #007700">(</span><span style="color: #0000BB">iterator_to_array</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlTimeZone</span><span style="color: #007700">::</span><span style="color: #0000BB">createEnumeration</span><span style="color: #007700">(</span><span style="color: #DD0000">'FR'</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">$formatter </span><span style="color: #007700">= </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">create</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'fr_FR'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">FULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$tz</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">GREGORIAN<br /></span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$cal </span><span style="color: #007700">= </span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">createInstance</span><span style="color: #007700">(</span><span style="color: #0000BB">$tz</span><span style="color: #007700">, </span><span style="color: #DD0000">'@calendar=islamic-civil'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_MONTH</span><span style="color: #007700">, </span><span style="color: #0000BB">8</span><span style="color: #007700">); </span><span style="color: #FF8000">//9th month, Ramadan<br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_DAY_OF_MONTH</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">); </span><span style="color: #FF8000">//1st day<br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">clear</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_HOUR_OF_DAY</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">clear</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_MINUTE</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">clear</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_SECOND</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">clear</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_MILLISECOND</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"In this islamic year, Ramadan started/will start on:\n\t"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$formatter</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">//Itʼs the formatterʼs timezone that is used:<br /></span><span style="color: #0000BB">$formatter</span><span style="color: #007700">-></span><span style="color: #0000BB">setTimeZone</span><span style="color: #007700">(</span><span style="color: #DD0000">'Asia/Tokyo'</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"After changing timezone:\n\t"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$formatter</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;</span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
In this islamic year, Ramadan started/will start on:
mardi 9 juillet 2013 19:00:00 heure avancée d’Europe centrale
After changing timezone:
mercredi 10 juillet 2013 02:00:00 heure normale du Japon
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-intldateformatter.format-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="intldateformatter.create.html" class="function" rel="rdfs-seeAlso">datefmt_create()</a> - Create a date formatter</span></li>
<li class="member"> <span class="function"><a href="intldateformatter.parse.html" class="function" rel="rdfs-seeAlso">datefmt_parse()</a> - Parse string to a timestamp value</span></li>
<li class="member"> <span class="function"><a href="intldateformatter.geterrorcode.html" class="function" rel="rdfs-seeAlso">datefmt_get_error_code()</a> - Get the error code from last operation</span></li>
<li class="member"> <span class="function"><a href="intldateformatter.geterrormessage.html" class="function" rel="rdfs-seeAlso">datefmt_get_error_message()</a> - Get the error text from the last operation.</span></li>
<li class="member"> <span class="function"><a href="intldateformatter.formatobject.html" class="function" rel="rdfs-seeAlso">datefmt_format_object()</a> - Formats an object</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intldateformatter.create.html">IntlDateFormatter::create</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intldateformatter.formatobject.html">IntlDateFormatter::formatObject</a></div>
<div class="up"><a href="class.intldateformatter.html">IntlDateFormatter</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
