Référence de l’API.

Les services PHP, points d’extension JavaScript et routes définis par DXPR Builder. Les identifiants de service viennent de dxpr_builder.services.yml, les routes de dxpr_builder.routing.yml. Pour les détails de requête et réponse de chaque route, voir Points d’accès de l’API.

Services PHP

DxprBuilderServiceInterface

Implémenté par dxpr_builder.service. Les méthodes que vous appellerez le plus probablement :

• insertBaseTokens($content) : remplace l’URL de base de ce site, le répertoire des fichiers et le chemin du module par des jetons. L’éditeur stocke le contenu sous cette forme.
• replaceBaseTokens(&$content): void : réétend les jetons en URL pour l’environnement actuel.
• stripHtmlElementPersists(string $markup): string : retire les attributs data-az-persist. Exécutez-la sur du balisage écrit hors de l’éditeur ; l’éditeur les reconstruit au chargement.
• getCmsElementNames() : les affichages de blocs et de vues proposés comme éléments, mis en cache.
• getIconSets(): array : le registre des jeux d’icônes après découverte YAML et hook_dxpr_builder_icon_sets_alter().

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

DxprBuilderLicenseServiceInterface

Implémenté par dxpr_builder.license_service.

• isBillableUser(?AccountInterface $account = NULL): bool : TRUE pour l’utilisateur 1 et pour les comptes actifs avec edit with dxpr builder qui ne sont pas exclus de la modification DXPR Builder.
• getLicenseInfo() : statut de licence depuis le serveur de licences DXPR, mis en cache. Sans clé de produit, il renvoie le palier gratuit : un utilisateur et 100 contenus.
• syncAllUsersWithCentralStorage(string $operation, string $json_web_token = ''): void : envoie les contributeurs de ce site à DXPR. $operation est l’une des constantes d’interface DXPR_USER_SYNC_OPERATION (sync), DXPR_USER_ADD_OPERATION (add) ou DXPR_USER_REMOVE_OPERATION (remove).

DxprBuilderKeyService

• getApiKey(): ?string : la clé de produit. Quand le réglage api_key_storage vaut key, il lit l’entité Key nommée dans key_provider ; sinon il lit json_web_token.
• setApiKey(string $key_value, string $storage_type = 'config', ?string $selected_key_id = NULL): void : stocke la clé en config ou dans une entité Key.

DxprBuilderJWTDecoder

• decodeJwt(string $access_token) : renvoie les claims sub, scope et dxpr_tier de la clé de produit, chacun NULL quand le jeton ne peut pas être lu. Le résultat est mis en cache par jeton.

Points d’extension JavaScript

Les scripts de l’éditeur partagent deux tableaux sur window.dxprBuilder. Empilez vos propres objets dessus entre le script qui crée le tableau et dxpr_builder.js, qui les lit une fois à son exécution.

Les types de paramètres enregistrés par le module sont boxmodel, checkbox, checkboxes, colorpicker, datetime, dropdown, dxb_slider, html, icon, image, images, link, links, numericfield, row_layout, saved_datetime, social_links, textarea, textfield et video. Un paramètre avec un type inconnu est rendu comme un champ de texte brut.

Éléments personnalisés montre une définition complète d’élément et comment la charger au bon moment.

Routes de l’éditeur

Légende d’accès : billable est la vérification _dxpr_builder_billable_user (utilisateur 1, ou un compte actif avec edit with dxpr builder qui n’est pas exclu) ; CSRF est _csrf_token.

Routes d’admin

Toutes les pages d’admin se trouvent sous DXPR Studio > DXPR Builder. La colonne des onglets montre le libellé dans le menu d’admin.