Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Function Reference : String Functions : strnatcmp

strnatcmp

String comparisons using a "natural order" algorithm (PHP 4, PHP 5)
int strnatcmp ( string str1, string str2 )

This function implements a comparison algorithm that orders alphanumeric strings in the way a human being would, this is described as a "natural ordering". Note that this comparison is case sensitive.

Parameters

str1

The first string.

str2

The second string.

Return Values

Similar to other string comparison functions, this one returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.

Examples

An example of the difference between this algorithm and the regular computer string sorting algorithms (used in strcmp()) can be seen below:

<?php
$arr1
= $arr2 = array("img12.png", "img10.png", "img2.png", "img1.png");
echo
"Standard string comparison\n";
usort($arr1, "strcmp");
print_r($arr1);
echo
"\nNatural order string comparison\n";
usort($arr2, "strnatcmp");
print_r($arr2);
?>

The above example will output:

Standard string comparison
Array
(
   [0] => img1.png
   [1] => img10.png
   [2] => img12.png
   [3] => img2.png
)

Natural order string comparison
Array
(
   [0] => img1.png
   [1] => img2.png
   [2] => img10.png
   [3] => img12.png
)

For more information see: Martin Pool's » Natural Order String Comparison page.

Code Examples / Notes » strnatcmp

thomas

There seems to be a bug in the localization for strnatcmp and strnatcasecmp. I searched the reported bugs and found a few entries which were up to four years old (but the problem still exists when using swedish characters).
These functions might work instead.
<?php
function _strnatcasecmp($left, $right) {
 return _strnatcmp(strtolower($left), strtolower($right));
}
function _strnatcmp($left, $right) {
 while((strlen($left) > 0) && (strlen($right) > 0)) {
   if(preg_match('/^([^0-9]*)([0-9].*)$/Us', $left, $lMatch)) {
     $lTest = $lMatch[1];
     $left = $lMatch[2];
   } else {
     $lTest = $left;
     $left = '';
   }
   if(preg_match('/^([^0-9]*)([0-9].*)$/Us', $right, $rMatch)) {
     $rTest = $rMatch[1];
     $right = $rMatch[2];
   } else {
     $rTest = $right;
     $right = '';
   }
   $test = strcmp($lTest, $rTest);
   if($test != 0) {
     return $test;
   }
   if(preg_match('/^([0-9]+)([^0-9].*)?$/Us', $left, $lMatch)) {
     $lTest = intval($lMatch[1]);
     $left = $lMatch[2];
   } else {
     $lTest = 0;
   }
   if(preg_match('/^([0-9]+)([^0-9].*)?$/Us', $right, $rMatch)) {
     $rTest = intval($rMatch[1]);
     $right = $rMatch[2];
   } else {
     $rTest = 0;
   }
   $test = $lTest - $rTest;
   if($test != 0) {
     return $test;
   }
 }
 return strcmp($left, $right);
}
?>
The code is not optimized. It was just made to solve my problem.


public

The URI of Martin Pool's page is http://sourcefrog.net/projects/natsort/
(Yes, that's frog, not forge).
http://www.naturalordersort.org/ points to a page with the same idea, by Stuart Cheshire, who wrote a small Mac extension to do natural sorting.


Change Language


Follow Navioo On Twitter
addcslashes
addslashes
bin2hex
chop
chr
chunk_split
convert_cyr_string
convert_uudecode
convert_uuencode
count_chars
crc32
crypt
echo
explode
fprintf
get_html_translation_table
hebrev
hebrevc
html_entity_decode
htmlentities
htmlspecialchars_decode
htmlspecialchars
implode
join
levenshtein
localeconv
ltrim
md5_file
md5
metaphone
money_format
nl_langinfo
nl2br
number_format
ord
parse_str
print
printf
quoted_printable_decode
quotemeta
rtrim
setlocale
sha1_file
sha1
similar_text
soundex
sprintf
sscanf
str_getcsv
str_ireplace
str_pad
str_repeat
str_replace
str_rot13
str_shuffle
str_split
str_word_count
strcasecmp
strchr
strcmp
strcoll
strcspn
strip_tags
stripcslashes
stripos
stripslashes
stristr
strlen
strnatcasecmp
strnatcmp
strncasecmp
strncmp
strpbrk
strpos
strrchr
strrev
strripos
strrpos
strspn
strstr
strtok
strtolower
strtoupper
strtr
substr_compare
substr_count
substr_replace
substr
trim
ucfirst
ucwords
vfprintf
vprintf
vsprintf
wordwrap
eXTReMe Tracker