pg_escape_literal — Экранировать литерал при вставке в текстовое поле

Назначение pg_escape_literal

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

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

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

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

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

Сигнатура pg_escape_literal

Структурная запись: string|false pg_escape_literal(PgSql\Connection $connection = значение по умолчанию, string $string). В ней 2 параметра: обязательные $string; необязательные $connection. Результат объявлен как string|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры pg_escape_literal

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

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

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

Результат pg_escape_literal

pg_escape_literal объявляет результат типа string|false. Контракт pg_escape_literal допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

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

Убедитесь, что раздел «pgsql» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string $string. Затем отдельно добавьте необязательные параметры PgSql\Connection $connection, чтобы увидеть влияние значений по умолчанию. Для профиля «хранилище данных» важно явно контролировать соединение, транзакцию и кодировку; негативный сценарий должен проверить пустой результат, отказ соединения и повтор операции.

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

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

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

Сначала запишите точную сигнатуру string|false pg_escape_literal(PgSql\Connection $connection = значение по умолчанию, string $string) и фактические типы переданных значений. Затем подтвердите загрузку расширения «pgsql» в той же среде, где выполняется pg_escape_literal. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для pg_escape_literal предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

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

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

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

Для pg_escape_literal базовый ориентир: экранировать литерал при вставке в текстовое поле; обязательные $string; необязательные $connection; результат string|false. Сопоставление с опубликованными соседями: pg_escape_identifier: экранирует идентификатор перед вставкой в текст sql-инструкции; вход — обязательные $string; необязательные $connection; результат — string|false. pg_escape_bytea: экранирует спецсимволы в строке для вставки в поле типа bytea; вход — обязательные $string; необязательные $connection; результат — string. pg_escape_string: экранирование спецсимволов в строке запроса; вход — обязательные $string; необязательные $connection; результат — string. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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