Referência de API.

Os serviços PHP, pontos de extensão JavaScript e rotas que o DXPR Builder define. Os identificadores de serviço vêm de dxpr_builder.services.yml, as rotas de dxpr_builder.routing.yml. Para detalhes de pedido e resposta de cada rota, consulte Endpoints de API.

Serviços PHP

DxprBuilderServiceInterface

Implementado por dxpr_builder.service. Os métodos com maior probabilidade de chamar:

• insertBaseTokens($content): substitui o URL base deste site, o diretório de ficheiros e o caminho do módulo por tokens. O editor guarda o conteúdo nesta forma.
• replaceBaseTokens(&$content): void: expande os tokens de volta em URL para o ambiente atual.
• stripHtmlElementPersists(string $markup): string: remove os atributos data-az-persist. Corra-o em marcação escrita fora do editor; o editor reconstrói-os ao carregar.
• getCmsElementNames(): os blocos e apresentações de vistas oferecidos como elementos, em cache.
• getIconSets(): array: o registo de conjuntos de ícones após descoberta YAML e hook_dxpr_builder_icon_sets_alter().

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

DxprBuilderLicenseServiceInterface

Implementado por dxpr_builder.license_service.

• isBillableUser(?AccountInterface $account = NULL): bool: TRUE para o utilizador 1 e para contas ativas com edit with dxpr builder não excluídas da edição do DXPR Builder.
• getLicenseInfo(): estado da licença do servidor de licenças da DXPR, em cache. Sem chave de produto devolve o plano gratuito: um utilizador e 100 conteúdos.
• syncAllUsersWithCentralStorage(string $operation, string $json_web_token = ''): void: envia os editores deste site para a DXPR. $operation é uma das constantes de interface DXPR_USER_SYNC_OPERATION (sync), DXPR_USER_ADD_OPERATION (add) ou DXPR_USER_REMOVE_OPERATION (remove).

DxprBuilderKeyService

• getApiKey(): ?string: a chave de produto. Quando a definição api_key_storage é key, lê a entidade Key indicada em key_provider; senão lê json_web_token.
• setApiKey(string $key_value, string $storage_type = 'config', ?string $selected_key_id = NULL): void: guarda a chave na configuração ou numa entidade Key.

DxprBuilderJWTDecoder

• decodeJwt(string $access_token): devolve as afirmações sub, scope e dxpr_tier da chave de produto, cada uma NULL quando o token não pode ser lido. O resultado fica em cache por token.

Pontos de extensão JavaScript

Os scripts do editor partilham dois arrays em window.dxprBuilder. Empurre os objetos próprios para eles entre o script que cria o array e dxpr_builder.js, que os lê uma vez ao correr.

Os tipos de parâmetro que o módulo regista são 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. Um parâmetro com type desconhecido apresenta-se como entrada de texto simples.

Elementos personalizados mostra uma definição de elemento completa e como a carregar no momento certo.

Rotas do editor

Legenda de acesso: billable é a verificação _dxpr_builder_billable_user (utilizador 1, ou uma conta ativa com edit with dxpr builder não excluída); CSRF é _csrf_token.

Rotas de administração

Todas as páginas de administração ficam em DXPR Studio > DXPR Builder. A coluna do separador mostra a etiqueta no menu de administração.