API 参考.

DXPR Builder 定义的 PHP 服务、JavaScript 扩展点和路由。服务 ID 来自 dxpr_builder.services.yml，路由来自 dxpr_builder.routing.yml。各路由的请求和响应详情请参阅 API 端点。

PHP 服务

DxprBuilderServiceInterface

由 dxpr_builder.service 实现。您最可能调用的方法：

• insertBaseTokens($content)：将本站基本 URL、文件目录和模块路径替换为令牌。编辑器以这种形式存放内容。
• replaceBaseTokens(&$content): void：将令牌展开回当前环境的 URL。
• stripHtmlElementPersists(string $markup): string：移除 data-az-persist 属性。对编辑器外写的标记运行它；编辑器加载时重建它们。
• getCmsElementNames()：作为元素提供的区块和视图显示，带缓存。
• getIconSets(): array：YAML 发现和 hook_dxpr_builder_icon_sets_alter() 之后的图标集注册表。

$markup = \Drupal::service('dxpr_builder.service')->insertBaseTokens($html);

DxprBuilderLicenseServiceInterface

由 dxpr_builder.license_service 实现。

• isBillableUser(?AccountInterface $account = NULL): bool：user 1 以及拥有 edit with dxpr builder 且未被排除 DXPR Builder 编辑的活动账户返回 TRUE。
• getLicenseInfo()：DXPR 许可证服务器的许可证状态，带缓存。没有产品密钥时返回免费套餐：一个用户和 100 个内容项。
• syncAllUsersWithCentralStorage(string $operation, string $json_web_token = ''): void： 将本站编辑人员发送到 DXPR。$operation 是接口常量之一：DXPR_USER_SYNC_OPERATION（sync）、DXPR_USER_ADD_OPERATION（add）或 DXPR_USER_REMOVE_OPERATION（remove）。

DxprBuilderKeyService

• getApiKey(): ?string：产品密钥。api_key_storage 设置为 key 时读取 key_provider 命名的 Key 实体；否则读取 json_web_token。
• setApiKey(string $key_value, string $storage_type = 'config', ?string $selected_key_id = NULL): void： 将密钥存入配置或 Key 实体。

DxprBuilderJWTDecoder

• decodeJwt(string $access_token)：返回产品密钥的 sub、scope 和 dxpr_tier 声明，令牌不可读时各项为 NULL。结果按令牌缓存。

JavaScript 扩展点

编辑器脚本在 window.dxprBuilder 上共享两个数组。在创建数组的脚本与读取它们的 dxpr_builder.js 之间（它运行时读一次），将您自己的对象推入它们。

模块注册的参数类型有 boxmodel、checkbox、checkboxes、colorpicker、datetime、dropdown、dxb_slider、html、icon、image、images、link、links、numericfield、row_layout、saved_datetime、social_links、textarea、textfield 和 video。type 未知的参数渲染为普通文本输入框。

自定义元素展示了完整的元素定义，以及如何在正确的时机加载它。

编辑器路由

访问图例：billable 是 _dxpr_builder_billable_user 检查（user 1，或拥有 edit with dxpr builder 且未被排除的活动账户）；CSRF 是 _csrf_token。

管理路由

所有管理页面都在 DXPR Studio > DXPR Builder 下。Tab 列显示管理菜单中的标签。