Довідник API.

Служби PHP, точки розширення JavaScript і маршрути, які визначає DXPR Builder. 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: TRUE для користувача 1 та активних облікових записів із edit with dxpr builder, які не виключено з редагування DXPR Builder.
• 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, названу в key_provider; інакше він читає 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 (користувач 1, або активний обліковий запис із edit with dxpr builder, який не виключено); CSRF це _csrf_token.

Маршрути адміністрування

Усі сторінки адміністрування стоять під DXPR Studio > DXPR Builder. Колонка вкладки показує мітку в меню адміністрування.