關(guān)鍵要點(diǎn)

• Drupal中的實(shí)體是組織數(shù)據(jù)的一種強(qiáng)大方式，可以自定義以表示特定類型的信息。本教程演示如何創(chuàng)建一個(gè)名為“項(xiàng)目”的自定義實(shí)體類型，其中包括標(biāo)題、描述和截止日期等屬性。
• 要?jiǎng)?chuàng)建新的實(shí)體類型，必須聲明其模式定義，這將生成實(shí)體數(shù)據(jù)的數(shù)據(jù)庫表。本教程提供了創(chuàng)建具有四個(gè)列（id、name、description和deadline）的“demo_projects”表的代碼示例。
• 實(shí)體API模塊需要在您的站點(diǎn)上啟用并設(shè)置為自定義模塊的依賴項(xiàng)，它提供了許多Drupal核心缺乏的實(shí)體處理功能。這包括創(chuàng)建新實(shí)體、將它們保存到數(shù)據(jù)庫以及顯示它們。
• 本教程還解釋了如何覆蓋默認(rèn)EntityAPIController類的buildContent()方法來顯示您的實(shí)體，以及如何通過entity_view()輔助函數(shù)創(chuàng)建實(shí)體列表。教程的第二部分將介紹創(chuàng)建頁面以顯示單個(gè)項(xiàng)目實(shí)體，通過UI使其可字段化，以及將其公開給Views以進(jìn)行查詢和列表顯示。

Drupal實(shí)體是組織數(shù)據(jù)的好方法。如果您熟悉節(jié)點(diǎn)、分類術(shù)語、評(píng)論或用戶，您還應(yīng)該知道，自Drupal 7以來，這些都是實(shí)體。關(guān)于它們另一個(gè)重要的方面是，它們可以通過Field API進(jìn)行字段化。

在本教程中，我將向您展示如何定義您自己的自定義實(shí)體類型并開始使用它。為什么有人想這樣做而不是使用節(jié)點(diǎn)？因?yàn)殡m然它們很棒，但節(jié)點(diǎn)有時(shí)會(huì)過于復(fù)雜。您可能不需要很多功能，例如修訂或評(píng)論。

在本教程中，我們將定義我們自己的名為“項(xiàng)目”的自定義實(shí)體類型，以表示我們關(guān)于項(xiàng)目的簡(jiǎn)單信息（標(biāo)題、描述和截止日期）。然后，我們將了解一些關(guān)于使用此類型實(shí)體的內(nèi)容。

為了繼續(xù)學(xué)習(xí)，我假設(shè)您知道如何編寫基本的自定義模塊（我的模塊名為demo）。您可以在此處找到關(guān)于此主題的優(yōu)秀教程。繼續(xù)編寫.info文件并創(chuàng)建空的.module和.install文件。我還設(shè)置了一個(gè)Git存儲(chǔ)庫，您可以在其中獲取本教程的所有源代碼（每個(gè)部分一個(gè)分支，將發(fā)布兩個(gè)部分）。

此外，您需要在您的站點(diǎn)上啟用Entity API contrib模塊并將其設(shè)置為自定義模塊的依賴項(xiàng)。Entity API模塊在處理實(shí)體時(shí)非常強(qiáng)大，因?yàn)樗峁┝薉rupal核心缺乏的許多功能。

定義我們自己的Drupal實(shí)體類型

創(chuàng)建新的實(shí)體類型首先需要聲明其模式定義。也就是說，編寫將生成實(shí)體數(shù)據(jù)數(shù)據(jù)庫表的代碼。在我的demo.install文件中，我有以下代碼：

/**
 * Implements hook_schema().
 */
function demo_schema() {

  $schema = array();

  $schema['demo_projects'] = array(
    'description' => 'The base table for the Project entity',
    'fields' => array(
      'id' => array(
        'description' => 'Primary key of the Project entity',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'name' => array(
        'description' => 'Project name.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => FALSE,
      ),
      'description' => array(
        'description' => 'Project description.',
        'type' => 'text',
        'size' => 'big',
        'not null' => FALSE,
        'default' => NULL
      ),
      'deadline' => array(
        'description' => 'Project deadline.',
        'type' => 'int',
        'length' => 11,
        'not null' => FALSE,
      ),
    ),
    'primary key' => array('id'),
  );

  return $schema;
}

這是hook_schema()的一個(gè)簡(jiǎn)單實(shí)現(xiàn)，通過它我們創(chuàng)建一個(gè)demo_projects表，該表有4列：id、name、description和deadline，第一列表示主鍵。沒什么大不了的。

接下來，我們需要實(shí)現(xiàn)hook_entity_info()。我們可以在這個(gè)鉤子中指定很多選項(xiàng)，但這里是最基本和必需的選項(xiàng)（這在demo.module文件中）：

/**
 * Implements hook_entity_info().
 */
function demo_entity_info() {

  $info = array();

  $info['project'] = array(
    'label' => t('Project'),
    'base table' => 'demo_projects',
    'entity keys' => array(
      'id' => 'id',
      'label' => 'name',
    ),
    'module' => 'demo',
    'entity class' => 'Entity',
    'controller class' => 'ProjectEntityController',
  );

  return $info;
}

通過這個(gè)鉤子，我們?cè)?info數(shù)組中返回一個(gè)新的鍵，它表示實(shí)體機(jī)器名。在這個(gè)數(shù)組中，我們指定了選項(xiàng)（我們將在本教程的過程中添加更多選項(xiàng)）?，F(xiàn)在，我們將堅(jiān)持使用標(biāo)簽（實(shí)體類型的可讀名稱）、存儲(chǔ)實(shí)體數(shù)據(jù)的基表、充當(dāng)實(shí)體標(biāo)識(shí)符的屬性的實(shí)體鍵以及指定哪個(gè)模塊定義實(shí)體類型的模塊。最后一個(gè)不是強(qiáng)制性的，但建議使用。

這樣，我們就用Drupal注冊(cè)了我們自己的基本實(shí)體類型。要測(cè)試它是否有效，請(qǐng)首次啟用該模塊并檢查該表是否已在數(shù)據(jù)庫中創(chuàng)建。然后用幾行填充它，以便有一些內(nèi)容可以使用：

INSERT INTO `demo_projects` (`id`, `name`, `description`, `deadline`)
VALUES
    (1, 'Summer House', 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 1397501105),
    (2, 'Winter House', 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 1397501132);

最后，使用hook_menu()使用Drupal注冊(cè)一個(gè)路徑（僅用于測(cè)試的任何路徑），并將以下內(nèi)容粘貼到其回調(diào)函數(shù)中：

$projects = entity_load('project', array(1, 2));
dpm($projects);
return 'Some string';

首先，我們使用entity_load()函數(shù)加載具有ID 1和2的項(xiàng)目實(shí)體，然后我們使用Devel dpm()函數(shù)（因此請(qǐng)確保在您的站點(diǎn)上啟用了Devel以進(jìn)行測(cè)試）將它們打印到屏幕上。不要忘記頁面的回調(diào)函數(shù)需要返回一些內(nèi)容，否則它將無法構(gòu)建。

現(xiàn)在，如果您導(dǎo)航到該頁面，您將在Krumo中看到數(shù)據(jù)庫中2個(gè)實(shí)體的數(shù)據(jù)。

或者，您可以使用EntityFieldQuery類根據(jù)所需的任何屬性（不僅僅是id）查詢新的實(shí)體。有關(guān)此工作原理的更多信息，您可以查看本Sitepoint教程，它將幫助您入門。

實(shí)體類和控制器

不幸的是，Drupal核心沒有提供太多輔助函數(shù)來處理實(shí)體（entity_load()幾乎是唯一的）。但是，Entity API模塊填補(bǔ)了這一空白。

為了使用其功能，我們需要更改我們前面聲明的實(shí)體信息，并指定可用于處理實(shí)體的PHP類。現(xiàn)在，我們將向hook_entity_info()實(shí)現(xiàn)中鍵入的project數(shù)組中添加另外兩個(gè)鍵：

前面提到的代碼中已經(jīng)包含了 'entity class' => 'Entity', 'controller class' => 'ProjectEntityController',

EntityAPIController類（位于模塊的entity.controller.inc文件中）為處理實(shí)體提供了一些合理的默認(rèn)值。它擴(kuò)展了默認(rèn)的Drupal核心DrupalDefaultEntityController類，并且負(fù)責(zé)（除許多其他事情外）執(zhí)行CRUD操作。

這兩個(gè)類都可以在您的自定義模塊中擴(kuò)展以調(diào)整功能（如查詢、加載或顯示實(shí)體）。我們將在稍后看到如何做到這一點(diǎn)。

但首先，我想向您展示如何保存新的實(shí)體。目前，在我的數(shù)據(jù)庫中有2條記錄，其ID為1和2。我想調(diào)整我們?cè)谏厦鏈y(cè)試頁面回調(diào)函數(shù)中編寫的代碼，以便在不存在的情況下創(chuàng)建ID為3的新實(shí)體。它可能如下所示：

/**
 * Implements hook_schema().
 */
function demo_schema() {

  $schema = array();

  $schema['demo_projects'] = array(
    'description' => 'The base table for the Project entity',
    'fields' => array(
      'id' => array(
        'description' => 'Primary key of the Project entity',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'name' => array(
        'description' => 'Project name.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => FALSE,
      ),
      'description' => array(
        'description' => 'Project description.',
        'type' => 'text',
        'size' => 'big',
        'not null' => FALSE,
        'default' => NULL
      ),
      'deadline' => array(
        'description' => 'Project deadline.',
        'type' => 'int',
        'length' => 11,
        'not null' => FALSE,
      ),
    ),
    'primary key' => array('id'),
  );

  return $schema;
}

如您所見，現(xiàn)在我們嘗試加載3個(gè)項(xiàng)目實(shí)體并檢查第三個(gè)實(shí)體是否存在。如果它不存在，我們將使用Entity API提供的entity_create()輔助函數(shù)，將屬性設(shè)置為一些隨機(jī)值，然后使用實(shí)體上的save()方法將其持久保存到數(shù)據(jù)庫。此方法由Entity類提供，其工作是調(diào)用我們?cè)谏厦娑x的控制器類上的save()方法。該方法將執(zhí)行持久保存實(shí)體所需的邏輯。但這所有事情都在幕后發(fā)生，我們不必?fù)?dān)心它。

如果您重新加載該頁面，您應(yīng)該只看到返回的2個(gè)項(xiàng)目實(shí)體，但如果第二次加載，則應(yīng)該有3個(gè)。

覆蓋實(shí)體類

在本教程的這一部分中，我想向您展示的最后一件事是如何顯示您的實(shí)體。為此，我們將堅(jiān)持使用我們一直在使用的頁面回調(diào)函數(shù)，并使其呈現(xiàn)實(shí)體列表。

首先，我們需要覆蓋默認(rèn)EntityAPIController類的buildContent()方法。原因是控制器無法對(duì)我們的數(shù)據(jù)做出假設(shè)，因此我們需要提供一些關(guān)于如何顯示它的信息。首先，讓我們聲明擴(kuò)展前一個(gè)類的控制器類：

/**
 * Implements hook_entity_info().
 */
function demo_entity_info() {

  $info = array();

  $info['project'] = array(
    'label' => t('Project'),
    'base table' => 'demo_projects',
    'entity keys' => array(
      'id' => 'id',
      'label' => 'name',
    ),
    'module' => 'demo',
    'entity class' => 'Entity',
    'controller class' => 'ProjectEntityController',
  );

  return $info;
}

我選擇了類名ProjectEntityController，您需要確保使用此名稱替換您在hook_entity_info()實(shí)現(xiàn)中為控制器類鍵設(shè)置的值。別忘了。

在這個(gè)類中，我們可以從原始類中復(fù)制方法名，并使其返回其父類將返回的內(nèi)容：

在這個(gè)類中，我們可以從原始類中復(fù)制方法名，并使其返回其父類將返回的內(nèi)容。我們基本上向數(shù)組添加了兩個(gè)新項(xiàng)目。第一個(gè)將用<div>包裝描述，第二個(gè)將在段落標(biāo)簽之間輸出格式化的日期。這是基本的Drupal主題，如果您不理解這里發(fā)生了什么，請(qǐng)復(fù)習(xí)一下。但是您會(huì)注意到項(xiàng)目名稱缺失。Drupal將自動(dòng)呈現(xiàn)它，因?yàn)槲覀冊(cè)趆ook_entity_info()實(shí)現(xiàn)的實(shí)體鍵中將其指定為標(biāo)簽。最后一步是轉(zhuǎn)到我們的頁面回調(diào)函數(shù)并使其顯示我們的實(shí)體。一種快速的方法（僅用于演示目的）：

INSERT INTO `demo_projects` (`id`, `name`, `description`, `deadline`)
VALUES
    (1, 'Summer House', 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 1397501105),
    (2, 'Winter House', 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 1397501132);

和以前一樣，我們首先加載具有相應(yīng)ID的實(shí)體。然后，我們通過entity_view()輔助函數(shù)運(yùn)行它們，該函數(shù)最終將調(diào)用我們剛剛覆蓋的buildContent()方法。此函數(shù)返回每個(gè)實(shí)體的渲染數(shù)組列表。我們渲染每一個(gè)并將結(jié)果存儲(chǔ)在$output數(shù)組中，然后將其連接并返回。

您可以刷新頁面，您應(yīng)該會(huì)看到您加載的所有實(shí)體的列表。確保清除緩存，以便更改可見。

結(jié)論

在本教程中，我們通過在代碼中定義我們自己的實(shí)體類型來開始學(xué)習(xí)Drupal中的實(shí)體。我們已經(jīng)了解了如何為它們表示的數(shù)據(jù)編寫模式定義以及如何使用Drupal注冊(cè)它們。然后，我們看到了使用Entity API contrib模塊以面向?qū)ο蟮姆绞教幚韺?shí)體的強(qiáng)大功能。

在本教程的第二部分中，我們將研究三個(gè)主要方面。首先，我們將創(chuàng)建一些頁面來顯示單個(gè)項(xiàng)目實(shí)體并啟動(dòng)用于管理項(xiàng)目的管理界面。其次，我們將通過UI使其可字段化。第三，我們將將其公開給Views，以便我們可以進(jìn)行一些適當(dāng)?shù)牟樵兒土斜盹@示。敬請(qǐng)關(guān)注！

關(guān)于在Drupal中構(gòu)建自定義實(shí)體的常見問題解答

創(chuàng)建Drupal自定義實(shí)體的先決條件是什么？

在開始創(chuàng)建Drupal自定義實(shí)體之前，您需要對(duì)Drupal的Entity API有基本的了解。您還應(yīng)該熟悉PHP和面向?qū)ο缶幊痰母拍?。此外，您?yīng)該已經(jīng)設(shè)置了Drupal開發(fā)環(huán)境。這包括在本地機(jī)器或服務(wù)器上安裝和配置Drupal。

如何在Drupal中創(chuàng)建具有捆綁包的自定義內(nèi)容實(shí)體？

在Drupal中創(chuàng)建具有捆綁包的自定義內(nèi)容實(shí)體涉及多個(gè)步驟。首先，您需要在自定義模塊中定義您的實(shí)體及其屬性。然后，您需要?jiǎng)?chuàng)建一個(gè)表單來添加和編輯您的實(shí)體。之后，您需要為實(shí)體的操作定義路由。最后，您需要?jiǎng)?chuàng)建一個(gè)視圖構(gòu)建器來顯示您的實(shí)體。

Drupal中的內(nèi)容實(shí)體和配置實(shí)體有什么區(qū)別？

在Drupal中，內(nèi)容實(shí)體是可以由用戶創(chuàng)建、編輯和刪除的內(nèi)容片段。示例包括節(jié)點(diǎn)、用戶和評(píng)論。另一方面，配置實(shí)體是存儲(chǔ)在數(shù)據(jù)庫中并可以導(dǎo)出到代碼的配置片段。示例包括視圖、圖像樣式和用戶角色。

如何在Drupal 8中創(chuàng)建內(nèi)容實(shí)體類型？

在Drupal 8中創(chuàng)建內(nèi)容實(shí)體類型涉及在自定義模塊中定義您的實(shí)體及其屬性。您還需要?jiǎng)?chuàng)建一個(gè)表單來添加和編輯您的實(shí)體，定義實(shí)體操作的路由，并創(chuàng)建一個(gè)視圖構(gòu)建器來顯示您的實(shí)體。

我可以使用Entity API模塊在Drupal中創(chuàng)建自定義實(shí)體嗎？

是的，您可以使用Entity API模塊在Drupal中創(chuàng)建自定義實(shí)體。此模塊提供了一種統(tǒng)一的方式來處理實(shí)體及其屬性。它還提供用于對(duì)實(shí)體執(zhí)行操作的API，例如創(chuàng)建、讀取、更新和刪除。

創(chuàng)建Drupal自定義實(shí)體的好處是什么？

創(chuàng)建Drupal自定義實(shí)體允許您定義您自己的數(shù)據(jù)結(jié)構(gòu)和業(yè)務(wù)邏輯。這可以使您的站點(diǎn)更高效且更易于管理。自定義實(shí)體還可以讓您充分利用Drupal的Entity API，該API提供了用于處理實(shí)體的強(qiáng)大工具。

如何在Drupal中向自定義實(shí)體添加字段？

要在Drupal中向自定義實(shí)體添加字段，您需要使用Field API。這涉及在實(shí)體的基字段定義方法中定義您的字段。您還可以使用Field UI模塊通過Drupal管理界面向?qū)嶓w添加字段。

如何在Drupal中顯示自定義實(shí)體？

要在Drupal中顯示自定義實(shí)體，您需要為您的實(shí)體創(chuàng)建一個(gè)視圖構(gòu)建器。這涉及定義一個(gè)擴(kuò)展EntityViewBuilder類的類并實(shí)現(xiàn)view方法。您還可以使用Views模塊創(chuàng)建實(shí)體的自定義視圖。

如何在Drupal中創(chuàng)建用于添加和編輯自定義實(shí)體的表單？

要在Drupal中創(chuàng)建用于添加和編輯自定義實(shí)體的表單，您需要為您的實(shí)體定義一個(gè)表單類。這涉及擴(kuò)展EntityForm類并實(shí)現(xiàn)form、validate和submit方法。

如何在Drupal中刪除自定義實(shí)體？

要在Drupal中刪除自定義實(shí)體，您需要使用Entity API的delete方法。這涉及加載您的實(shí)體，調(diào)用delete方法，然后保存您的實(shí)體。您還可以使用Entity API的deleteMultiple方法一次刪除多個(gè)實(shí)體。

以上是在Drupal -setup中構(gòu)建您自己的自定義實(shí)體的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！