LuaSandbox::registerLibrary — Регистрирует набор PHP-функций как библиотеку Lua

Назначение LuaSandbox::registerLibrary

LuaSandbox::registerLibrary: Регистрирует набор PHP-функций как библиотеку Lua. Справочная сущность относится к разделу «luasandbox». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается LuaSandbox::registerLibrary

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

Смысловое направление LuaSandbox::registerLibrary

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

Сигнатура LuaSandbox::registerLibrary

Структурная запись: public void LuaSandbox::registerLibrary(string $libname, array $functions). В ней 2 параметра: обязательные $libname, $functions. Результат объявлен как void; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры LuaSandbox::registerLibrary

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

Контроль входных данных для LuaSandbox::registerLibrary

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

Результат LuaSandbox::registerLibrary

LuaSandbox::registerLibrary объявляет результат типа void. LuaSandbox::registerLibrary объявлена с результатом void. Проверяйте наблюдаемый эффект и диагностику вызова; присваивание результата не подтверждает успешность операции.

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

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

Интеграция LuaSandbox::registerLibrary в проект

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

Диагностика LuaSandbox::registerLibrary

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

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

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

Когда выбирать LuaSandbox::registerLibrary

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

Сравнение LuaSandbox::registerLibrary с соседними API

Для LuaSandbox::registerLibrary базовый ориентир: регистрирует набор php-функций как библиотеку lua; обязательные $libname, $functions; результат void. Сопоставление с опубликованными соседями: LuaSandbox::wrapPhpFunction: оборачивает вызываемый php-объект в luasandboxfunction; вход — обязательные $function; результат — LuaSandboxFunction. LuaSandbox::setMemoryLimit: устанавливает предел памяти для среды lua; вход — обязательные $limit; результат — void. LuaSandbox::setCPULimit: устанавливает ограничение времени процессора для среды lua; вход — обязательные $limit; результат — void. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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