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

Назначение substr_compare

substr_compare: Сравнивает две строки со смещения до заданного количества символов в бинарно безопасном режиме. Справочная сущность относится к разделу «Строки». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается substr_compare

Это процедурная функция раздела «Строки». Её отличают имя substr_compare, контракт «обязательные $haystack, $needle, $offset; необязательные $length, $case_insensitive» и объявленный результат int; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление substr_compare

Смысловое направление substr_compare — «операция compare». В прикладном коде свяжите вызов substr_compare с одним явно сформулированным результатом прикладного сценария. Контрольный набор для этой операции: проверьте штатное выполнение, граничное состояние и документированный отказ. Такой акцент отделяет substr_compare от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура substr_compare

Структурная запись: int substr_compare(string $haystack, string $needle, int $offset, int|null $length = null, bool $case_insensitive = false). В ней 5 параметров: обязательные $haystack, $needle, $offset; необязательные $length, $case_insensitive. Результат объявлен как int; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры substr_compare

Порядок и роли аргументов по сигнатуре: 1. $haystack — string, обязателен; 2. $needle — string, обязателен; 3. $offset — int, обязателен; 4. $length — int|null, необязателен, default null; 5. $case_insensitive — bool, необязателен, default false.

Контроль входных данных для substr_compare

1) string $haystack — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 2) string $needle — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) int $offset — обязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. 4) int|null $length — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. 5) bool $case_insensitive — необязательный: передайте true и false явно, не полагаясь на нестрогое приведение скалярных значений.

Результат substr_compare

substr_compare объявляет результат типа int. Числовой результат substr_compare имеет тип int. Не назначайте специальный смысл нулю или отрицательному значению, пока он не следует из документированного контракта.

Проверочный сценарий для substr_compare

Убедитесь, что раздел «Строки» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string $haystack, string $needle, int $offset. Затем отдельно добавьте необязательные параметры int|null $length=null, bool $case_insensitive=false, чтобы увидеть влияние значений по умолчанию. Для профиля «строки и кодировки» важно явно выбрать кодировку и единицу измерения длины; негативный сценарий должен проверить пустую строку, многобайтовые символы и некорректную последовательность.

Интеграция substr_compare в проект

Проверку доступности substr_compare и преобразование входных значений разместите у границы модуля «Строки». Для профиля «строки и кодировки» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция substr_compare не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика substr_compare

Сначала запишите точную сигнатуру int substr_compare(string $haystack, string $needle, int $offset, int|null $length = null, bool $case_insensitive = false) и фактические типы переданных значений. Затем подтвердите загрузку расширения «Строки» в той же среде, где выполняется substr_compare. Если результат неожиданен, сравните его тип с int и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «строки и кодировки» применяйте отдельный негативный тест: проверить пустую строку, многобайтовые символы и некорректную последовательность. В production-коде важно явно выбрать кодировку и единицу измерения длины. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать substr_compare

Выбор substr_compare оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «Строки»; 2) сигнатура содержит 5 аргументов: обязательных 3, необязательных 2; 3) вызывающему коду нужен результат int и действие «операция compare». Для профиля «строки и кодировки» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с strncmp: у него другое назначение, владелец или набор входных данных.

Сравнение substr_compare с соседними API

Для substr_compare базовый ориентир: сравнивает две строки со смещения до заданного количества символов в бинарно безопасном режиме; обязательные $haystack, $needle, $offset; необязательные $length, $case_insensitive; результат int. Сопоставление с опубликованными соседями: strncmp: сравнивает первые n символов строк в бинарно безопасном режиме; вход — обязательные $string1, $string2, $length; результат — int. substr_count: возвращает количество вхождений подстроки; вход — обязательные $haystack, $needle; необязательные $offset, $length; результат — int. substr_replace: заменяет часть строки; вход — обязательные $string, $replace, $offset; необязательные $length; результат — string|array. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

В структурной истории исходной записи отмечены версии: 8.0.0, 7.2.18, 7.3.5. substr_compare сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для substr_compare.

Связанные материалы