<!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>Compare two Unicode strings</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="collator.asort.html">Collator::asort</a></div> <div class="next" style="text-align: right; float: right;"><a href="collator.construct.html">Collator::__construct</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.compare" class="refentry"> <div class="refnamediv"> <h1 class="refname">Collator::compare</h1> <h1 class="refname">collator_compare</h1> <p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">Collator::compare</span> -- <span class="refname">collator_compare</span> — <span class="dc-title">Compare two Unicode strings</span></p> </div> <div class="refsect1 description" id="refsect1-collator.compare-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">int</span> <span class="methodname"><strong>Collator::compare</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str1</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$str2</code></span> )</div> <p class="para rdfs-comment"> Procedural style </p> <div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><strong>collator_compare</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">$str1</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$str2</code></span> )</div> <p class="para rdfs-comment"> Compare two Unicode strings according to collation rules. </p> </div> <div class="refsect1 parameters" id="refsect1-collator.compare-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">str1</code></em></span> <dd> <p class="para"> The first string to compare. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">str2</code></em></span> <dd> <p class="para"> The second string to compare. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-collator.compare-returnvalues"> <h3 class="title">Return Values</h3> <p class="para">Return comparison result:</p> <p class="para"> <ul class="itemizedlist"> <li class="listitem"> <p class="para"> 1 if <em><code class="parameter">str1</code></em> is <em class="emphasis">greater</em> than <em><code class="parameter">str2</code></em> ; </p> </li> <li class="listitem"> <p class="para"> 0 if <em><code class="parameter">str1</code></em> is <em class="emphasis">equal</em> to <em><code class="parameter">str2</code></em>; </p> </li> <li class="listitem"> <p class="para"> -1 if <em><code class="parameter">str1</code></em> is <em class="emphasis">less</em> than <em><code class="parameter">str2</code></em> . </p> </li> </ul> On error <span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span> <strong><code>FALSE</code></strong> is returned. </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.compare-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2489"> <p><strong>Example #1 <span class="function"><strong>collator_compare()</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 /></span><span style="color: #0000BB">$s2 </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_compare</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">, </span><span style="color: #0000BB">$s2 </span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">collator_get_error_message</span><span style="color: #007700">( </span><span style="color: #0000BB">$coll </span><span style="color: #007700">);<br />} else if( </span><span style="color: #0000BB">$res </span><span style="color: #007700">> </span><span style="color: #0000BB">0 </span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"s1 is greater than s2\n"</span><span style="color: #007700">;<br />} else if( </span><span style="color: #0000BB">$res </span><span style="color: #007700">< </span><span style="color: #0000BB">0 </span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"s1 is less than s2\n"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"s1 is equal to s2\n"</span><span style="color: #007700">;<br />}<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 /> s1 is greater than s2<br /> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-collator.compare-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> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="collator.asort.html">Collator::asort</a></div> <div class="next" style="text-align: right; float: right;"><a href="collator.construct.html">Collator::__construct</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>