preg_quote — Экранирует символы в регулярных выражениях

Назначение preg_quote

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

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

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

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

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

Сигнатура preg_quote

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

Параметры preg_quote

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

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

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

Результат preg_quote

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

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

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

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

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

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

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

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

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

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

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

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

Для preg_quote базовый ориентир: экранирует символы в регулярных выражениях; обязательные $str; необязательные $delimiter; результат string. Сопоставление с опубликованными соседями: escapeshellcmd: экранирует метасимволы командной строки; вход — обязательные $command; результат — string. preg_last_error_msg: возвращает сообщение об ошибке последней запущенной функции pcre; вход — аргументов нет; результат — string. preg_filter: производит поиск и замену по регулярному выражению; вход — обязательные $pattern, $replacement, $subject; необязательные $limit, $count; результат — string|array|null. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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