核心要點(diǎn)

• Drupal 8 引入了一種將區(qū)塊作為插件的新概念，允許在整個(gè)站點(diǎn)中重複使用它們?？梢栽赨I中創(chuàng)建區(qū)塊，並多次使用。
• 在 Drupal 8 中，您可以創(chuàng)建一個(gè)返回可配置文本的自定義區(qū)塊。這可以通過在 UI 中創(chuàng)建新的區(qū)塊類型並在整個(gè)站點(diǎn)中重複使用它來實(shí)現(xiàn)。
• Drupal 8 允許為區(qū)塊添加配置表單。這使用戶能夠編輯區(qū)塊，在文本字段中指定名稱，然后區(qū)塊將顯示對(duì)該名稱的問候。
• Drupal 8 模塊開發(fā)包括創(chuàng)建一個(gè)簡(jiǎn)單的表單。表單定義函數(shù)在一個(gè)類中組合在一起。提交的表單值只是簡(jiǎn)單地打印在屏幕上以顯示其工作原理。
• 在 Drupal 8 中，您可以通過在自定義模塊中定義表單類來創(chuàng)建自定義表單。表單類應(yīng)擴(kuò)展“FormBase”類並實(shí)現(xiàn)三個(gè)方法：“getFormId()”、“buildForm()”和“submitForm()”。

請(qǐng)注意，由於編寫時(shí) Drupal 8 正在進(jìn)行的開發(fā)過程，某些代碼部分可能已過時(shí)。請(qǐng)查看此存儲(chǔ)庫(kù)，我嘗試更新示例代碼並使其與最新的 Drupal 8 版本一起工作。

在本系列文章的第一部分中，我們從基礎(chǔ)知識(shí)開始學(xué)習(xí) Drupal 8 模塊開發(fā)。我們已經(jīng)了解了讓 Drupal 了解我們模塊所需的文件、路由過程的工作方式以及如何以配置方式以編程方式創(chuàng)建菜單鏈接。

在本教程中，我們將進(jìn)一步研究在此存儲(chǔ)庫(kù)中找到的沙箱模塊，並查看兩個(gè)重要的功能部件：區(qū)塊和表單。為此，我們將創(chuàng)建一個(gè)返回一些可配置文本的自定義區(qū)塊。之後，我們將創(chuàng)建一個(gè)簡(jiǎn)單的表單，用於將用戶提交的值打印到屏幕上。

Drupal 8 區(qū)塊

D8 中對(duì)區(qū)塊 API 的一個(gè)很酷的新更改是將區(qū)塊變得更突出，方法是將它們製作為插件（一個(gè)全新的概念）。這意味著它們是可重用的功能部件（在後臺(tái)），因?yàn)槟F(xiàn)在可以在 UI 中創(chuàng)建一個(gè)區(qū)塊並在整個(gè)站點(diǎn)中重複使用它——您不再局限於僅使用一次區(qū)塊。

讓我們創(chuàng)建一個(gè)簡(jiǎn)單的區(qū)塊類型，默認(rèn)情況下它會(huì)打印到屏幕上 Hello World!。我們只需要使用位於模塊根目錄的 src/Plugin/Block 文件夾中的一個(gè)類文件即可。讓我們將我們的新區(qū)塊類型命名為 DemoBlock，當(dāng)然它需要位於名為 DemoBlock.php 的文件中。在這個(gè)文件中，我們可以從以下內(nèi)容開始：

<?php
namespace Drupal\demo\Plugin\Block;

use Drupal\block\BlockBase;
use Drupal\Core\Session\AccountInterface;

/**
 * Provides a 'Demo' block.
 *
 * @Block(
 *   id = "demo_block",
 *   admin_label = @Translation("Demo block"),
 * )
 */

class DemoBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    return array(
      '#markup' => $this->t('Hello World!'),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function access(AccountInterface $account) {
    return $account->hasPermission('access content');
  }

}

與所有其他類文件一樣，我們首先對(duì)我們的類進(jìn)行命名空間。然後我們 使用 BlockBase 類以便我們可以擴(kuò)展它，以及 AccountInterface 類以便我們可以訪問當(dāng)前登錄的用戶。接下來是您在 Drupal 7 中肯定沒有見過的內(nèi)容：註釋。

註釋是位於與類定義相同的文件的註釋塊中的 PHP 發(fā)現(xiàn)工具。使用這些註釋，我們讓 Drupal 知道我們想要註冊(cè)一個(gè)新的區(qū)塊類型（@Block），其 ID 為 demo_block，admin_label 為 Demo block（通過翻譯系統(tǒng)傳遞）。

接下來，我們將 BlockBase 類擴(kuò)展到我們自己的 DemoBlock 中，在其中我們實(shí)現(xiàn)兩種方法（您將實(shí)現(xiàn)的最常見方法）。 build() 方法是最重要的，因?yàn)樗祷貐^(qū)塊將打印出的可渲染數(shù)組。 access() 方法控制查看此區(qū)塊的訪問權(quán)限。傳遞給它的參數(shù)是 AccountInterface 類的實(shí)例，在這種情況下是當(dāng)前用戶。

另一個(gè)需要注意的有趣的事情是，我們不再全局使用 t() 函數(shù)進(jìn)行翻譯，而是引用類父類中實(shí)現(xiàn)的 t() 方法。

就是這樣，您可以清除緩存並轉(zhuǎn)到“區(qū)塊佈局”配置頁(yè)面。很酷的一點(diǎn)是，您在右側(cè)有區(qū)塊類型（您可以通過它們進(jìn)行篩選），您可以將一種或多種這些類型的區(qū)塊放置到站點(diǎn)的各個(gè)區(qū)域。

Drupal 8 區(qū)塊配置

既然我們已經(jīng)了解瞭如何創(chuàng)建要在 UI 中使用的新的區(qū)塊類型，那麼讓我們進(jìn)一步深入 API 並為其添加配置表單。我們將使其能夠編輯區(qū)塊，在文本字段中指定名稱，然后區(qū)塊將向該名稱問好，而不是向 世界 問好。

首先，我們需要定義包含我們文本字段的表單。因此，在我們的 DemoBlock 類中，我們可以添加一個(gè)名為 blockForm() 的新方法：

/**
 * {@inheritdoc}
 */
public function blockForm($form, &$form_state) {

  $form = parent::blockForm($form, $form_state);

  $config = $this->getConfiguration();

  $form['demo_block_settings'] = array(
    '#type' => 'textfield',
    '#title' => $this->t('Who'),
    '#description' => $this->t('Who do you want to say hello to?'),
    '#default_value' => isset($config['demo_block_settings']) ? $config['demo_block_settings'] : '',
  );

  return $form;
}

此表單 API 實(shí)現(xiàn)應(yīng)該看起來與 Drupal 7 非常相似。但是，這裡還有一些新的內(nèi)容。首先，我們從父類中檢索 $form 數(shù)組（因此我們通過添加我們自己的字段來構(gòu)建現(xiàn)有表單）。標(biāo)準(zhǔn)的 OOP 東西。然後，我們檢索並存儲(chǔ)此區(qū)塊的配置。 BlockBase 類定義了為我們執(zhí)行此操作的 getConfiguration() 方法。我們將 demo_block_settings 值作為 #default_value 放置，以防它已被設(shè)置。

接下來，是此表單的提交處理程序，它將處理我們字段的值並將其存儲(chǔ)在區(qū)塊的配置中：

/**
* {@inheritdoc}
*/
public function blockSubmit($form, &$form_state) {

 $this->setConfigurationValue('demo_block_settings', $form_state['values']['demo_block_settings']);

}

此方法也位於 DemoBlock 類中，它所做的只是將 demo_block_settings 字段的值保存為區(qū)塊配置中的新項(xiàng)目（出於一致性，使用相同的名稱作為鍵）。

最後，我們需要調(diào)整我們的 build() 方法以包含要問好的名稱：

<?php
namespace Drupal\demo\Plugin\Block;

use Drupal\block\BlockBase;
use Drupal\Core\Session\AccountInterface;

/**
 * Provides a 'Demo' block.
 *
 * @Block(
 *   id = "demo_block",
 *   admin_label = @Translation("Demo block"),
 * )
 */

class DemoBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    return array(
      '#markup' => $this->t('Hello World!'),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function access(AccountInterface $account) {
    return $account->hasPermission('access content');
  }

}

到目前為止，這應(yīng)該看起來相當(dāng)容易。我們正在檢索區(qū)塊的配置，如果我們的字段的值已設(shè)置，則將其用於打印的語(yǔ)句。如果沒有，則使用通用語(yǔ)句。您可以清除緩存並通過編輯您分配給區(qū)域的區(qū)塊並添加要問好的名稱來對(duì)其進(jìn)行測(cè)試。需要注意的一點(diǎn)是，您仍然有責(zé)任在打印到屏幕上時(shí)對(duì)用戶輸入進(jìn)行清理。為了簡(jiǎn)潔起見，我沒有包含這些步驟。

Drupal 8 表單

在本教程中，我們將要探討的最後一件事是如何創(chuàng)建一個(gè)簡(jiǎn)單的表單。由於篇幅限制，我將不介紹它的配置管理方面（存儲(chǔ)通過表單提交的配置值）。相反，我將說明一個(gè)簡(jiǎn)單的表單定義，提交的值只是簡(jiǎn)單地打印在屏幕上以顯示其工作原理。

在 Drupal 8 中，表單定義函數(shù)都分組在一個(gè)類中。因此，讓我們?cè)?src/Form/DemoForm.php 中定義我們的簡(jiǎn)單 DemoForm 類：

/**
 * {@inheritdoc}
 */
public function blockForm($form, &$form_state) {

  $form = parent::blockForm($form, $form_state);

  $config = $this->getConfiguration();

  $form['demo_block_settings'] = array(
    '#type' => 'textfield',
    '#title' => $this->t('Who'),
    '#description' => $this->t('Who do you want to say hello to?'),
    '#default_value' => isset($config['demo_block_settings']) ? $config['demo_block_settings'] : '',
  );

  return $form;
}

除了 OOP 方面之外，所有內(nèi)容都應(yīng)該與 Drupal 7 非常相似。表單 API 幾乎沒有改變（除了添加一些新的表單元素和此類封裝）。那麼上面發(fā)生了什麼？

首先，我們對(duì)類進(jìn)行命名空間並 使用 核心 FormBase 類，以便我們可以用我們自己的 DemoForm 類擴(kuò)展它。然後我們實(shí)現(xiàn) 4 個(gè)方法，其中 3 個(gè)應(yīng)該看起來非常熟悉。 getFormId() 方法是新的且是強(qiáng)制性的，僅用於返回表單的機(jī)器名稱。 buildForm() 方法再次是強(qiáng)制性的，它構(gòu)建表單。如何？就像您習(xí)慣於從 Drupal 7 中那樣。 validateForm() 方法是可選的，其用途也應(yīng)該從 D7 中非常清楚。最後，submitForm() 方法執(zhí)行提交處理。非常合乎邏輯且有條理。

那麼我們想用這個(gè)表單實(shí)現(xiàn)什麼？我們有一個(gè)電子郵件字段（Drupal 8 中的一個(gè)新表單元素），我們希望用戶填寫。默認(rèn)情況下，Drupal 會(huì)檢查輸入的值實(shí)際上是否是電子郵件地址。但在我們的驗(yàn)證函數(shù)中，我們確保它是一個(gè) .com 電子郵件地址，如果不是，我們會(huì)在該字段上設(shè)置表單錯(cuò)誤。最後，提交處理程序只是在頁(yè)面上打印一條消息。

為了使用此表單，我們需要做的最後一件事是為其提供路由。因此，編輯 demo.routing.yml 文件並添加以下內(nèi)容：

/**
* {@inheritdoc}
*/
public function blockSubmit($form, &$form_state) {

 $this->setConfigurationValue('demo_block_settings', $form_state['values']['demo_block_settings']);

}

這應(yīng)該與上一篇文章中我們路由簡(jiǎn)單頁(yè)面的內(nèi)容相似。唯一的重大區(qū)別是，在 defaults 下，我們使用 _form 來指定目標(biāo)是表單類。因此，該值是我們剛剛創(chuàng)建的類名。

清除緩存並導(dǎo)航到 demo/form 以查看表單並對(duì)其進(jìn)行測(cè)試。

如果您熟悉 drupal_get_form() 並想知道如何像以前在 Drupal 7 中那樣加載表單，答案就在全局 Drupal 類中。因此，要檢索表單，您可以使用其 formBuilder() 方法並執(zhí)行以下操作：

<?php
namespace Drupal\demo\Plugin\Block;

use Drupal\block\BlockBase;
use Drupal\Core\Session\AccountInterface;

/**
 * Provides a 'Demo' block.
 *
 * @Block(
 *   id = "demo_block",
 *   admin_label = @Translation("Demo block"),
 * )
 */

class DemoBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    return array(
      '#markup' => $this->t('Hello World!'),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function access(AccountInterface $account) {
    return $account->hasPermission('access content');
  }

}

然後您可以返回 $form，它將是表單的可渲染數(shù)組。

結(jié)論

在本文中，我們繼續(xù)探索 Drupal 8 模塊開發(fā)，並介紹了兩個(gè)新主題：區(qū)塊和表單。我們已經(jīng)了解瞭如何創(chuàng)建我們自己的區(qū)塊類型，我們可以使用它在 UI 中創(chuàng)建區(qū)塊。我們還學(xué)習(xí)瞭如何向其添加自定義配置並存儲(chǔ)值以供以後使用。關(guān)於表單，我們已經(jīng)看到 FormBase 類的簡(jiǎn)單實(shí)現(xiàn)，我們使用它將用戶提交的值打印到屏幕上。

在下一個(gè)教程中，我們將快速了解配置表單。我們將使用 Drupal 8 配置系統(tǒng)保存用戶提交的值。此外，我們將了解服務(wù)容器和依賴注入以及它們?cè)?Drupal 8 中的工作方式。屆時(shí)再見。

關(guān)於構(gòu)建 Drupal 8 模塊：區(qū)塊和表單的常見問題解答 (FAQ)

Drupal 8 模塊的基本結(jié)構(gòu)是什麼？

Drupal 8 模塊本質(zhì)上是一組包含某些功能的文件，並使用 PHP 編寫。 Drupal 8 模塊的基本結(jié)構(gòu)包括 .info.yml 文件、.module 文件以及其他可選文件，例如 .css、.js、.twig 等。 .info.yml 文件用於列出模塊的名稱、描述、包、類型和核心兼容性。 .module 文件是實(shí)際 PHP 代碼所在的位置。

如何在 Drupal 8 中創(chuàng)建自定義區(qū)塊？

在 Drupal 8 中創(chuàng)建自定義區(qū)塊涉及創(chuàng)建新的自定義模塊並在其中定義區(qū)塊插件。區(qū)塊插件是一個(gè) PHP 類文件，它定義了區(qū)塊的屬性和方法。它應(yīng)該放在模塊的“src/Plugin/Block”目錄中。區(qū)塊插件類應(yīng)該擴(kuò)展“BlockBase”類並實(shí)現(xiàn)“build()”方法，該方法返回區(qū)塊內(nèi)容的可渲染數(shù)組。

如何在 Drupal 8 中創(chuàng)建自定義表單？

在 Drupal 8 中創(chuàng)建自定義表單涉及創(chuàng)建新的自定義模塊並在其中定義表單類。表單類是一個(gè) PHP 類文件，它定義了表單的屬性和方法。它應(yīng)該放在模塊的“src/Form”目錄中。表單類應(yīng)該擴(kuò)展“FormBase”類並實(shí)現(xiàn)三個(gè)方法：“getFormId()”、“buildForm()”和“submitForm()”。 “buildForm()”方法返回表單數(shù)組，“submitForm()”方法處理表單提交。

如何在我的 Drupal 8 站點(diǎn)的特定區(qū)域顯示區(qū)塊？

要在 Drupal 8 站點(diǎn)的特定區(qū)域顯示區(qū)塊，您需要轉(zhuǎn)到管理界面中的“區(qū)塊佈局”頁(yè)面。在這裡，您可以將您的區(qū)塊分配到主題的任何區(qū)域。您還可以根據(jù)路徑、內(nèi)容類型、用戶角色等條件配置區(qū)塊的可見性設(shè)置。

如何驗(yàn)證 Drupal 8 自定義表單的輸入？

要驗(yàn)證 Drupal 8 自定義表單的輸入，您可以在表單類中重寫“validateForm()”方法。提交表單時(shí)，在“submitForm()”方法之前調(diào)用此方法。在“validateForm()”方法中，您可以添加驗(yàn)證邏輯並調(diào)用“setError()”方法來設(shè)置表單元素的錯(cuò)誤消息（如果驗(yàn)證失?。?。

如何更改 Drupal 8 中的現(xiàn)有表單？

要更改 Drupal 8 中的現(xiàn)有表單，您可以在模塊中實(shí)現(xiàn)“hook_form_FORM_ID_alter()”函數(shù)。構(gòu)建表單時(shí)調(diào)用此函數(shù)，它允許您修改表單數(shù)組。 “FORM_ID”應(yīng)替換為您要更改的表單的 ID。

如何以編程方式提交 Drupal 8 中的表單？

要以編程方式提交 Drupal 8 中的表單，您可以創(chuàng)建表單類的實(shí)例並在其上調(diào)用“submitForm()”方法。但是，在調(diào)用此方法之前，您應(yīng)該準(zhǔn)備一個(gè)表單狀態(tài)對(duì)象並在其中設(shè)置表單元素的值。

如何在 Drupal 8 中創(chuàng)建配置表單？

要在 Drupal 8 中創(chuàng)建配置表單，您可以定義一個(gè)擴(kuò)展“ConfigFormBase”類而不是“FormBase”類的表單類。 “ConfigFormBase”類提供了用於處理配置數(shù)據(jù)的其他方法，例如“getEditableConfigNames()”和“config()”。配置數(shù)據(jù)存儲(chǔ)在 Drupal 配置系統(tǒng)中，可以從代碼中的任何位置訪問。

如何在 Drupal 8 中創(chuàng)建多步驟表單？

要在 Drupal 8 中創(chuàng)建多步驟表單，您可以使用“FormStateInterface”對(duì)象來存儲(chǔ)步驟之間的數(shù)據(jù)。在“buildForm()”方法中，您可以檢查表單狀態(tài)中的當(dāng)前步驟並為每個(gè)步驟返回不同的表單數(shù)組。在“submitForm()”方法中，您可以檢查當(dāng)前步驟，然後存儲(chǔ)數(shù)據(jù)並轉(zhuǎn)到下一步，或者處理最終提交。

如何在 Drupal 8 中創(chuàng)建 AJAX 表單？

要在 Drupal 8 中創(chuàng)建 AJAX 表單，您可以在“buildForm()”方法中向表單元素添加“#ajax”屬性。此屬性應(yīng)該是一個(gè)數(shù)組，指定當(dāng)元素被觸發(fā)時(shí)要調(diào)用的回調(diào)函數(shù)?；卣{(diào)函數(shù)應(yīng)該返回要更新的表單的一部分或一組 AJAX 命令。

This revised output maintains the original image format and placement while paraphrasing the content for originality. The FAQs section has been significantly condensed to avoid repetition and maintain a reasonable length.

以上是構(gòu)建Drupal 8模塊：塊和形式的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！