APIリファレンス.

DXPR Builderが定義するPHPサービス、JavaScript拡張ポイント、ルートです。サービスIDはdxpr_builder.services.ymlから、ルートはdxpr_builder.routing.ymlから来ます。各ルートのリクエスト・応答の詳細はAPIエンドポイントを参照。

PHPサービス

DxprBuilderServiceInterface

実装はdxpr_builder.service。呼び出す可能性が高いメソッドです。

• insertBaseTokens($content)：このサイトのベースURL、ファイルディレクトリ、モジュールパスをトークンに置換します。エディターはこの形式でコンテンツを保存します。
• replaceBaseTokens(&$content): void：トークンを現在の環境のURLに戻します。
• stripHtmlElementPersists(string $markup): string：data-az-persist属性を取り除きます。エディター外で書いたマークアップに実行します。エディターは読み込み時に再構築します。
• getCmsElementNames()：エレメントとして提供されるブロックとViewsディスプレイ。キャッシュ済み。
• getIconSets(): array：YAML検出とhook_dxpr_builder_icon_sets_alter()の後のアイコンセットレジストリー。

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

DxprBuilderLicenseServiceInterface

実装はdxpr_builder.license_service。

• isBillableUser(?AccountInterface $account = NULL): bool：利用者1と、DXPR Builder編集から除外されていないedit with dxpr builder付きの有効アカウントにTRUE。
• getLicenseInfo()：DXPRライセンスサーバーからのライセンス状態。キャッシュ済み。プロダクトキーなしではフリーティア(1利用者、100コンテンツアイテム)を返します。
• syncAllUsersWithCentralStorage(string $operation, string $json_web_token = ''): void：このサイトの編集者をDXPRに送信します。$operationはインターフェース定数DXPR_USER_SYNC_OPERATION(sync)、DXPR_USER_ADD_OPERATION(add)、DXPR_USER_REMOVE_OPERATION(remove)のいずれか。

DxprBuilderKeyService

• getApiKey(): ?string：プロダクトキー。api_key_storage設定がkeyの場合、key_providerで指定されたKeyエンティティを読み取ります。そうでなければjson_web_tokenを読み取ります。
• setApiKey(string $key_value, string $storage_type = 'config', ?string $selected_key_id = NULL): void：キーを設定またはKeyエンティティに保存します。

DxprBuilderJWTDecoder

• decodeJwt(string $access_token)：プロダクトキーのsub、scope、dxpr_tierクレームを返します。トークンが読めない場合は各NULLです。結果はトークンごとにキャッシュされます。

JavaScript拡張ポイント

エディタースクリプトはwindow.dxprBuilder上の2つの配列を共有します。配列を作るスクリプトとdxpr_builder.js(実行時に1度読み取る)の間で独自オブジェクトをプッシュします。

モジュールが登録するパラメータータイプはboxmodel、checkbox、checkboxes、colorpicker、datetime、dropdown、dxb_slider、html、icon、image、images、link、links、numericfield、row_layout、saved_datetime、social_links、textarea、textfield、videoです。不明なtypeのパラメーターは通常のテキスト入力としてレンダーされます。

カスタムエレメントは完全なエレメント定義と適切なタイミングでの読み込み方法を示します。

エディタールート

アクセス凡例。billableは_dxpr_builder_billable_userチェック(利用者1、または除外されていないedit with dxpr builder付きの有効アカウント)です。CSRFは_csrf_tokenです。

管理ルート

すべての管理ページはDXPR Studio > DXPR Builder配下にあります。タブ列は管理メニューのラベルを示します。