<!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>Checks if a language tag filter matches with locale</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="locale.composelocale.html">Locale::composeLocale</a></div>
<div class="next" style="text-align: right; float: right;"><a href="locale.getallvariants.html">Locale::getAllVariants</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.filtermatches" class="refentry">
<div class="refnamediv">
<h1 class="refname">Locale::filterMatches</h1>
<h1 class="refname">locale_filter_matches</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">Locale::filterMatches</span> -- <span class="refname">locale_filter_matches</span> — <span class="dc-title">Checks if a language tag filter matches with locale</span></p>
</div>
<div class="refsect1 description" id="refsect1-locale.filtermatches-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">bool</span>
<span class="methodname"><strong>Locale::filterMatches</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$langtag</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$locale</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$canonicalize</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span>
<span class="methodname"><strong>locale_filter_matches</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$langtag</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$locale</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$canonicalize</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Checks if a $langtag filter matches with $locale according to RFC 4647's
basic filtering algorithm
</p>
</div>
<div class="refsect1 parameters" id="refsect1-locale.filtermatches-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">langtag</code></em></span>
<dd>
<p class="para">
The language tag to check
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">locale</code></em></span>
<dd>
<p class="para">
The language range to check against
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">canonicalize</code></em></span>
<dd>
<p class="para">
If true, the arguments will be converted to canonical form before
matching.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-locale.filtermatches-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<strong><code>TRUE</code></strong> if $locale matches $langtag <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-locale.filtermatches-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2537">
<p><strong>Example #1 <span class="function"><strong>locale_filter_matches()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo (</span><span style="color: #0000BB">locale_filter_matches</span><span style="color: #007700">(</span><span style="color: #DD0000">'de-DEVA'</span><span style="color: #007700">,</span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">)) ? </span><span style="color: #DD0000">"Matches" </span><span style="color: #007700">: </span><span style="color: #DD0000">"Does not match"</span><span style="color: #007700">; <br />echo </span><span style="color: #DD0000">'; '</span><span style="color: #007700">;<br />echo (</span><span style="color: #0000BB">locale_filter_matches</span><span style="color: #007700">(</span><span style="color: #DD0000">'de-DE_1996'</span><span style="color: #007700">,</span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">)) ? </span><span style="color: #DD0000">"Matches" </span><span style="color: #007700">: </span><span style="color: #DD0000">"Does not match"</span><span style="color: #007700">; <br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-2538">
<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 /></span><span style="color: #007700">echo (</span><span style="color: #0000BB">Locale</span><span style="color: #007700">::</span><span style="color: #0000BB">filterMatches</span><span style="color: #007700">(</span><span style="color: #DD0000">'de-DEVA'</span><span style="color: #007700">,</span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">)) ? </span><span style="color: #DD0000">"Matches" </span><span style="color: #007700">: </span><span style="color: #DD0000">"Does not match"</span><span style="color: #007700">; <br />echo </span><span style="color: #DD0000">'; '</span><span style="color: #007700">;<br />echo (</span><span style="color: #0000BB">Locale</span><span style="color: #007700">::</span><span style="color: #0000BB">filterMatches</span><span style="color: #007700">(</span><span style="color: #DD0000">'de-DE-1996'</span><span style="color: #007700">,</span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">)) ? </span><span style="color: #DD0000">"Matches" </span><span style="color: #007700">: </span><span style="color: #DD0000">"Does not match"</span><span style="color: #007700">; <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>
Does not match; Matches
</pre></div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-locale.filtermatches-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="locale.lookup.html" class="function" rel="rdfs-seeAlso">locale_lookup()</a> - Searches the language tag list for the best match to the language</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.composelocale.html">Locale::composeLocale</a></div>
<div class="next" style="text-align: right; float: right;"><a href="locale.getallvariants.html">Locale::getAllVariants</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>
