Verständnis von Drupals EntityfieldQuery

Key Takeaways

• EntityFieldQuery ist eine Klasse in Drupal, mit der Entwickler Informationen über Entitäten aus der Datenbank abrufen können, ohne SQL -Abfragen schreiben zu müssen, um Daten zu ärgern, zu filtern und zu sortieren. Dies ist besonders nützlich, wenn Daten aus mehreren Tabellen abgerufen werden müssen oder wenn sie komplexe Bedingungen auf Abfragen anwenden möchten.
• Die EntityFieldQuery -Klasse kann erweitert werden, um eine eigene Kinderklasse zu erstellen, sodass Sie die gleiche Abfrage an mehreren Stellen erstellen können. Zum Beispiel möchten Sie möglicherweise eine Abfrage erstellen, um alle aktiven Benutzer in der Aufstiegsordnung ihres Erstellungsdatums zu bringen. Dies kann erreicht werden, indem eine neue Klasse erstellt wird, die EntityFieldQuery erweitert und die entsprechenden Bedingungen und Reihenfolge festlegt.
• EntityFieldQuery unterstützt verschiedene Methoden wie "EntityCondition" zum Abnehmen von Daten von einem bestimmten Entitätstyp, "PropertyCondition" zum Hinzufügen von Bedingungen basierend auf den Eigenschaften des Entität, "FieldCondition" zum Abholen von Daten aus benutzerdefinierten Feldern und "PropertyArdBy" für Sortieren der Ergebnisse. Es unterstützt jedoch nur das Abrufen von Daten von einem Entitätstyp gleichzeitig. Wenn Sie Daten von mehreren Entitätstypen abrufen müssen, müssen Sie für jeden Typ separate Abfragen ausführen.

Einführung

Beim Erstellen komplexer Web -Apps müssen Sie schließlich mit einer Datenbank interagieren. Um Daten in Drupal abzurufen, kann man die bereitgestellte Datenbankabstraktionsschicht verwenden, für die einige SQL -Wissen ordnungsgemäß verwendet werden müssen. Von Drupal 7 entityfieldQuery -API wird zur Verfügung gestellt, mit der Sie Informationen über Entitäten aus Drupal abrufen können, ohne tatsächlich SQL -Abfragen zu erstellen. Lassen Sie uns in diesem Artikel sehen, wie wir mit der EntityFieldQuery -API Daten von Drupal abrufen und in unseren Modulen verwenden können.

Die EntityFieldQuery -Klasse

Die EntityFieldQuery -Klasse wird verwendet, um Entitäten in Drupal zu finden, die einigen Bedingungen entsprechen. Die EntityFieldQuery befindet sich in der Include/Entity.inc -Datei in Ihrer Drupal -Installation.
Diese Klasse verfügt über unterschiedliche Methoden, um den Entitätstyp und bestimmte Bedingungen anzugeben, basierend darauf, auf denen wir die Daten filtern können, die wir abrufen möchten. Wir werden diese Methoden in diesem Artikel ausführlich sehen.
Die grundlegende Nutzung, die Sie bei der Verwendung von EntityFieldQuery befolgen werden, wird in erster Linie ein Objekt dieser Klasse erstellen. Sobald das Objekt erstellt wurde

Die allgemeine Vorlage lautet wie folgt

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

Wir werden jetzt ein Drupal -Modul erstellen, mit dem 3 neue Drupal -Knoten -Typen installiert werden: Produkt, Filme und Bücher und einen Block, in dem wir unsere Ergebnisse anzeigen. Sie können sehen, wie Sie in diesem Artikel einen Knotentyp erstellen

Der Code für das Modul ist

entityQuery.info

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.install

<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></span>

entityQuery.module

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

Legen Sie dieses Modul in Ihren Modulordner ein. Wenn alles gut gelaufen ist, können Sie das EntityQuery -Modul in Ihrer Modulliste wie unten gezeigt sehen.

Sobald Sie das Modul installiert haben

Ausführen einer einfachen Abfrage mit EntityFieldQuery

Sobald wir das grundlegende Modul für die Verwendung von EntityFieldQuery einrichten haben, schreiben wir einige Abfragen, um Daten von Drupal abzurufen. Die erste Abfrage, die wir schreiben werden, besteht darin, alle Knoten mit EntityFieldQuery zu erhalten. Dann werden wir das verwenden, um die Titel der Knoten in unserem Block anzuzeigen.

Wie bereits erwähnt, ist das erste, was Sie tun sollten, eine Instanz von EFQ zu erstellen. Um eine Art von Entität zu holen, müssen Sie die Bedingung entity_type hinzuzufügen. In diesem Fall möchten wir Knoten holen, damit der Code dafür wie folgt lautet:

Die Entitätsbedingung wird unter Verwendung der Funktion EntityCondition festgelegt, in der wir den Entitätstyp als Knoten festlegen. Sobald wir die Entitätsbedingung festgelegt haben, sind wir bereit, die Abfrage auszuführen. Die Knoten -IDs werden in einem Array in der Knotentaste des Ergebnisses zurückgegeben. Der vollständige Code zum Anzeigen der Knoten lautet wie folgt:

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>

Wenn Sie jetzt Ihren Block sehen, sollten Sie in der Lage sein, alle Knoten darin zu sehen, wie folgt

<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></span>

Sie sollten jetzt versuchen, verschiedene Knoten wie Filme und Bücher hinzuzufügen und zu überprüfen, ob sie im Block angezeigt werden. Im obigen Code, sobald wir die Knoten -IDs von entityFieldQuery haben, laden wir die Knoten mit node_load_multiple und zeigen sie an.

Entitätsbedingungen zu EntityFieldQuery

Hinzufügen

Sie können Entitätsbedingungen hinzufügen, um nur bestimmte Arten von Knoten anzuzeigen. Wenn wir nur „Produkte“ aus der Art von Knoten anzeigen möchten, ist die Abfrage, die wir verwenden,:

Wenn wir jetzt unseren Block überprüfen, werden nur Produkte angezeigt:

<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></span>

Wir können sogar ein Array von Knotentypen angeben, um mehrere Arten von Knoten mithilfe von EntityCondition abzurufen. So holen Sie alle Produkte und Filme aus Ihrer Datenbank ab:

Hinzufügen von Eigentumsbedingungen zu EntityFieldQuery

<span>$query = new EntityFieldQuery();
</span><span>$query->entityCondition('entity_type', 'node');</span>

Wir können der Abfrage sogar Eigenschaftsbedingungen hinzufügen. Diese würden von dem Entitätstyp abhängen, nach dem Sie abfragen. In den meisten Fällen befindet sich die Eigenschaftsbedingung auf den Feldern des Entitätstyps, nach dem Sie abfragen. Sie können beispielsweise nach Knoten, die veröffentlicht werden, abfragen oder von einem bestimmten Benutzer geschrieben werden usw.

Die Abfrage, um nur veröffentlichte Knoten mit PropertyCondition zu zeigen, lautet wie folgt

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

Feldbedingungen zu EntityFieldQuery und Bestellung

hinzufügen

Die Feldbedingungen sind spezifisch für die in der Entität vorhandenen Felder. Nehmen wir also an, wir möchten alle Produkte finden, die den Wort Rabatt in ihrem Körper haben - wir können dies mit dem Feldzustand tun. Wir können die Ergebnisse sogar mit der Funktion PropertyOrderBy bestellen.

Wenn wir die Produkte und Filme wollen, die in ihrem Körper „Rabatt“ haben, die in absteigender Reihenfolge ihrer Erstellung angeordnet sind, wird die Abfrage wie folgt sein:

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>

Die Ausgabe dieser Abfrage ist wie folgt

Erweiterung der EntityFieldQuery -Klasse

Manchmal müssen Sie möglicherweise an vielen Stellen die gleiche Frage erstellen. Ein guter Weg zum Zusammenfassung wäre die Erweiterung der EntityFieldQuery -Klasse und die Erstellung Ihrer eigenen Kinderklasse.

Angenommen, Sie möchten eine Abfrage erstellen, um alle aktiven Benutzer in der Aufstiegsreihenfolge ihres Erstellungsdatums zu bringen:

<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></span>

Jetzt können Sie diese Abfrage überall wie SO verwenden:

<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></span>

Schlussfolgerung

Viele Module in Drupal benötigen Sie, um Entitätsinhalte aus der Datenbank abzurufen. Man kann die Drupal -Datenbankschicht direkt verwenden, aber dafür müssen Sie zumindest ein Kenntnis von SQL haben und es könnte anfälliger für Fehler sein. Die EntityFieldQuery -Klasse ist Teil des Kerns von Drupal und Sie können sie problemlos ohne Abhängigkeit von anderen Modulen verwenden. Viel Spaß beim Erstellen Ihres nächsten Drupal -Moduls!

häufig gestellte Fragen (FAQs) zu Drupals entityfieldQuery

Was ist der Hauptzweck von EntityFieldQuery in Drupal? Es bietet eine einfache und effiziente Möglichkeit, komplexe Abfragen zu behandeln und die Daten einfacher abzurufen, zu filtern und zu sortieren. Es ist besonders nützlich, wenn Sie Daten aus mehreren Tabellen abrufen müssen oder wenn Sie komplexe Bedingungen auf Ihre Abfragen anwenden möchten. Um Daten von einem bestimmten Entitätstyp abzurufen, können Sie die Methode „EntityCondition“ der EntityFieldQuery -Klasse verwenden. Diese Methode akzeptiert zwei Parameter: den Zustandstyp (der für diesen Fall „entity_type“ und der Entitätstyp, aus dem Sie Daten abrufen möchten, sein. Hier ist ein Beispiel:

$ query = new EntityFieldQuery ();

$ query-> entityCondition ('entity_type', 'node');

$ result = $ query-> execute ();

Kann ich EntityFieldQuery verwenden, um Daten aus mehreren Entitätstypen gleichzeitig zu holen? Unterstützt das Abrufen von Daten von einem Entitätstyp gleichzeitig. Wenn Sie Daten von mehreren Entitätstypen abrufen müssen, müssen Sie für jeden Typ separate Abfragen ausführen.

Wie kann ich die Ergebnisse einer EntityFieldQuery sortieren? Diese Methode akzeptiert drei Parameter: den Feldnamen, die Spalte nach Sortieren und die Sortierrichtung (entweder „ASC“ für aufsteigend oder zum Abstieg). Hier ist ein Beispiel:

$ query = new EntityFieldQuery ();
$ query-> entityCondition ('entity_type', 'node')
-> fieldOrderBy ('field_name', 'value', 'Desc');
$ result = $ query-> execute ();

Kann ich entityfieldQuery verwenden, um Daten abzurufen? Aus benutzerdefinierten Feldern? Diese Methode akzeptiert drei Parameter: den Feldname, die Spalte zum Filtern und den Wert, mit dem zu filtern. Hier ist ein Beispiel:

$ query = new EntityFieldQuery ();

$ query-> entityCondition ('entity_type', 'node')

-> fieldCondition ('field_custom', 'Wert',, 'benutzerdefinierter Wert');
$ result = $ query-> execute ();

Wie kann ich die Anzahl der Ergebnisse begrenzen Zurückgegeben von einem EntityFieldQuery? Diese Methode akzeptiert zwei Parameter: den Offset (die Anzahl der zu übersprungenen Ergebnisse) und die Grenze (die maximale Anzahl der zu zurückgegebenen Ergebnisse). Hier ist ein Beispiel:

$ query = new EntityFieldQuery ();

$ query-> entityCondition ('entity_type', 'node')

-> Bereich (0, 10);

$ result = $ query-> execute ();

Kann ich EntityFieldQuery verwenden, um Daten von Entitäten zu holen, die einen bestimmten Status haben?

Ja, Sie können die Methode "EntityCondition" mit dem Zustandstyp "Status" verwenden, um Daten von Entitäten zu holen, die einen bestimmten Status haben. Hier ist ein Beispiel:

$ query = new EntityFieldQuery ();

$ query-> EntityCondition ('entity_type', 'node')

-> EntityCondition ('Status', 1);

$ result = $ query-> execute ();

Wie kann ich Daten von Entitäten holen, die ein bestimmtes Bundle verwenden EntityFieldQuery? Hier ist ein Beispiel:

$ query = new EntityFieldQuery ();
$ query-> entityCondition ('entity_type', 'node')
-> EntityCondition ('Bündel', 'Artikel') . wurden zu einem bestimmten Zeitpunkt erstellt oder aktualisiert? Diese Methode akzeptiert drei Parameter: den Eigenschaftsnamen, den Wert zum Filtern und den für den Vergleich verwendeten Bediener. Hier ist ein Beispiel:

$ query = new EntityFieldQuery ();

$ query-> entityCondition ('entity_type', 'node')

-> PropertyCondition ('erstellt', Strtotime ('- 1 Tag '),'> = ');
$ result = $ query-> execute ();

Wie kann ich Daten von Entitäten abrufen, die in einem Multi-Wert-Feld mithilfe von EntityFieldQuery einen bestimmten Wert haben? einen bestimmten Wert in einem Multi-Wert-Feld haben. Hier ist ein Beispiel:

$ query = new EntityFieldQuery ();
$ query-> entityCondition ('entity_type', 'node')
-> fieldCondition ('field_multi_value', 'value', 'Spezifischer Wert', '=', 1);
$ result = $ query-> execute ();

Das obige ist der detaillierte Inhalt vonVerständnis von Drupals EntityfieldQuery. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!