Riferimento API.

I servizi PHP, i punti di estensione JavaScript e le route che DXPR Builder definisce. Gli ID dei servizi vengono da dxpr_builder.services.yml, le route da dxpr_builder.routing.yml. Per i dettagli di richiesta e risposta di ogni route, vedi Endpoint API.

Servizi PHP

DxprBuilderServiceInterface

Implementata da dxpr_builder.service. I metodi che più probabilmente chiamerai:

• insertBaseTokens($content): sostituisce l’URL base di questo sito, la directory dei file e il percorso del modulo con token. L’editor memorizza i contenuti in questa forma.
• replaceBaseTokens(&$content): void: espande i token di nuovo in URL per l’ambiente corrente.
• stripHtmlElementPersists(string $markup): string: rimuove gli attributi data-az-persist. Eseguilo su markup scritto fuori dall’editor; l’editor li ricostruisce al caricamento.
• getCmsElementNames(): i blocchi e le visualizzazioni di viste offerti come elementi, in cache.
• getIconSets(): array: il registro dei set di icone dopo rilevamento YAML e hook_dxpr_builder_icon_sets_alter().

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

DxprBuilderLicenseServiceInterface

Implementata da dxpr_builder.license_service.

• isBillableUser(?AccountInterface $account = NULL): bool: TRUE per l’user 1 e per gli account attivi con edit with dxpr builder non esclusi dalla modifica con DXPR Builder.
• getLicenseInfo(): stato della licenza dal server delle licenze DXPR, in cache. Senza chiave prodotto restituisce il piano gratuito: un utente e 100 elementi di contenuto.
• syncAllUsersWithCentralStorage(string $operation, string $json_web_token = ''): void: invia gli editor di questo sito a DXPR. $operation è una delle costanti di interfaccia DXPR_USER_SYNC_OPERATION (sync), DXPR_USER_ADD_OPERATION (add) o DXPR_USER_REMOVE_OPERATION (remove).

DxprBuilderKeyService

• getApiKey(): ?string: la chiave prodotto. Quando l’impostazione api_key_storage è key, legge l’entità Key indicata in key_provider; altrimenti legge json_web_token.
• setApiKey(string $key_value, string $storage_type = 'config', ?string $selected_key_id = NULL): void: memorizza la chiave in config o in un’entità Key.

DxprBuilderJWTDecoder

• decodeJwt(string $access_token): restituisce i claim sub, scope e dxpr_tier della chiave prodotto, ciascuno NULL quando il token non si legge. Il risultato è in cache per token.

Punti di estensione JavaScript

Gli script dell’editor condividono due array su window.dxprBuilder. Inserisci i tuoi oggetti tra lo script che crea l’array e dxpr_builder.js, che li legge una volta all’esecuzione.

I tipi di parametro registrati dal modulo sono boxmodel, checkbox, checkboxes, colorpicker, datetime, dropdown, dxb_slider, html, icon, image, images, link, links, numericfield, row_layout, saved_datetime, social_links, textarea, textfield e video. Un parametro con un type sconosciuto è renderizzato come semplice input di testo.

Elementi personalizzati mostra una definizione completa di elemento e come caricarla al momento giusto.

Route dell’editor

Legenda accessi: billable è il controllo _dxpr_builder_billable_user (user 1, o un account attivo con edit with dxpr builder non escluso); CSRF è _csrf_token.

Route admin

Tutte le pagine admin stanno in DXPR Studio > DXPR Builder. La colonna delle schede mostra l’etichetta nel menu admin.