Dokumentacja API.

Usługi PHP, punkty rozszerzeń JavaScript i trasy definiowane przez kreator DXPR. ID usług pochodzą z dxpr_builder.services.yml, trasy z dxpr_builder.routing.yml. Szczegóły żądań i odpowiedzi każdej trasy znajdziesz w punktach końcowych API.

Usługi PHP

DxprBuilderServiceInterface

Implementowane przez dxpr_builder.service. Metody, które najpewniej wywołasz:

• insertBaseTokens($content): zastępuje bazowy URL witryny, katalog plików i ścieżkę modułu tokenami. Edytor przechowuje treści w tej formie.
• replaceBaseTokens(&$content): void: rozwija tokeny z powrotem w URL-e dla bieżącego środowiska.
• stripHtmlElementPersists(string $markup): string: usuwa atrybuty data-az-persist. Uruchom na znacznikach zapisanych poza edytorem; edytor przebudowuje je przy wczytaniu.
• getCmsElementNames(): bloki i wyświetlenia widoków oferowane jako elementy, buforowane.
• getIconSets(): array: rejestr zestawów ikon po wykryciu YAML i hook_dxpr_builder_icon_sets_alter().

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

DxprBuilderLicenseServiceInterface

Implementowane przez dxpr_builder.license_service.

• isBillableUser(?AccountInterface $account = NULL): bool: TRUE dla użytkownika 1 i dla aktywnych kont z edit with dxpr builder, niewykluczonych z edycji w kreatorze DXPR.
• getLicenseInfo(): status licencji z serwera licencyjnego DXPR, buforowany. Bez klucza produktu zwraca plan darmowy: jeden użytkownik i 100 elementów treści.
• syncAllUsersWithCentralStorage(string $operation, string $json_web_token = ''): void: wysyła redaktorów witryny do DXPR. $operation to jedna ze stałych interfejsu DXPR_USER_SYNC_OPERATION (sync), DXPR_USER_ADD_OPERATION (add) albo DXPR_USER_REMOVE_OPERATION (remove).

DxprBuilderKeyService

• getApiKey(): ?string: klucz produktu. Gdy ustawienie api_key_storage to key, odczytuje encję Key nazwaną w key_provider; w przeciwnym razie odczytuje json_web_token.
• setApiKey(string $key_value, string $storage_type = 'config', ?string $selected_key_id = NULL): void: przechowuje klucz w konfiguracji albo w encji Key.

DxprBuilderJWTDecoder

• decodeJwt(string $access_token): zwraca oświadczenia sub, scope i dxpr_tier klucza produktu, każde NULL, gdy tokenu nie da się odczytać. Wynik jest buforowany dla tokenu.

Punkty rozszerzeń JavaScript

Skrypty edytora współdzielą dwie tablice na window.dxprBuilder. Wepchnij własne obiekty na nie między skryptem tworzącym tablicę a dxpr_builder.js, który odczytuje je raz przy uruchomieniu.

Typy parametrów rejestrowane przez moduł to boxmodel, checkbox, checkboxes, colorpicker, datetime, dropdown, dxb_slider, html, icon, image, images, link, links, numericfield, row_layout, saved_datetime, social_links, textarea, textfield i video. Parametr z nieznanym type renderuje się jako zwykłe pole tekstowe.

Własne elementy pokazują kompletną definicję elementu i jak ją wczytać we właściwym momencie.

Trasy edytora

Legenda dostępu: billable to kontrola _dxpr_builder_billable_user (użytkownik 1 albo aktywne konto z edit with dxpr builder, niewykluczone); CSRF to _csrf_token.

Trasy administracyjne

Wszystkie strony administracyjne znajdują się w DXPR Studio > DXPR Builder. Kolumna kart pokazuje etykietę w menu administracyjnym.