(PHP 5, PHP 7)
substr_compare — A comparação binária entre duas strings de um offset até o limite do comprimento de caracteres
$main_str
, string $str
, int $offset
[, int $length
[, bool $case_insensitivity
= false
]] )
substr_compare() compara main_str
da posição offset
com str
até length
caracteres.
main_str
A string principal a ser comparada.
str
A segunda string a ser comparada.
offset
A posição inicial para a comparação. Se negativo, inicia contando da final da string.
length
O comprimento da comparação. O valor padrão é o maior comprimento entre
o comprimento de str
comparado com o comprimento
de main_str
menos o
offset
.
case_insensitivity
Se case_insensitivity
é TRUE
, a comparação é
case insensitive.
Retorna < 0 se main_str
da posição
offset
em diante é menor que str
, >
0 se ela é maior que str
, e 0 se elas são iguais.
Se offset
é igual ou maior que o comprimento de
main_str
e length
é setado e é menor que
1, (até PHP 5.6)substr_compare() dispara um warning e retorna
FALSE
.
Versão | Descrição |
---|---|
5.6.0 |
O parâmetro length agora pode ser 0.
|
5.1.0 |
Adicionada a possibilidade de usar offset negativo.
|
Exemplo #1 Exemplo da substr_compare()
<?php
echo substr_compare("abcde", "bc", 1, 2); // 0
echo substr_compare("abcde", "de", -2, 2); // 0
echo substr_compare("abcde", "bcg", 1, 2); // 0
echo substr_compare("abcde", "BC", 1, 2, true); // 0
echo substr_compare("abcde", "bc", 1, 3); // 1
echo substr_compare("abcde", "cd", 1, 2); // -1
echo substr_compare("abcde", "abc", 5, 1); // warning
?>