<!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>Parse string to a field-based time value</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intldateformatter.islenient.html">IntlDateFormatter::isLenient</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intldateformatter.parse.html">IntlDateFormatter::parse</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.localtime" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlDateFormatter::localtime</h1>
<h1 class="refname">datefmt_localtime</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">IntlDateFormatter::localtime</span> -- <span class="refname">datefmt_localtime</span> — <span class="dc-title">Parse string to a field-based time value</span></p>
</div>
<div class="refsect1 description" id="refsect1-intldateformatter.localtime-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">array</span> <span class="methodname"><strong>IntlDateFormatter::localtime</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$position</code></span>
] )</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>datefmt_localtime</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">string</span> <code class="parameter">$value</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$position</code></span>
] )</div>
<p class="para rdfs-comment">
Converts string $value to a field-based time value ( an array of various fields), starting at
$parse_pos and consuming as much of the input value as possible.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intldateformatter.localtime-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 formatter resource
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
string to convert to a time
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">position</code></em></span>
<dd>
<p class="para">
Position at which to start the parsing in $value (zero-based).
If no error occurs before $value is consumed, $parse_pos will contain -1
otherwise it will contain the position at which parsing ended .
If $parse_pos > strlen($value), the parse fails immediately.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-intldateformatter.localtime-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Localtime compatible array of integers : contains 24 hour clock value in tm_hour field
</p>
</div>
<div class="refsect1 examples" id="refsect1-intldateformatter.localtime-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2651">
<p><strong>Example #1 <span class="function"><strong>datefmt_localtime()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><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 /></span><span style="color: #0000BB">$arr </span><span style="color: #007700">= </span><span style="color: #0000BB">datefmt_localtime</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #DD0000">'Wednesday, December 31, 1969 4:00:00 PM PT'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'First parsed output is '</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">$arr</span><span style="color: #007700">) {<br /> foreach (</span><span style="color: #0000BB">$arr </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$key</span><span style="color: #DD0000"> : </span><span style="color: #0000BB">$value</span><span style="color: #DD0000"> , "</span><span style="color: #007700">;<br /> }<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-2652">
<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 /></span><span style="color: #0000BB">$arr </span><span style="color: #007700">= </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">localtime</span><span style="color: #007700">(</span><span style="color: #DD0000">'Wednesday, December 31, 1969 4:00:00 PM PT'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">'First parsed output is '</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">$arr</span><span style="color: #007700">) {<br /> foreach (</span><span style="color: #0000BB">$arr </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$key</span><span style="color: #DD0000"> : </span><span style="color: #0000BB">$value</span><span style="color: #DD0000"> , "</span><span style="color: #007700">;<br /> }<br />}<br /><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 parsed output is tm_sec : 0 , tm_min : 0 , tm_hour : 16 , tm_year : 1969 ,
tm_mday : 31 , tm_wday : 4 , tm_yday : 365 , tm_mon : 11 , tm_isdst : 0 ,
</pre></div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-intldateformatter.localtime-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.format.html" class="function" rel="rdfs-seeAlso">datefmt_format()</a> - Format the date/time value as a string</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>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intldateformatter.islenient.html">IntlDateFormatter::isLenient</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intldateformatter.parse.html">IntlDateFormatter::parse</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>
