了解Drupal的EntityFieldQuery-php教程-PHP中文網

鑰匙要點

> EntityFieldQuery類用於在Drupal中找到符合某些條件的實體。 EntityFieldQuery在您的Drupal安裝中的inclate/entity.inc文件中存在。

如何使用EntityFieldQuery從特定的實體類型中獲取數據？要從特定實體類型中獲取數據，您可以使用EntityFieldQuery類的“實體調節”方法。此方法接受兩個參數：條件類型（對於這種情況，應為“ ENTITY_TYPE”）和您要從中獲取數據的實體類型。以下是一個示例：

$ query = new EntityFieldQuery（）;

我可以一次使用EntityFieldQuery一次從多個實體類型中獲取數據嗎？一次支持一次從一個實體類型中獲取數據。如果您需要從多種實體類型中獲取數據，則需要對每種類型進行單獨的查詢。 >

>如何對EntityFieldQuery的結果進行分類？

是的，您可以使用“ fieldCondition”方法從自定義字段獲取數據。此方法接受三個參數：字段名稱，要過濾的列以及要過濾的值。這是一個示例：

$ query-> entityCondition（'entity_type'，'node'，'node'）

$ result = $ query-> execute（）;

首頁

後端開發

php教程

了解Drupal的EntityFieldQuery

Jennifer Aniston

Feb 22, 2025 am 08:27 AM

了解Drupal的EntityFieldQuery

鑰匙要點

> EntityFieldQuery是Drupal的一類，允許開發人員從數據庫中獲取有關實體的信息，而無需編寫SQL查詢，從而更容易檢索，過濾和排序數據。當需要從多個表獲取數據或要應用複雜條件到查詢時，這一點特別有用。
>可以擴展EntityFieldQuery類以創建自己的子類，從而使您可以在多個位置構建相同的查詢。例如，您可能需要構建一個查詢，以以創建日期的上升順序獲得所有活躍的用戶。這可以通過創建一個擴展EntityFieldQuery並設置適當條件和順序的新類來實現。
> EntityFieldQuery支持各種方法，例如從特定實體類型中獲取數據，``propertyCondition''用於添加基於實體屬性的條件的``propertyCondition''，用於從自定義字段獲取數據的fieldCondition和`forthConcondition''forthConcondition'和``fieldCondition''對結果進行排序。但是，它僅支持一次從一個實體類型中獲取數據。如果您需要從多個實體類型中獲取數據，則需要對每種類型運行單獨的查詢。 >

簡介

>構建複雜的Web應用程序時，您最終必須與數據庫進行交互。要檢索Drupal中的數據，可以使用提供的數據庫抽象層，這需要正確使用一些SQL知識。提供了Drupal 7 EntityFieldQuery API，可讓您在不實際構建SQL查詢的情況下獲取有關Drupal的實體的信息。在本文中，讓我們看看如何使用EntityFieldQuery API從Drupal獲取數據並在我們的模塊中使用。

> ENTITYFIELDQUERY類

> EntityFieldQuery類用於在Drupal中找到符合某些條件的實體。 EntityFieldQuery在您的Drupal安裝中的inclate/entity.inc文件中存在。

此類具有不同的方法來指定實體類型和基於某些條件，我們可以過濾我們要獲取的數據。在本文中，我們將詳細介紹這些方法。

首先，在使用EntityFieldQuery時將遵循的基本用法首先是創建此類的對象。創建對像後，您將為其添加一些條件，然後調用執行方法以獲取結果。
一般模板如下
>

>我們現在將創建一個Drupal模塊，該模塊將安裝3種新的Drupal節點類型：產品，電影和書籍以及一個將顯示結果的塊。您可以在本文中查看如何創建節點類型

模塊的代碼為

<span>$entityquery = new EntityFieldQuery();
</span><span>/// Set some conditions   
</span><span>$result = $query->execute ();</span>

登入後複製

entityquery.info >

> entityquery.install

name <span>= entityquery
</span>description <span>= Shows how to use entity query to fetch data from drupal
</span>package <span>= Entity Query Example
</span>core <span>= 7.x</span>

登入後複製

entityquery.module

<span>$entityquery = new EntityFieldQuery();
</span><span>/// Set some conditions   
</span><span>$result = $query->execute ();</span>

登入後複製

>將此模塊放入模塊文件夾中，如果一切順利，您將能夠在模塊列表中看到EntityQuery模塊，如下所示。

了解Drupal的EntityFieldQuery

安裝模塊後，您應該能夠在Drupal Admin面板的“添加內容”部分中看到新的節點類型，如下所示

了解Drupal的EntityFieldQuery >使用EntityFieldQuery

執行簡單查詢

>我們設置了用於使用EntityFieldQuery的基本模塊後，讓我們開始編寫一些查詢以從Drupal獲取數據。我們要寫的第一個查詢是使用EntityFieldQuery獲取所有節點。然後，我們將使用它在我們的塊中顯示節點的標題。 > 如前所述，第一件事是創建一個EFQ實例。要獲取一種類型的實體，您必須向其添加Entity_Type條件。在這種情況下，我們要獲取節點，以便其代碼如下：>

使用我們將實體類型設置為節點的函數實體條件設置實體條件。設置實體條件後，我們就可以執行查詢。節點ID在結果的節點密鑰中返回。顯示節點的完整代碼將如下：

現在，如果您去看塊，則應該能夠看到其中的所有節點，如下所示

name <span>= entityquery
</span>description <span>= Shows how to use entity query to fetch data from drupal
</span>package <span>= Entity Query Example
</span>core <span>= 7.x</span>

登入後複製

<span><span><?php
</span></span><span><span>/**
</span></span><span><span> * Implement hook_install().
</span></span><span><span> */
</span></span><span><span>function entityquery_install() {
</span></span><span>    <span>node_types_rebuild();
</span></span><span>    <span>$types = node_type_get_types();
</span></span><span>    <span>node_add_body_field($types['product']);
</span></span><span>    <span>node_add_body_field($types['movies']);
</span></span><span>    <span>node_add_body_field($types['books']);
</span></span><span><span>}</span></span>

登入後複製

>現在，您應該嘗試添加不同的節點，例如電影和書籍，並檢查它們在街區中顯示。在以上，代碼一旦我們獲得了EntityFieldQuery的節點ID，我們就會使用node_load_multiple加載節點並顯示它們。

>將實體條件添加到EntityFieldQuery

了解Drupal的EntityFieldQuery >您可以添加實體條件以僅顯示特定類型的節點。如果我們只想從節點類型中顯示“產品”，則我們將使用的查詢是：>

現在，如果我們檢查塊，它將僅顯示產品：

我們甚至可以使用EntityCondition指定一系列節點類型來獲取多種類型的節點。從數據庫中獲取所有產品和電影：

<span><span><?php
</span></span><span><span>/**
</span></span><span><span> * Implement hook_node_info()
</span></span><span><span> */
</span></span><span><span>function entityquery_node_info() {
</span></span><span>    <span>return array(
</span></span><span>        <span>'product' => array(
</span></span><span>            <span>'name' => t('Product'),
</span></span><span>            <span>'base' => 'product',
</span></span><span>            <span>'description' => t('You can define new Products here'),
</span></span><span>            <span>'has_title' => TRUE,
</span></span><span>            <span>'title_label' => t('Product title')
</span></span><span>         <span>),
</span></span><span>        <span>'movies' => array(
</span></span><span>            <span>'name' => t('Movies'),
</span></span><span>            <span>'base' => 'movies',
</span></span><span>            <span>'description' => t('You can define new Movies here'),
</span></span><span>            <span>'has_title' => TRUE,
</span></span><span>            <span>'title_label' => t('Movie title')
</span></span><span>         <span>),
</span></span><span>        <span>'books' => array(
</span></span><span>            <span>'name' => t('Books'),
</span></span><span>            <span>'base' => 'Books',
</span></span><span>            <span>'description' => t('You can define new Books here'),
</span></span><span>            <span>'has_title' => TRUE,
</span></span><span>            <span>'title_label' => t('Books title')
</span></span><span>         <span>)
</span></span><span>    <span>);
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_form()
</span></span><span><span> */
</span></span><span><span>function product_form($node, $form_state) {
</span></span><span>    <span>return node_content_form($node, $form_state);
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_form()
</span></span><span><span> */
</span></span><span><span>function movies_form($node, $form_state) {
</span></span><span>    <span>return node_content_form($node, $form_state);
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_form()
</span></span><span><span> */
</span></span><span><span>function books_form($node, $form_state) {
</span></span><span>    <span>return node_content_form($node, $form_state);
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_block_info().
</span></span><span><span> */
</span></span><span><span>function entityquery_block_info() {
</span></span><span>  <span>$blocks = array();
</span></span><span>
</span><span>  <span>$blocks['entityqueryblock'] = array(
</span></span><span>    <span>'info' => t('A block to display results from entityquery'),
</span></span><span>  <span>);
</span></span><span>
</span><span>  <span>return $blocks;
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_block_view().
</span></span><span><span> */
</span></span><span><span>function entityquery_block_view($block_name = '') {
</span></span><span>  <span>if ($block_name == 'entityqueryblock') {
</span></span><span>    <span>$content ='';
</span></span><span>    <span>$block = array(
</span></span><span>      <span>'subject' => t('A block to display results from entityquery'),
</span></span><span>      <span>'content' => $content,
</span></span><span>    <span>);
</span></span><span>    <span>return $block;
</span></span><span>  <span>}
</span></span><span><span>}</span></span>

登入後複製

>將屬性條件添加到EntityFieldQuery

了解Drupal的EntityFieldQuery >我們甚至可以在查詢中添加屬性條件。這些取決於您要查詢的實體類型。在大多數情況下，屬性條件將在您要查詢的實體類型的字段上。例如，您可以查詢發布的節點，或者由特定用戶編寫等。

僅使用屬性條件顯示出已發布的節點的查詢如下

<span>$entityquery = new EntityFieldQuery();
</span><span>/// Set some conditions   
</span><span>$result = $query->execute ();</span>

登入後複製

>將現場條件添加到EntityFieldQuery並訂購

>場的條件特定於實體上存在的字段。因此，假設我們想找到所有具有折扣單詞折扣的產品 - 我們可以使用現場條件進行。我們甚至可以使用propertyOrderby函數訂購結果。

如果我們想要在其體內有“折扣”的產品和電影，以降序的創建順序排列，則查詢將如下：

name <span>= entityquery
</span>description <span>= Shows how to use entity query to fetch data from drupal
</span>package <span>= Entity Query Example
</span>core <span>= 7.x</span>

登入後複製

此查詢的輸出將如下

了解Drupal的EntityFieldQuery

擴展EntityFieldQuery類

有時，您可能必須在許多地方構建相同的查詢。一種抽象的好方法，是擴展EntityFieldQuery類並創建自己的子類。

假設您想構建一個查詢以按其創建日期的升級順序獲取所有活躍用戶：

現在，您可以在任何地方使用此查詢：

<span><span><?php
</span></span><span><span>/**
</span></span><span><span> * Implement hook_install().
</span></span><span><span> */
</span></span><span><span>function entityquery_install() {
</span></span><span>    <span>node_types_rebuild();
</span></span><span>    <span>$types = node_type_get_types();
</span></span><span>    <span>node_add_body_field($types['product']);
</span></span><span>    <span>node_add_body_field($types['movies']);
</span></span><span>    <span>node_add_body_field($types['books']);
</span></span><span><span>}</span></span>

登入後複製

結論

Drupal中的許多模塊都需要您從數據庫中獲取實體內容。可以直接使用Drupal數據庫層，但是為此，您必須至少具有SQL的工作知識，並且可能更容易出現錯誤。 EntityFieldQuery類是Drupal核心的一部分，您可以輕鬆地使用它，而無需依賴其他模塊。創建下一個Drupal模塊的樂趣！

<span><span><?php
</span></span><span><span>/**
</span></span><span><span> * Implement hook_node_info()
</span></span><span><span> */
</span></span><span><span>function entityquery_node_info() {
</span></span><span>    <span>return array(
</span></span><span>        <span>'product' => array(
</span></span><span>            <span>'name' => t('Product'),
</span></span><span>            <span>'base' => 'product',
</span></span><span>            <span>'description' => t('You can define new Products here'),
</span></span><span>            <span>'has_title' => TRUE,
</span></span><span>            <span>'title_label' => t('Product title')
</span></span><span>         <span>),
</span></span><span>        <span>'movies' => array(
</span></span><span>            <span>'name' => t('Movies'),
</span></span><span>            <span>'base' => 'movies',
</span></span><span>            <span>'description' => t('You can define new Movies here'),
</span></span><span>            <span>'has_title' => TRUE,
</span></span><span>            <span>'title_label' => t('Movie title')
</span></span><span>         <span>),
</span></span><span>        <span>'books' => array(
</span></span><span>            <span>'name' => t('Books'),
</span></span><span>            <span>'base' => 'Books',
</span></span><span>            <span>'description' => t('You can define new Books here'),
</span></span><span>            <span>'has_title' => TRUE,
</span></span><span>            <span>'title_label' => t('Books title')
</span></span><span>         <span>)
</span></span><span>    <span>);
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_form()
</span></span><span><span> */
</span></span><span><span>function product_form($node, $form_state) {
</span></span><span>    <span>return node_content_form($node, $form_state);
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_form()
</span></span><span><span> */
</span></span><span><span>function movies_form($node, $form_state) {
</span></span><span>    <span>return node_content_form($node, $form_state);
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_form()
</span></span><span><span> */
</span></span><span><span>function books_form($node, $form_state) {
</span></span><span>    <span>return node_content_form($node, $form_state);
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_block_info().
</span></span><span><span> */
</span></span><span><span>function entityquery_block_info() {
</span></span><span>  <span>$blocks = array();
</span></span><span>
</span><span>  <span>$blocks['entityqueryblock'] = array(
</span></span><span>    <span>'info' => t('A block to display results from entityquery'),
</span></span><span>  <span>);
</span></span><span>
</span><span>  <span>return $blocks;
</span></span><span><span>}
</span></span><span>
</span><span><span>/**
</span></span><span><span> * Implement hook_block_view().
</span></span><span><span> */
</span></span><span><span>function entityquery_block_view($block_name = '') {
</span></span><span>  <span>if ($block_name == 'entityqueryblock') {
</span></span><span>    <span>$content ='';
</span></span><span>    <span>$block = array(
</span></span><span>      <span>'subject' => t('A block to display results from entityquery'),
</span></span><span>      <span>'content' => $content,
</span></span><span>    <span>);
</span></span><span>    <span>return $block;
</span></span><span>  <span>}
</span></span><span><span>}</span></span>

登入後複製