substr_compare

    (PHP 5, PHP 7, PHP 8)

    substr_compare — Сравнивает две строки от смещения до заданной длины символов в бинарно-безопасном режиме

    Описание

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

    Функция substr_compare() сравнивает строку haystack (начиная с позиции offset) со строкой needle. В сравнении участвуют максимум length символов.

    Список параметров

    haystack

    Основная сравниваемая строка.

    needle

    Следующая сравниваемая строка.

    offset

    Стартовая позиция сравнения. Если отрицательна, то обозначает смещение с конца строки.

    length

    Длина сравнения. По умолчанию используется максимальная из длин needle и haystack минус offset.

    case_insensitive

    Если значение параметра case_insensitive равно true, сравнение выполняется без учёта регистра.

    Возвращаемые значения

    Функция возвращает -1, если значение string1 меньше значения string2, 1, если значение string1 больше значения string2, и 0, если строки равны. Если параметр offset больше (до PHP 7.2.18, 7.3.5) или равен длине параметра haystack или параметр length передали и его значение меньше 0, функция substr_compare() выводит предупреждение и возвращает false.

    Список изменений

    Версия Описание
    8.2.0 Теперь функция возвращает -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); // 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); // Предупреждение

    ?>

    Смотрите также

    • strncmp() - Сравнивает первые n символов строк в бинарно-безопасном режиме

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 4 notes

    up
    30
    jimmetry at gmail dot com
    11 years ago
    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);
    }

    ?>
    up
    11
    Skyborne
    11 years ago
    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"
    ?>
    up
    7
    bishop at php dot net
    7 years ago
    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.
    up
    -14
    sleek
    18 years ago
    Modified version of the original posted function. Use this one:

    <?php
    if (!function_exists('substr_compare')) {
    function     substr_compare($main_str, $str, $offset, $length = NULL, $case_insensitivity = false) {
    $offset = (int) $offset;

    // Throw a warning because the offset is invalid
    if ($offset >= strlen($main_str)) {
    trigger_error('The start position cannot exceed initial string length.', E_USER_WARNING);
    return     false;
    }

    // We are comparing the first n-characters of each string, so let's use the PHP function to do it
    if ($offset == 0 && is_int($length) && $case_insensitivity === true) {
    return     strncasecmp($main_str, $str, $length);
    }

    // Get the substring that we are comparing
    if (is_int($length)) {
    $main_substr = substr($main_str, $offset, $length);
    $str_substr = substr($str, 0, $length);
    } else {
    $main_substr = substr($main_str, $offset);
    $str_substr = $str;
    }

    // Return a case-insensitive comparison of the two strings
    if ($case_insensitivity === true) {
    return     strcasecmp($main_substr, $str_substr);
    }

    // Return a case-sensitive comparison of the two strings
    return strcmp($main_substr, $str_substr);
    }
    }
    ?>
    ＋add a note
    To Top