<!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>Returns a key-value array of locale ID subtag elements.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="locale.lookup.html">Locale::lookup</a></div>
<div class="next" style="text-align: right; float: right;"><a href="locale.setdefault.html">Locale::setDefault</a></div>
<div class="up"><a href="class.locale.html">Locale</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="locale.parselocale" class="refentry">
<div class="refnamediv">
<h1 class="refname">Locale::parseLocale</h1>
<h1 class="refname">locale_parse</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">Locale::parseLocale</span> -- <span class="refname">locale_parse</span> — <span class="dc-title">Returns a key-value array of locale ID subtag elements.</span></p>
</div>
<div class="refsect1 description" id="refsect1-locale.parselocale-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="type">array</span>
<span class="methodname"><strong>Locale::parseLocale</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$locale</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>locale_parse</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$locale</code></span>
)</div>
<p class="para rdfs-comment">
Returns a key-value array of locale ID subtag elements.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-locale.parselocale-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">locale</code></em></span>
<dd>
<p class="para">
The locale to extract the subtag array from. Note: The 'variant' and
'private' subtags can take maximum 15 values whereas 'extlang' can take
maximum 3 values.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-locale.parselocale-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array containing a list of key-value pairs, where the keys
identify the particular locale ID subtags, and the values are the
associated subtag values. The array will be ordered as the locale id
subtags e.g. in the locale id if variants are '-varX-varY-varZ' then the
returned array will have variant0=>varX , variant1=>varY ,
variant2=>varZ
</p>
</div>
<div class="refsect1 examples" id="refsect1-locale.parselocale-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2563">
<p><strong>Example #1 <span class="function"><strong>locale_parse()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$arr </span><span style="color: #007700">= </span><span style="color: #0000BB">locale_parse</span><span style="color: #007700">(</span><span style="color: #DD0000">'sl-Latn-IT-nedis'</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 /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-2564">
<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 />$arr </span><span style="color: #007700">= </span><span style="color: #0000BB">Locale</span><span style="color: #007700">::</span><span style="color: #0000BB">parseLocale</span><span style="color: #007700">(</span><span style="color: #DD0000">'sl-Latn-IT-nedis'</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 /></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>
language : sl , script : Latn , region : IT , variant0 : NEDIS ,
</pre></div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-locale.parselocale-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="locale.composelocale.html" class="function" rel="rdfs-seeAlso">locale_compose()</a> - Returns a correctly ordered and delimited locale ID</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="locale.lookup.html">Locale::lookup</a></div>
<div class="next" style="text-align: right; float: right;"><a href="locale.setdefault.html">Locale::setDefault</a></div>
<div class="up"><a href="class.locale.html">Locale</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
