Документация1С-Битрикс: Модулиnative.apiРазработчикамКонстанты

Константы модуля

PHP
use Native\Api\Config\ModuleConfig;

$value = ModuleConfig::CONTROLLER;

ModuleConfig объединяет все интерфейсы констант модуля. Значения констант приведены в справочниках ниже.

Основные константы

Идентификатор хранится в BaseConfig::MODULE_ID и доступен через общий интерфейс ModuleConfig. Пользовательское имя получают через ModuleApi::getName(): оно берётся из lang-файла установщика и имеет резервное значение. Константы MODULE_NAME в версии 2.0.0 нет.

PHP
use Native\Api\Infrastructure\Module\ModuleApi;
use Native\Api\Infrastructure\Module\ModuleMcp;

$moduleId = ModuleApi::getModuleId();
$moduleName = ModuleApi::getName();
$mcpName = ModuleMcp::getName();

Резервное имя MCP — «MCP-шлюз» из lang-файла. Папка модуля, его регистрация, доступность лицензии и активность шлюза — разные состояния: isPresent(), isInstalled(), isAvailable() и isActive().

Справочники

РазделИнтерфейс
БезопасностьSecurityConfig
КешCacheConfig
КонтроллерыControllerConfig
НастройкиOptionConfig
ОтветResponseConfig
ОшибкиExceptionConfig
ПараметрыParameterConfig
Права и группыAccessConfig
ПровайдерProviderConfig
РезультатыStatusConfig
РоутыRouteConfig
Сегменты роутовSegmentConfig
События аудитаEventConfig
События APIModuleEventConfig
Статусы запросовRequestStatusConfig
Типы и форматыTypeConfig
CORSCorsConfig
HTTP-заголовкиHeaderConfig
HTTP-статусыHttpStatusConfig
MCP-инструментыToolConfig
OpenAPIOpenApiConfig