substr — Возвращает подстроку

Назначение substr

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

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

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

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

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

Сигнатура substr

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

Параметры substr

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

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

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

Результат substr

substr объявляет результат типа string. Результат substr имеет объявленный тип string. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

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

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

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

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

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

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

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

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

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

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

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

Для substr базовый ориентир: возвращает подстроку; обязательные $string, $offset; необязательные $length; результат string. Сопоставление с опубликованными соседями: strrchr: находит последнее вхождение символа в строке; вход — обязательные $haystack, $needle; необязательные $before_needle; результат — string|false. substr_replace: заменяет часть строки; вход — обязательные $string, $replace, $offset; необязательные $length; результат — string|array. preg_match: выполняет проверку на соответствие регулярному выражению; вход — обязательные $pattern, $subject; необязательные $matches, $flags, $offset; результат — int|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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