API-Referenz.

Die PHP-Dienste, JavaScript-Erweiterungspunkte und Routen, die DXPR Builder definiert. Dienst-IDs stammen aus dxpr_builder.services.yml, Routen aus dxpr_builder.routing.yml. Für Anfrage- und Antwortdetails jeder Route siehe API-Endpunkte.

PHP-Dienste

DxprBuilderServiceInterface

Implementiert von dxpr_builder.service. Die Methoden, die Sie am wahrscheinlichsten aufrufen:

• insertBaseTokens($content): ersetzt Basis-URL, Dateiverzeichnis und Modulpfad dieser Website durch Token. Der Editor speichert Inhalte in dieser Form.
• replaceBaseTokens(&$content): void: expandiert die Token zurück zu URLs für die aktuelle Umgebung.
• stripHtmlElementPersists(string $markup): string: entfernt die data-az-persist-Attribute. Führen Sie es auf Markup aus, das außerhalb des Editors geschrieben wurde; der Editor baut sie beim Laden neu auf.
• getCmsElementNames(): die als Elemente angebotenen Block- und Ansichtsanzeigen, zwischengespeichert.
• getIconSets(): array: die Icon-Set-Registry nach YAML-Erkennung und hook_dxpr_builder_icon_sets_alter().

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

DxprBuilderLicenseServiceInterface

Implementiert von dxpr_builder.license_service.

• isBillableUser(?AccountInterface $account = NULL): bool: TRUE für Benutzer 1 und für aktive Konten mit edit with dxpr builder, die nicht vom DXPR-Builder-Bearbeiten ausgeschlossen sind.
• getLicenseInfo(): Lizenzstatus vom DXPR-Lizenzserver, zwischengespeichert. Ohne Produktschlüssel liefert es die Gratis-Stufe: ein Konto und 100 Inhalte.
• syncAllUsersWithCentralStorage(string $operation, string $json_web_token = ''): void: sendet die Bearbeitenden dieser Website an DXPR. $operation ist eine der Interface-Konstanten DXPR_USER_SYNC_OPERATION (sync), DXPR_USER_ADD_OPERATION (add) oder DXPR_USER_REMOVE_OPERATION (remove).

DxprBuilderKeyService

• getApiKey(): ?string: der Produktschlüssel. Wenn die api_key_storage-Einstellung key ist, liest er die Key-Entität, die in key_provider genannt ist; sonst liest er json_web_token.
• setApiKey(string $key_value, string $storage_type = 'config', ?string $selected_key_id = NULL): void: speichert den Schlüssel in der Konfiguration oder in einer Key-Entität.

DxprBuilderJWTDecoder

• decodeJwt(string $access_token): liefert die Claims sub, scope und dxpr_tier des Produktschlüssels, je NULL, wenn das Token nicht lesbar ist. Das Ergebnis wird pro Token zwischengespeichert.

JavaScript-Erweiterungspunkte

Die Editor-Skripte teilen zwei Arrays auf window.dxprBuilder. Pushen Sie eigene Objekte darauf, zwischen dem Skript, das das Array erzeugt, und dxpr_builder.js, das sie beim Laufen einmal liest.

Die Parametertypen, die das Modul registriert, sind boxmodel, checkbox, checkboxes, colorpicker, datetime, dropdown, dxb_slider, html, icon, image, images, link, links, numericfield, row_layout, saved_datetime, social_links, textarea, textfield und video. Ein Parameter mit unbekanntem type rendert als schlichte Texteingabe.

Eigene Elemente zeigt eine vollständige Elementdefinition und wie sie im richtigen Moment geladen wird.

Editor-Routen

Legende: billable ist die _dxpr_builder_billable_user-Prüfung (Benutzer 1, oder ein aktives Konto mit edit with dxpr builder, das nicht ausgeschlossen ist); CSRF ist _csrf_token.

Admin-Routen

Alle Admin-Seiten liegen unter DXPR Studio > DXPR Builder. Die Tab-Spalte zeigt die Bezeichnung im Admin-Menü.