<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.intldateformatter.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'intldateformatter.getlocale.php',
    1 => 'IntlDateFormatter::getLocale',
    2 => 'Get the locale used by formatter',
  ),
  'up' => 
  array (
    0 => 'class.intldateformatter.php',
    1 => 'IntlDateFormatter',
  ),
  'prev' => 
  array (
    0 => 'intldateformatter.geterrormessage.php',
    1 => 'IntlDateFormatter::getErrorMessage',
  ),
  'next' => 
  array (
    0 => 'intldateformatter.getpattern.php',
    1 => 'IntlDateFormatter::getPattern',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/intl/dateformatter/get-locale.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="intldateformatter.getlocale" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">IntlDateFormatter::getLocale</h1>
  <h1 class="refname">datefmt_get_locale</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">IntlDateFormatter::getLocale</span> -- <span class="refname">datefmt_get_locale</span> &mdash; <span class="dc-title">Get the locale used by formatter</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-intldateformatter.getlocale-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="methodname"><strong>IntlDateFormatter::getLocale</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$type</code><span class="initializer"> = <strong><code><a href="intl.constants.php#constant.uloc-actual-locale">ULOC_ACTUAL_LOCALE</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Procedural style
  </p>
  <div class="methodsynopsis dc-description"><span class="methodname"><strong>datefmt_get_locale</strong></span>(<span class="methodparam"><span class="type"><a href="class.intldateformatter.php" class="type IntlDateFormatter">IntlDateFormatter</a></span> <code class="parameter">$formatter</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$type</code><span class="initializer"> = <strong><code><a href="intl.constants.php#constant.uloc-actual-locale">ULOC_ACTUAL_LOCALE</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Get locale used by the formatter.
  </p> 
 </div>

 
 <div class="refsect1 parameters" id="refsect1-intldateformatter.getlocale-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">formatter</code></dt>
     <dd>
      <p class="para">
       The formatter resource      
      </p>
     </dd>
    
    
     <dt><code class="parameter">type</code></dt>
     <dd>
      <p class="para">
       You can choose between valid and actual locale (
       <strong><code><a href="class.locale.php#locale.constants.valid-locale">Locale::VALID_LOCALE</a></code></strong>,
       <strong><code><a href="class.locale.php#locale.constants.actual-locale">Locale::ACTUAL_LOCALE</a></code></strong>,
       respectively). The default is the actual locale.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 
 
 <div class="refsect1 returnvalues" id="refsect1-intldateformatter.getlocale-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   The locale of this formatter,  or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>

 
 <div class="refsect1 examples" id="refsect1-intldateformatter.getlocale-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="function"><strong>datefmt_get_locale()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">'locale of the formatter is : ' </span><span style="color: #007700">. </span><span style="color: #0000BB">datefmt_get_locale</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</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">'locale of the formatter is : ' </span><span style="color: #007700">. </span><span style="color: #0000BB">datefmt_get_locale</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</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">?&gt;</span></span></code></div>
    </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>Example #2 OO example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">'locale of the formatter is : ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getLocale</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">-&gt;</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">'locale of the formatter is : ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getLocale</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">-&gt;</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">?&gt;</span></span></code></div>
    </div>

  </div>
  <p class="para">The above example will output:</p>
  <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">locale of the formatter is : en
First Formatted output is Wednesday, December 31, 1969 4:00:00 PM PT
locale of the formatter is : de
Second Formatted output is Mittwoch, 31. Dezember 1969 16:00 Uhr GMT-08:00</pre>
</div>
  </div>
 </div>

 
 <div class="refsect1 seealso" id="refsect1-intldateformatter.getlocale-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="intldateformatter.create.php" class="function" rel="rdfs-seeAlso">datefmt_create()</a> - Create a date formatter</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>