substr_compare

(PHP 5, PHP 7, PHP 8)

substr_compare — Comparação binária de duas strings a partir de uma posição até n caracteres

Descrição

substr_compare(
    string$haystack,
    string$needle,
    int$offset,
    ?int$length = null,
    bool$case_insensitive = false
): int

substr_compare() compara haystack a partir da posição offset com needle até length caracteres.

Parâmetros

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.

Valor Retornado

Retorna -1 se haystack a partir da posição offset for menor que needle, 1 se for marior que needle, e 0 se forem iguais. 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.

Registro de Alterações

Versão	Descrição
8.2.0	Esta função agora retorna `-1` ou `1`, onde anteriormente retornava um número negativo ou positivo.
8.0.0	`length` agora pode ser nulo.
7.2.18, 7.3.5	`offset` agora pode ser iagual ao comprimento de `haystack`.

Exemplos

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
?>

Veja Também

strncmp() - Binary safe string comparison of the first n characters