(PHP 5, PHP 7, PHP 8)
substr_compare — Comparação binária de duas strings a partir de uma posição até n caracteres
$haystack
,$needle
,$offset
,$length
= null
,$case_insensitive
= false
substr_compare() compara haystack
a partir da posição offset
com needle
até length
caracteres.
haystack
A string principal a ser comparada.
needle
A string secundária a ser comparada.
offset
A posição inicial para a comparação. Se negativa, inicia contando da final da string.
length
O comprimento da comparação. O valor padrão é o maior comprimento entre
o comprimento de needle
comparado com o comprimento
de haystack
menos o
offset
.
case_insensitive
Se case_insensitive
for true
, a comparação é
insensível a maiúsculas/minúsculas.
Retorna um valor menor que 0 se string1
for abaixo de string2
; um valor maior
que 0 se string1
for acima de
string2
e 0
se elas
forem iguais.
Nenhum significado em particular pode ser inferido com confiança desse valor a não
ser o seu sinal.
Se offset
for igual a (antes do PHP 7.2.18, 7.3.5) ou
maior que o comprimento de haystack
, ou
length
estiver definido e menor que 0,
substr_compare() mostra um alerta e retorna
false
.
Versão | Descrição |
---|---|
8.2.0 |
Não é mais garantido que esta função retornará
strlen($string1) - strlen($string2) quando os comprimentos das strings
não forem iguais, mas ppodem agora retornar -1 ou
1 no lugar.
|
8.0.0 |
length agora pode ser nulo.
|
7.2.18, 7.3.5 |
offset agora pode ser iagual ao comprimento de haystack .
|
Exemplo #1 Exemplo de 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); // alerta
?>