<!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>Get the locale name of the collator</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="collator.geterrormessage.html">Collator::getErrorMessage</a></div> <div class="next" style="text-align: right; float: right;"><a href="collator.getsortkey.html">Collator::getSortKey</a></div> <div class="up"><a href="class.collator.html">Collator</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="collator.getlocale" class="refentry"> <div class="refnamediv"> <h1 class="refname">Collator::getLocale</h1> <h1 class="refname">collator_get_locale</h1> <p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">Collator::getLocale</span> -- <span class="refname">collator_get_locale</span> — <span class="dc-title">Get the locale name of the collator</span></p> </div> <div class="refsect1 description" id="refsect1-collator.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="type">string</span> <span class="methodname"><strong>Collator::getLocale</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</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>collator_get_locale</strong></span> ( <span class="methodparam"><span class="type"><a href="class.collator.html" class="type Collator">Collator</a></span> <code class="parameter">$coll</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span> )</div> <p class="para rdfs-comment"> Get collector locale name. </p> </div> <div class="refsect1 parameters" id="refsect1-collator.getlocale-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">coll</code></em></span> <dd> <p class="para"> <a href="class.collator.html" class="classname">Collator</a> object. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">type</code></em></span> <dd> <p class="para"> You can choose between valid and actual locale ( <strong><code>Locale::VALID_LOCALE</code></strong> and <strong><code>Locale::ACTUAL_LOCALE</code></strong>, respectively). </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-collator.getlocale-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Real locale name from which the collation data comes. If the collator was instantiated from rules or an error occurred, returns <span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span> <strong><code>FALSE</code></strong>. </p> </div> <div class="refsect1 examples" id="refsect1-collator.getlocale-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2495"> <p><strong>Example #1 <span class="function"><strong>collator_get_locale()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$coll </span><span style="color: #007700">= </span><span style="color: #0000BB">collator_create</span><span style="color: #007700">( </span><span style="color: #DD0000">'en_US_California' </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$res_val </span><span style="color: #007700">= </span><span style="color: #0000BB">collator_get_locale</span><span style="color: #007700">( </span><span style="color: #0000BB">$coll</span><span style="color: #007700">, </span><span style="color: #0000BB">Locale</span><span style="color: #007700">::</span><span style="color: #0000BB">VALID_LOCALE </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$res_act </span><span style="color: #007700">= </span><span style="color: #0000BB">collator_get_locale</span><span style="color: #007700">( </span><span style="color: #0000BB">$coll</span><span style="color: #007700">, </span><span style="color: #0000BB">Locale</span><span style="color: #007700">::</span><span style="color: #0000BB">ACTUAL_LOCALE </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">( </span><span style="color: #DD0000">"Valid locale name: %s\nActual locale name: %s\n"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$res_val</span><span style="color: #007700">, </span><span style="color: #0000BB">$res_act </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></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> Requested locale name: en_US_California Valid locale name: en_US Actual locale name: en </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-collator.getlocale-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="collator.create.html" class="function" rel="rdfs-seeAlso">collator_create()</a> - Create a collator</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="collator.geterrormessage.html">Collator::getErrorMessage</a></div> <div class="next" style="text-align: right; float: right;"><a href="collator.getsortkey.html">Collator::getSortKey</a></div> <div class="up"><a href="class.collator.html">Collator</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>