SolrDisMaxQuery::addPhraseField — Добавляет поле фразы (параметр pf)

Назначение SolrDisMaxQuery::addPhraseField

SolrDisMaxQuery::addPhraseField: Добавляет поле фразы (параметр pf). Справочная сущность относится к разделу «solr». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается SolrDisMaxQuery::addPhraseField

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

Смысловое направление SolrDisMaxQuery::addPhraseField

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

Сигнатура SolrDisMaxQuery::addPhraseField

Структурная запись: public SolrDisMaxQuery SolrDisMaxQuery::addPhraseField(string $field, string $boost, string $slop = значение по умолчанию). В ней 3 параметра: обязательные $field, $boost; необязательные $slop. Результат объявлен как SolrDisMaxQuery; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры SolrDisMaxQuery::addPhraseField

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

Контроль входных данных для SolrDisMaxQuery::addPhraseField

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

Результат SolrDisMaxQuery::addPhraseField

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

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

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

Интеграция SolrDisMaxQuery::addPhraseField в проект

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

Диагностика SolrDisMaxQuery::addPhraseField

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

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

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

Когда выбирать SolrDisMaxQuery::addPhraseField

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

Сравнение SolrDisMaxQuery::addPhraseField с соседними API

Для SolrDisMaxQuery::addPhraseField базовый ориентир: добавляет поле фразы (параметр pf); обязательные $field, $boost; необязательные $slop; результат SolrDisMaxQuery. Сопоставление с опубликованными соседями: SolrDisMaxQuery::removePhraseField: удаляет поле фразы (параметр pf); вход — обязательные $field; результат — SolrDisMaxQuery. SolrDisMaxQuery::setPhraseFields: устанавливает поля фразы и их усиления (и отклонения) с помощью параметра pf2; вход — обязательные $fields; результат — SolrDisMaxQuery. SolrDisMaxQuery::addTrigramPhraseField: добавляет поле триграммы (параметр pf3); вход — обязательные $field, $boost; необязательные $slop; результат — SolrDisMaxQuery. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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