<!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 sorting key for a string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="collator.getlocale.html">Collator::getLocale</a></div>
<div class="next" style="text-align: right; float: right;"><a href="collator.getstrength.html">Collator::getStrength</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.getsortkey" class="refentry">
<div class="refnamediv">
<h1 class="refname">Collator::getSortKey</h1>
<h1 class="refname">collator_get_sort_key</h1>
<p class="verinfo">(PHP 5 >= 5.3.11, PECL intl >= 1.0.3)</p><p class="refpurpose"><span class="refname">Collator::getSortKey</span> -- <span class="refname">collator_get_sort_key</span> — <span class="dc-title">Get sorting key for a string</span></p>
</div>
<div class="refsect1 description" id="refsect1-collator.getsortkey-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::getSortKey</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</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_sort_key</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">string</span> <code class="parameter">$str</code></span>
)</div>
<p class="para rdfs-comment">
Return collation key for a string.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-collator.getsortkey-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">str</code></em></span>
<dd>
<p class="para">
The string to produce the key from.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-collator.getsortkey-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">Returns the collation key for the string. Collation keys can be compared directly instead of strings.</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code>FALSE</code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code>FALSE</code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>
</div>
<div class="refsect1 examples" id="refsect1-collator.getsortkey-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2496">
<p><strong>Example #1 <span class="function"><strong>collator_get_sort_key()</strong></span>example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$s1 </span><span style="color: #007700">= </span><span style="color: #DD0000">'Hello'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$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' </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">collator_get_sort_key</span><span style="color: #007700">( </span><span style="color: #0000BB">$coll</span><span style="color: #007700">, </span><span style="color: #0000BB">$s1</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">urlencode</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</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"><br />
71%3F%3FE%01%09%01%8F%08%00<br />
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-collator.getsortkey-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="collator.sort.html" class="function" rel="rdfs-seeAlso">collator_sort()</a> - Sort array using specified collator</span></li>
<li class="member"> <span class="function"><a href="collator.sortwithsortkeys.html" class="function" rel="rdfs-seeAlso">collator_sort_with_sort_keys()</a> - Sort array using specified collator and sort keys</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.getlocale.html">Collator::getLocale</a></div>
<div class="next" style="text-align: right; float: right;"><a href="collator.getstrength.html">Collator::getStrength</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>
