Collator::compare

collator_compare

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

Collator::compare -- collator_compareCompare two Unicode strings

Descrição

Estilo orientado à objeto

public Collator::compare(string $string1, string $string2): int|false

Estilo procedural

collator_compare(Collator $object, string $string1, string $string2): int|false

Compare two Unicode strings according to collation rules.

Parâmetros

object

Collator object.

string1

The first string to compare.

string2

The second string to compare.

Valor Retornado

Return comparison result:

  • 1 if string1 is greater than string2 ;

  • 0 if string1 is equal to string2;

  • -1 if string1 is less than string2 .

Returns false on failure.

Aviso

Esta função pode retornar o booleano false, mas também pode retornar um valor não-booleano que pode ser avaliado como false, como 0 ou "". Leia a seção em Booleanos para maiores informações. Utilize o operador === para testar o valor retornado por esta função.

Exemplos

Exemplo #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 ) {
    echo 
"s1 is greater than s2\n";
} else if( 
$res ) {
    echo 
"s1 is less than s2\n";
} else {
    echo 
"s1 is equal to s2\n";
}
?>

O exemplo acima irá imprimir:


s1 is greater than s2

Exemplo #2 Comparing strings without diacritics or case-sensitivity

<?php
$c 
= new Collator'en' );
$c->setStrengthCollator::PRIMARY );

if ( 
$c->compare'Séan''Sean' ) == )
{
    echo 
"The same\n";
}

O exemplo acima irá imprimir:


The same

This example instructs the collator to compare with only taking the base characters into account. The documentation for Collator->setStrength() explains the different strengths.

Veja Também

add a note add a note

User Contributed Notes 1 note

up
1
erik at eldata dot se
1 year ago
The Collator class with method compare does what the non existing mb_strcmp, mb_strcasecmp, mb_strnatcmp and mb_strnatcasecmp would do for multibyte strings (UTF8) - but better! :-)

For "case": the Collator is case insensitive due to Collator::CASE_FIRST defaults to Collator::OFF, but can be changed with method setAttribute.

For "nat" (natural sort order for numbers): use method setAttribute with Collator::NUMERIC_COLLATION and Collator:ON to enable.
To Top