mysqli::real_escape_string — Экранирует специальные символы в строке для использования в SQL-выражении, используя текущий набор символов соединения

Назначение mysqli::real_escape_string

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

Чем отличается mysqli::real_escape_string

Эта страница описывает член real_escape_string класса mysqli, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: обязательные $string; объявленный результат — string.

Смысловое направление mysqli::real_escape_string

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

Сигнатура mysqli::real_escape_string

Структурная запись: public string mysqli::real_escape_string(string $string). В ней 1 параметр: обязательные $string. Результат объявлен как string; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры mysqli::real_escape_string

Порядок и роли аргументов по сигнатуре: 1. $string — string, обязателен. Для mysqli::real_escape_string фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для mysqli::real_escape_string

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

Результат mysqli::real_escape_string

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

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

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

Интеграция mysqli::real_escape_string в проект

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

Диагностика mysqli::real_escape_string

Сначала запишите точную сигнатуру public string mysqli::real_escape_string(string $string) и фактические типы переданных значений. Затем проверьте состояние экземпляра mysqli непосредственно перед методом mysqli::real_escape_string. Если результат неожиданен, сравните его тип с string и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать mysqli::real_escape_string

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

Сравнение mysqli::real_escape_string с соседними API

Для mysqli::real_escape_string базовый ориентир: экранирует специальные символы в строке для использования в sql-выражении, используя текущий набор символов соединения; обязательные $string; результат string. Сопоставление с опубликованными соседями: mysqli::character_set_name: возвращает текущую кодировку, установленную для соединения с бд; вход — аргументов нет; результат — string. mysqli_get_host_info: возвращает строку, содержащую тип используемого соединения; вход — обязательные $mysql; результат — string. mysqli::get_client_info: получает информацию о mysql-клиенте; вход — аргументов нет; результат — string. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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