Memahami EntityFieldQuery Drupal ' s

Takeaways Key

EntityFieldQuery adalah kelas di Drupal yang membolehkan pemaju mengambil maklumat mengenai entiti dari pangkalan data tanpa perlu menulis pertanyaan SQL, menjadikannya lebih mudah untuk mengambil, menapis, dan menyusun data. Ini amat berguna apabila perlu mengambil data dari pelbagai jadual atau ketika ingin menggunakan syarat -syarat yang kompleks untuk pertanyaan.
Kelas EntityFieldQuery boleh diperluaskan untuk membuat kelas anak anda sendiri, yang membolehkan anda membina pertanyaan yang sama di beberapa tempat. Sebagai contoh, anda mungkin mahu membina pertanyaan untuk mendapatkan semua pengguna aktif dalam urutan menaik pada tarikh penciptaan mereka. Ini dapat dicapai dengan mewujudkan kelas baru yang memanjangkan EntityFieldQuery dan menetapkan syarat dan perintah yang sesuai.
EntityFieldQuery menyokong pelbagai kaedah seperti `EntityCondition` untuk mengambil data dari jenis entiti tertentu,` PropertyCondition` untuk menambahkan syarat -syarat berdasarkan sifat -sifat entiti, `fieldcondition` untuk mengambil data dari medan tersuai, dan` propertyorderby `untuk menyusun hasilnya. Walau bagaimanapun, ia hanya menyokong mengambil data dari satu jenis entiti pada satu masa. Jika anda perlu mengambil data dari pelbagai jenis entiti, anda perlu menjalankan pertanyaan berasingan untuk setiap jenis.

Pengenalan

Apabila membina aplikasi web kompleks, akhirnya anda perlu berinteraksi dengan pangkalan data. Untuk mendapatkan data dalam Drupal, seseorang boleh menggunakan lapisan abstraksi pangkalan data yang disediakan, yang memerlukan pengetahuan SQL digunakan dengan betul. Dari Drupal 7 EntityFieldQuery API disediakan, yang membolehkan anda mengambil maklumat mengenai entiti dari Drupal tanpa benar -benar membina pertanyaan SQL. Dalam artikel ini, mari kita lihat bagaimana kita boleh menggunakan API EntityFieldQuery untuk mengambil data dari Drupal dan menggunakannya dalam modul kami.

Kelas EntityFieldQuery

Kelas EntityFieldQuery digunakan untuk mencari entiti di Drupal, yang sepadan dengan beberapa syarat. EntityFieldQuery hadir dalam fail termasuk/entiti.inc dalam pemasangan Drupal anda.

Kelas ini mempunyai kaedah yang berbeza untuk menentukan jenis entiti dan syarat -syarat tertentu berdasarkan yang kita boleh menapis data mana yang kita mahu ambil. Kami akan melihat kaedah tersebut secara terperinci sepanjang artikel ini.

Penggunaan asas, yang akan anda ikuti semasa menggunakan EntityFieldQuery akan, pertama dan paling utama, mewujudkan objek kelas ini. Sebaik sahaja objek dibuat, anda akan menambah beberapa syarat kepadanya dan kemudian panggil kaedah laksanakan untuk mengambil hasilnya.

Templat Umum adalah seperti berikut

Kami kini akan membuat modul Drupal yang akan memasang 3 jenis nod Drupal baru: produk, filem dan buku dan blok di mana kami akan memaparkan hasil kami. Anda dapat melihat cara membuat jenis nod dalam artikel ini

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

kod untuk modul adalah

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

EntityQuery.Module

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

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

Letakkan modul ini dalam folder Modul anda dan jika semuanya telah berjalan lancar, anda akan dapat melihat modul EntityQuery dalam senarai modul anda seperti yang ditunjukkan di bawah.

sebaik sahaja anda memasang modul, anda sepatutnya dapat melihat jenis nod baru juga di bahagian Kandungan Panel Admin Drupal anda seperti berikut

Melaksanakan pertanyaan mudah menggunakan EntityFieldQuery

Sebaik sahaja kita mempunyai modul asas yang disediakan untuk menggunakan EntityFieldQuery, mari kita mula menulis beberapa pertanyaan untuk mengambil data dari Drupal. Pertanyaan pertama yang akan kami tulis adalah untuk mendapatkan semua nod menggunakan EntityFieldQuery. Kemudian kami akan menggunakannya untuk memaparkan tajuk nod di blok kami.

seperti yang dinyatakan sebelum ini perkara pertama yang perlu dilakukan ialah membuat contoh EFQ. Untuk mengambil jenis entiti, anda perlu menambah keadaan entiti_type kepadanya. Dalam kes ini kita mahu mengambil nod supaya kod untuknya akan menjadi seperti berikut:

Keadaan entiti ditetapkan menggunakan Fungsi EntityCondition di mana kita menetapkan jenis entiti sebagai nod. Sebaik sahaja kami menetapkan keadaan entiti, kami bersedia untuk melaksanakan pertanyaan. ID nod dikembalikan dalam array dalam kunci nod hasilnya. Kod lengkap untuk memaparkan nod akan menjadi seperti berikut:

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>

Sekarang jika anda pergi dan melihat blok anda, anda harus dapat melihat semua nod di dalamnya seperti berikut

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

Anda kini harus cuba menambah nod yang berbeza seperti filem dan buku dan periksa mereka dipaparkan di blok. Di atas, kod apabila kita mempunyai ID nod dari EntityFieldQuery, kita memuatkan nod menggunakan node_load_multiple dan memaparkannya.

Menambah Keadaan Entiti ke EntityFieldQuery

Anda boleh menambah keadaan entiti untuk menunjukkan hanya jenis nod tertentu. Jika kita mahu memaparkan hanya "produk" dari jenis nod, pertanyaan yang akan kita gunakan ialah:

Sekarang jika kita menyemak blok kita, ia hanya akan memaparkan produk:

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

kita juga boleh menentukan pelbagai jenis nod untuk mengambil pelbagai jenis nod menggunakan entitycondition. Untuk mengambil semua produk dan filem dari pangkalan data anda:

Menambah keadaan harta kepada EntityFieldQuery

kita juga boleh menambah syarat harta kepada pertanyaan. Ini bergantung kepada jenis entiti yang anda tanya. Dalam kebanyakan kes, keadaan harta akan berada di medan jenis entiti yang anda tanya. Anda boleh, sebagai contoh, pertanyaan untuk nod yang diterbitkan, atau ditulis oleh pengguna tertentu dan lain -lain

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

pertanyaan untuk menunjukkan hanya nod yang diterbitkan menggunakan PropertyCondition adalah seperti berikut

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

Menambah keadaan medan ke EntityFieldQuery dan Pesanan

Keadaan medan adalah khusus untuk medan yang terdapat pada entiti. Oleh itu, kita ingin mencari semua produk yang mempunyai diskaun perkataan dalam badan mereka - kita boleh melakukannya menggunakan keadaan medan. Kami juga boleh memesan hasil menggunakan fungsi PropertyOrderBy.

Jika kita mahu produk dan filem yang mempunyai "diskaun" dalam badan mereka, diatur dalam urutan menurun penciptaan mereka, pertanyaan akan seperti berikut:

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>

output pertanyaan ini akan menjadi seperti berikut

Memperluas Kelas EntityFieldQuery

Kadang -kadang, anda mungkin perlu membina pertanyaan yang sama di banyak tempat. Cara yang baik untuk abstrak yang akan memperluaskan kelas EntityFieldQuery dan membuat kelas anak anda sendiri.

Katakan anda ingin membina pertanyaan untuk mendapatkan semua pengguna aktif dalam urutan menaik pada tarikh penciptaan mereka:

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

Sekarang anda boleh menggunakan pertanyaan ini di mana sahaja seperti:

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

Kesimpulan

Banyak modul di Drupal akan memerlukan anda untuk mengambil kandungan entiti dari pangkalan data. Seseorang boleh menggunakan lapisan pangkalan data Drupal secara langsung, tetapi untuk itu anda perlu mempunyai sekurang -kurangnya pengetahuan kerja SQL dan ia boleh menjadi lebih mudah untuk kesilapan. Kelas EntityFieldQuery adalah sebahagian daripada teras Drupal dan anda boleh menggunakannya tanpa kebergantungan pada modul lain. Bersenang -senang membuat modul Drupal seterusnya!

Soalan Lazim (Soalan Lazim) Mengenai EntityFieldQuery Drupal

Apakah tujuan utama EntityFieldQuery dalam Drupal? Ia menyediakan cara yang mudah dan cekap untuk mengendalikan pertanyaan yang kompleks, menjadikannya lebih mudah untuk mendapatkan, menapis, dan menyusun data. Ia amat berguna apabila anda perlu mengambil data dari pelbagai jadual atau apabila anda ingin menggunakan syarat -syarat yang kompleks untuk pertanyaan anda. Untuk mengambil data dari jenis entiti tertentu, anda boleh menggunakan kaedah 'EntityCondition' kelas EntityFieldQuery. Kaedah ini menerima dua parameter: jenis keadaan (yang sepatutnya 'entity_type' untuk kes ini) dan jenis entiti yang anda mahu mengambil data dari. Berikut adalah contoh:

$ query = entityFieldQuery baru ();

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

Bolehkah saya menggunakan EntityFieldQuery untuk mengambil data dari pelbagai jenis entiti sekaligus? mengambil data dari satu jenis entiti pada satu masa. Jika anda perlu mengambil data dari pelbagai jenis entiti, anda perlu menjalankan pertanyaan berasingan untuk setiap jenis.

Bagaimana saya boleh menyusun hasil entitifieldQuery? Kaedah ini menerima tiga parameter: nama medan, lajur untuk disusun oleh, dan arah jenis (sama ada 'ASC' untuk menaik atau 'desc' untuk turun). Berikut adalah contoh:

$ query = entityFieldQuery baru ();
$ query-> entityCondition ('entity_type', 'node')
-> fieldOrderBy ('field_name', 'nilai', 'Desc');
$ result = $ query-> Execute (); Ya, anda boleh menggunakan kaedah 'FieldCondition' untuk mengambil data dari medan tersuai. Kaedah ini menerima tiga parameter: nama medan, lajur untuk ditapis oleh, dan nilai untuk ditapis dengan. Berikut adalah contoh:

$ query = entityFieldQuery baru ();

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

-> fieldCondition ('field_custom', 'nilai', 'Nilai tersuai'); execute ();
Anda boleh menggunakan kaedah 'julat' untuk mengehadkan bilangan hasil yang dikembalikan oleh EntityFieldQuery. Kaedah ini menerima dua parameter: offset (bilangan keputusan untuk melangkau) dan had (bilangan maksimum hasil untuk kembali). Berikut adalah contoh:

$ query = entityFieldQuery baru ();
$ query-> entityCondition ('entity_type', 'node')
-> julat (0, 10); $ result = $ query-> Execute ();

Bolehkah saya menggunakan EntityFieldQuery untuk mengambil data dari entiti yang mempunyai status tertentu?

Ya, anda boleh menggunakan kaedah 'EntityCondition' dengan jenis keadaan 'status' untuk mengambil data dari entiti yang mempunyai status tertentu. Berikut adalah contoh:

$ query = entityFieldQuery baru ();
$ query-> entityCondition ('entity_type', 'node')
-> EntityCondition ('status', 1);
$ result = $ query-> Execute ();

Anda boleh menggunakan kaedah 'EntityCondition' dengan jenis keadaan 'bundle' untuk mengambil data dari entiti yang mempunyai bundle tertentu. Berikut adalah contoh:

$ query = entityFieldQuery baru ();
$ query-> entityCondition ('entity_type', 'node')
-> entityCondition ('bundle', 'artikel') ;
$ result = $ query-> Execute ();
$ query = entityFieldQuery baru ();

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

-> propertyCondition ('created', strtotime ('- 1 hari '),'> = ');

hasil = $ query-> Execute ();

bagaimana saya boleh mengambil data dari entiti yang mempunyai nilai tertentu dalam medan multi-nilai menggunakan EntityFieldQuery? mempunyai nilai khusus dalam medan pelbagai nilai. Berikut adalah contoh:

$ query = entityFieldQuery baru (); entityCondition ('entity_type', 'node')
-> fieldCondition ('field_multi_value', 'nilai', 'nilai spesifik', '=', 1);
hasil = $ query-> Execute ();

Atas ialah kandungan terperinci Memahami EntityFieldQuery Drupal ' s. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!