DOMDocument::createEntityReference — Создать новый узел ссылки на сущность

Назначение DOMDocument::createEntityReference

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

Чем отличается DOMDocument::createEntityReference

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

Смысловое направление DOMDocument::createEntityReference

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

Сигнатура DOMDocument::createEntityReference

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

Параметры DOMDocument::createEntityReference

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

Контроль входных данных для DOMDocument::createEntityReference

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

Результат DOMDocument::createEntityReference

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

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

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

Интеграция DOMDocument::createEntityReference в проект

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

Диагностика DOMDocument::createEntityReference

Сначала запишите точную сигнатуру public DOMEntityReference|false DOMDocument::createEntityReference(string $name) и фактические типы переданных значений. Затем проверьте состояние экземпляра DOMDocument непосредственно перед методом DOMDocument::createEntityReference. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для DOMDocument::createEntityReference предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

Когда выбирать DOMDocument::createEntityReference

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

Сравнение DOMDocument::createEntityReference с соседними API

Для DOMDocument::createEntityReference базовый ориентир: создать новый узел ссылки на сущность; обязательные $name; результат DOMEntityReference|false. Сопоставление с опубликованными соседями: DOMNode::appendChild: добавляет новый дочерний узел в конец списка потомков; вход — обязательные $node; результат — DOMNode|false. DOMDocument::createAttributeNS: создаёт новый атрибут узла с соответствующим пространством имён; вход — обязательные $namespace, $qualifiedName; результат — DOMAttr|false. DOMDocument::createComment: создать новый узел комментария; вход — обязательные $data; результат — DOMComment. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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