(PHP 5, PHP 7, PHP 8)
substr_compare — Сравнивает две строки со смещения до заданного количества символов в бинарно безопасном режиме
$haystack,$needle,$offset,$length = null ,$case_insensitive = false
Функция substr_compare() сравнивает часть строки haystack
с подстрокой needle.
Параметр offset определяет, какую часть строки сравнивает функция,
а параметр length — количество символов для сравнения.
haystackГлавная строка для сравнения.
needleВторая строка для сравнения.
offsetСтартовая позиция сравнения. При отрицательном значении функция отсчитывает позицию смещения с конца строки.
length
Длина сравнения. Значение по умолчанию равно размеру наибольшей по длине строки:
needle или haystack
за вычетом абсолютного количества байтов смещения offset.
case_insensitive
При установке для параметра case_insensitive значения true
сравнение выполняется без учёта регистра.
Функция возвращает значение меньше 0, если строка string1
меньше строки string2; значение больше
0, если строка string1 больше строки
string2, и 0, если строки
равны.
Из значения возврата невозможно надёжно вывести конкретное значение,
кроме знака числа.
Функция substr_compare() выводит предупреждение и возвращает false ,
если параметр offset больше (до PHP 7.2.18, 7.3.5) или равен длине
параметра haystack, или если установили для параметра length
значение меньше 0.
| Версия | Описание |
|---|---|
| 8.2.0 |
Функция больше не гарантирует возврат разницы
strlen($string1) - strlen($string2), когда длины строк
не равны, но теперь вместо этого иногда возвращает -1
или 1.
|
| 8.0.0 |
Параметр length теперь принимает значение null .
|
| 7.2.18, 7.3.5 |
Параметр offset теперь может равняться параметру haystack.
|
Пример #1 Пример сравнения строк функцией substr_compare()
<?php
echo substr_compare("abcde", "bc", 1, 2), PHP_EOL; // 0
echo substr_compare("abcde", "de", -2, 2), PHP_EOL; // 0
echo substr_compare("abcde", "bcg", 1, 2), PHP_EOL; // 0
echo substr_compare("abcde", "BC", 1, 2, true), PHP_EOL; // 0
echo substr_compare("abcde", "bc", 1, 3), PHP_EOL; // 1
echo substr_compare("abcde", "cd", 1, 2), PHP_EOL; // -1
echo substr_compare("abcde", "abc", 5, 1), PHP_EOL; // -1
?>When you came to this page, you may have been looking for something a little simpler: A function that can check if a small string exists within a larger string starting at a particular index. Using substr_compare() for this can leave your code messy, because you need to check that your string is long enough (to avoid the warning), manually specify the length of the short string, and like many of the string functions, perform an integer comparison to answer a true/false question.
I put together a simple function to return true if $str exists within $mainStr. If $loc is specified, the $str must begin at that index. If not, the entire $mainStr will be searched.
<?php
function contains_substr($mainStr, $str, $loc = false) {
if ($loc === false) return (strpos($mainStr, $str) !== false);
if (strlen($mainStr) < strlen($str)) return false;
if (($loc + strlen($str)) > strlen($mainStr)) return false;
return (strcmp(substr($mainStr, $loc, strlen($str)), $str) == 0);
}
?>This function efficiently implements checks for strings beginning or ending with other strings:
<?php
function str_begins($haystack, $needle) {
return 0 === substr_compare($haystack, $needle, 0, strlen($needle));
}
function str_ends($haystack, $needle) {
return 0 === substr_compare($haystack, $needle, -strlen($needle));
}
var_dump(str_begins('http://example.com', 'https://'));
?>
Note that these are not multi-byte character set aware.Take note of the `length` parameter: "The default value is the largest of the length of the str compared to the length of main_str less the offset."
This is *not* the length of str as you might (I always) expect, so if you leave it out, you'll get unexpected results. Example:
<?php
$hash = '5ドル$lalalalalalalala$crypt.output.here';
var_dump(substr_compare($hash, '5ドル$', 0)); # int(34)
var_dump(substr_compare($hash, '5ドル$', 0, 3)); # int(0)
var_dump(PHP_VERSION); # string(6) "5.3.14"
?>