str_contains — Определяет, содержит ли строка подстроку

Назначение str_contains

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

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

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

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

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

Сигнатура str_contains

Структурная запись: bool str_contains(string $haystack, string $needle). В ней 2 параметра: обязательные $haystack, $needle. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры str_contains

Порядок и роли аргументов по сигнатуре: 1. $haystack — string, обязателен; 2. $needle — string, обязателен.

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

1) string $haystack — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 2) string $needle — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат str_contains

str_contains объявляет результат типа bool. str_contains возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

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

Убедитесь, что раздел «Строки» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string $haystack, string $needle. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «строки и кодировки» важно явно выбрать кодировку и единицу измерения длины; негативный сценарий должен проверить пустую строку, многобайтовые символы и некорректную последовательность.

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

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

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

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

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

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

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

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

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

Для str_contains базовый ориентир: определяет, содержит ли строка подстроку; обязательные $haystack, $needle; результат bool. Сопоставление с опубликованными соседями: str_ends_with: проверяет, заканчивается ли строка подстрокой; вход — обязательные $haystack, $needle; результат — bool. str_starts_with: проверяет, начинается ли строка с подстроки; вход — обязательные $haystack, $needle; результат — bool. stripos: возвращает позицию первого вхождения подстроки без учёта регистра; вход — обязательные $haystack, $needle; необязательные $offset; результат — int|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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