(PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0)
Collator::compare -- collator_compare — Compare two Unicode strings
Object oriented style
public Collator::compare ( string $str1 , string $str2 ) : int
Procedural style
collator_compare ( Collator $coll , string $str1 , string $str2 ) : int
Compare two Unicode strings according to collation rules.
coll
Collator object.
str1
The first string to compare.
str2
The second string to compare.
Return comparison result:
1 if str1
is greater than str2
;
0 if str1
is equal to str2
;
-1 if str1
is less than str2
.
false
is returned. This function may return Boolean false
, but may also return a non-Boolean value which evaluates to false
. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.
Example #1 collator_compare()example
<?php $s1 = 'Hello'; $s2 = 'hello'; $coll = collator_create( 'en_US' ); $res = collator_compare( $coll, $s1, $s2 ); if ($res === false) { echo collator_get_error_message( $coll ); } else if( $res > 0 ) { echo "s1 is greater than s2\n"; } else if( $res < 0 ) { echo "s1 is less than s2\n"; } else { echo "s1 is equal to s2\n"; } ?>
The above example will output:
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/collator.compare.php