<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.locale.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'locale.getkeywords.php',
    1 => 'Locale::getKeywords',
    2 => 'Gets the keywords for the input locale',
  ),
  'up' => 
  array (
    0 => 'class.locale.php',
    1 => 'Locale',
  ),
  'prev' => 
  array (
    0 => 'locale.getdisplayvariant.php',
    1 => 'Locale::getDisplayVariant',
  ),
  'next' => 
  array (
    0 => 'locale.getprimarylanguage.php',
    1 => 'Locale::getPrimaryLanguage',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/intl/locale/get-keywords.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="locale.getkeywords" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Locale::getKeywords</h1>
  <h1 class="refname">locale_get_keywords</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">Locale::getKeywords</span> -- <span class="refname">locale_get_keywords</span> &mdash; <span class="dc-title">Gets the keywords for the input locale</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-locale.getkeywords-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="modifier">static</span> <span class="methodname"><strong>Locale::getKeywords</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$locale</code></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span></div>

  <p class="para rdfs-comment">
   Procedural style
  </p>
  <div class="methodsynopsis dc-description"><span class="methodname"><strong>locale_get_keywords</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$locale</code></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span></div>

  <p class="para rdfs-comment">
   Gets the keywords for the input locale.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-locale.getkeywords-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">locale</code></dt>
     <dd>
      <p class="para">
       The locale to extract the keywords from
      </p>
     </dd>
    
   </dl>
  </p>
 </div>



 <div class="refsect1 returnvalues" id="refsect1-locale.getkeywords-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Associative <span class="type"><a href="language.types.array.php" class="type array">array</a></span> containing the keyword-value pairs for this locale
  </p>
  <p class="para">Returns <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds <strong><code><a href="intl.constants.php#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.</p>
 </div>


 <div class="refsect1 examples" id="refsect1-locale.getkeywords-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="function"><strong>locale_get_keywords()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$keywords_arr </span><span style="color: #007700">= </span><span style="color: #0000BB">locale_get_keywords</span><span style="color: #007700">(</span><span style="color: #DD0000">'de_DE@currency=EUR;collation=PHONEBOOK'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$keywords_arr</span><span style="color: #007700">) {<br />    foreach (</span><span style="color: #0000BB">$keywords_arr </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=&gt; </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">\n"</span><span style="color: #007700">;<br />    }<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 />$keywords_arr </span><span style="color: #007700">= </span><span style="color: #0000BB">Locale</span><span style="color: #007700">::</span><span style="color: #0000BB">getKeywords</span><span style="color: #007700">(</span><span style="color: #DD0000">'de_DE@currency=EUR;collation=PHONEBOOK'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$keywords_arr</span><span style="color: #007700">) {<br />    foreach (</span><span style="color: #0000BB">$keywords_arr </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=&gt; </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">\n"</span><span style="color: #007700">;<br />    }<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">collation = PHONEBOOK
currency = EUR</pre>
</div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-locale.getkeywords-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="locale.getallvariants.php" class="function" rel="rdfs-seeAlso">locale_get_all_variants()</a> - Gets the variants for the input locale</span></li>
   </ul>
  </p>
 </div>

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