在上一篇文章中，我們熟悉了Joomla智慧搜尋元件的功能，討論了使用CRON進(jìn)行定時(shí)索引的參數(shù)和配置。讓我們開始為我們自己的插件創(chuàng)建程式碼。

資源清單

在開始技術(shù)部分之前，我將提到一些直接涉及主題的文章。以及一般涵蓋 Joomla 4 / Joomla 5 現(xiàn)代架構(gòu)的插件的創(chuàng)建和/或更新的文章。接下來，我將假設(shè)讀者已經(jīng)閱讀了它們並且通常了解如何製作工作插件對(duì)於 Joomla：

• 創(chuàng)建智慧搜尋外掛 - Joomla 官方文件。適用於 Joomla 3，但大部分規(guī)定仍適用於 Joomla 4 / Joomla 5
• 開發(fā)智慧搜尋外掛程式 2012 年 Joomla 社群雜誌的文章。
• Nicholas Dionysopoulos 所著的《Joomla Extensions Development》一書涵蓋了 Joomla 的開發(fā)！ Joomla 版本 4 和 5 下的擴(kuò)充。
• 新文件入口網(wǎng)站 manual.joomla.org 上的資料庫部分 - 適用於 Joomla 4 和 Joomla 5。 ## 技術(shù)部分。 Joomla 5智慧搜尋外掛的開發(fā) 智慧搜尋元件與資料提供者外掛程式一起使用，其主要任務(wù)保持不變 - 選擇資料並將其提供給元件進(jìn)行索引。但隨著時(shí)間的推移，重新索引任務(wù)也落入了插件的職責(zé)範(fàn)圍。在本文中，我們假設(shè)我們從管理面板手動(dòng)執(zhí)行內(nèi)容索引。 CLI 的工作在視覺上有所不同，但其本質(zhì)保持不變。

對(duì)於有經(jīng)驗(yàn)的開發(fā)人員，我會(huì)說搜尋插件擴(kuò)展了 JoomlaComponentFinderAdministratorIndexerAdapter 類，該類文件位於 administrator/components/com_finder/src/Indexer/Adapter.php。好吧，然後他們會(huì)自己解決這個(gè)問題。此外，作為範(fàn)例，您可以在 plugins/finder 資料夾中研究 Joomla 核心智慧搜尋外掛程式 - 用於文章、類別、聯(lián)絡(luò)人、標(biāo)籤等。我為 JoomShopping（Joomla 電子商務(wù)組件）和 SW JProjects（您自己的帶有更新伺服器的 Joomla 擴(kuò)展目錄組件）組件開發(fā)了一個(gè)智能搜尋插件，因此類名稱和一些細(xì)微差別將與它們相關(guān)聯(lián)。我將使用 JoomShopping 的範(fàn)例來展示其中的大部分內(nèi)容。多語言問題的解決方案是基於 SW JProjects 的範(fàn)例。

智慧搜尋插件的文件結(jié)構(gòu)

Joomshopping 智慧搜尋插件的檔案結(jié)構(gòu)與典型的沒有什麼不同：

Joomla 5 智慧搜尋外掛程式檔案結(jié)構(gòu)

文件服務(wù)/provider.php

檔案provider.php允許您在Joomla DI容器中註冊(cè)插件，並允許您使用MVCFactory從外部存取插件方法。

插件類別文件

這是包含外掛程式主要工作程式碼的檔案。它應(yīng)該位於 src/Extension 資料夾中。就我而言，插件類別 JoomlaPluginFinderWtjoomshoppingfinderExtensionWtjoomshoppingfinder 位於檔案 plugins/finder/wtjoomshoppingfinder/src/Extension/Wtjoomshoppingfinder.php 中。該插件的命名空間是 JoomlaPluginFinderWtjoomshoppingfinderExtension。

操作需要最少的類別屬性和方法集（它們可以被訪問，包括由父 Adapter 類別訪問）。

類別的最低要求屬性

• $extension - 是元件的名稱，它定義內(nèi)容的類型。例如，com_content。就我而言，這是 com_jshopping。
• $context - 是插件的唯一標(biāo)識(shí)符，它設(shè)定索引的上下文，在該上下文中將存取插件。事實(shí)上，這是插件類別（元素）的名稱。在我們的例子中，Wtjoomshoppingfinder。
• $layout - 是搜尋結(jié)果元素的輸出佈局的名稱。顯示搜尋結(jié)果時(shí)使用此佈局。例如，如果$layout參數(shù)設(shè)定為article，那麼當(dāng)您需要顯示該類型的搜尋結(jié)果時(shí)，預(yù)設(shè)視圖模式將搜尋名為default_article.php的版面配置檔案。如果找不到這樣的文件，則將使用名為 default_result.php 的佈局文件。 HTML 佈局的輸出佈局位於 components/com_finder/tmpl/search 中。但是，我們應(yīng)該將佈局作為覆蓋放置在 html 模板資料夾中 - templates/YOUR_TEMPLATE/html/com_finder/search。在我的例子中，我將佈局命名為產(chǎn)品，檔案名稱為 default_product.php。
• $table - 是我們正在存取以獲取資料的資料庫中的表的名稱，例如#__content。就我而言，包含 JoomShopping 產(chǎn)品的主表稱為 #__jshopping_products。
• $state_field - 是資料庫表中負(fù)責(zé)索引元素是否發(fā)布的欄位名稱。預(yù)設(shè)情況下，此欄位稱為狀態(tài)。然而，在 JoomShopping 的情況下，該欄位稱為product_publish。

類別中最少需要的方法

• setup() ：bool - 是一種用於預(yù)先配置插件、連接庫等的方法。此方法在重新索引期間（reindex() 方法）在 onBeforeIndex 事件上呼叫。此方法必須傳回true，否則索引會(huì)中斷。
• index() : void - 是開始索引本身的方法。它從原始 SQL 查詢資料中收集所需結(jié)構(gòu)的對(duì)象，然後將其傳遞給 JoomlaComponentFinderAdministratorIndexerIndexer 類別進(jìn)行索引。此方法針對(duì)每個(gè)索引元素運(yùn)行。方法參數(shù)是 $item - 資料庫查詢的結(jié)果，在 JoomlaComponentFinderAdministratorIndexerResult 類別中格式化。
• getListQuery() ：JoomlaDatabaseDatabaseQuery - 是一種取得索引項(xiàng)目清單的方法...

…這裡我們開始深入研究細(xì)節(jié)，因?yàn)?getListQuery() 方法並不是真正強(qiáng)制性的，儘管文件和大多數(shù)文章都討論了它。

任何關(guān)於「複雜方案」主題的圖片都可以在這裡。

深入了解細(xì)節(jié)。索引元素的資料結(jié)構(gòu)。

令人驚訝的是，有時(shí)一些資訊或想法在我們注意到並意識(shí)到之前就已經(jīng)在我們身邊轉(zhuǎn)了一圈了！很多東西，在我們眼前一年多了，還沒有達(dá)到認(rèn)知，需要經(jīng)過多年的體驗(yàn)，我們的注意力才集中到它們上。

關(guān)於 Joomla，由於某種原因，它的元件並沒有立即呈現(xiàn)出 Joomla 的某種通用架構(gòu)特徵（儘管這是一個(gè)明顯的事實(shí)）。包括資料庫表結(jié)構(gòu)層面。讓我們來看看 Joomla 內(nèi)容表的一些欄位。我會(huì)保留的是，具體的列名對(duì)我們來說並不是那麼重要（你可以隨時(shí)查詢 SELECT name AS title），一個(gè)索引元素的資料結(jié)構(gòu)是多少：

• id - 自動(dòng)增量
• asset_id - #__assets 表中條目的 ID，其中儲(chǔ)存了網(wǎng)站每個(gè)元素的群組和使用者的存取權(quán)限：文章、產(chǎn)品、選單、模組、外掛程式和其他所有內(nèi)容。 Joomla 使用存取控制清單 (ACL) 模式。
• title - 元素標(biāo)題
• 語言 - 元素語言
• introtext - 介紹文字或元素的簡(jiǎn)短可見描述
• fulltext - 項(xiàng)目的全文、產(chǎn)品的完整描述等
• state - 負(fù)責(zé)發(fā)布狀態(tài)的邏輯標(biāo)誌：專案是否已發(fā)布。
• catid - 項(xiàng)目類別的 ID。 Joomla 不像其他 CMS 只有「網(wǎng)站頁面」。有些內(nèi)容實(shí)體（文章、聯(lián)絡(luò)人、產(chǎn)品等）必須屬於某些類別。
• 建立 - 專案的建立日期。
• access - 存取權(quán)限群組id（未授權(quán)網(wǎng)站使用者（訪客）、全部、註冊(cè)等）
• metakey - 元素的元關(guān)鍵字。是的，自 2009 年以來，Google 就不再使用它們。但在 Joomla 中，它們歷史上仍然存在，因?yàn)樵摍谖挥渺断嗨莆恼履＝M中，以使用指定關(guān)鍵字搜尋實(shí)際相似的文章。
• metadesc - 元素元描述
• publish_up 和publish_down - 元素開始發(fā)布和取消發(fā)布的日期。這更多的是一種選擇，但在許多組件中都可以找到它。

如果我們比較表格#__content（Joomla文章）、#__contact_details（聯(lián)絡(luò)人元件）、#__tags（Joomla標(biāo)籤）、#__categories（Joomla類別元件），那麼我們會(huì)發(fā)現(xiàn)幾乎所有列出的資料類型都無處不在。

如果建立智慧搜尋外掛的元件遵循「Joomla方式」並繼承其架構(gòu)，那麼您可以在外掛程式類別中使用最少的方法。如果開發(fā)人員決定不尋找簡(jiǎn)單的方法而走自己的路，那麼您將不得不走困難的路，重新定義 Adapter 類別的幾乎所有方法。

getListQuery() 方法

此方法在 3 種情況下被呼叫：

1. Adapter類別的getContentCount()方法是取得索引項(xiàng)目的數(shù)量（總共有多少篇文章，總共有多少個(gè)產(chǎn)品等）。 Joomla 智慧搜尋索引流程 您可以在偵錯(cuò)模式下看到索引項(xiàng)目的數(shù)量。
2. Adapter 類別的 getItem($id) 方法是透過 id 取得特定索引元素。 getItem() 方法又在重新索引期間在 reindex($id) 方法中呼叫。
3. Adapter 類別的 getItems($offset, $limit, $query = null) 方法是取得索引元素清單的方法。偏移量和限制是根據(jù)組件設(shè)定設(shè)定的 - “捆綁”中應(yīng)包含多少個(gè)索引元素。 Joomla 5 智慧搜尋設(shè)定索引器批次大小

讓我們來看看 Joomla 核心外掛程式的實(shí)作範(fàn)例：

getListQuery()方法傳回一個(gè)DatabaseQuery對(duì)象，該物件是查詢建構(gòu)函式的對(duì)象，其中已經(jīng)指定了資料表的名稱和所選的欄位。在呼叫它的方法中繼續(xù)使用它。

如果從 DatabaseQuery $query 物件中的 getContentCount() 呼叫 getListQuery()，則 select 的設(shè)定值將會(huì)被取代為 COUNT(*)。

如果從 getItem($id) 呼叫 getListQuery()，則條件 $query->where('a.id = ' . (int) $id) 並且只選擇特定元素。在這裡我們已經(jīng)看到父 Adapter 類別在查詢中包含作為 a.* 的表名稱。這意味著我們也應(yīng)該在 getListQuery() 方法的實(shí)作中使用這些前綴。

在從 getItems() 呼叫 getListQuery() 的情況下，$offset 和 $limit 將會(huì)加入我們建立的查詢中，以便在元素清單中移動(dòng)以進(jìn)行索引。
總結(jié)： getListQuery() - 必須包含三個(gè)不同 SQL 查詢的「工作片段」。 在這裡實(shí)作 Joomla 並沒有什麼特別困難的。但是，如果有必要，您可以自行實(shí)作 3 個(gè)方法，而無需建立 getListQuery()。

非 Joomla 方式： 就 JoomShopping 而言，我發(fā)現(xiàn)一個(gè)產(chǎn)品可以有多個(gè)類別，並且歷史上該產(chǎn)品的類別 id (catid) 組件存儲(chǔ)在單獨(dú)的表中。同時(shí)，多年來一直無法指定產(chǎn)品的主要類別。收到產(chǎn)品類別後，查詢將傳送至類別表，其中僅取得第一個(gè)查詢結(jié)果，按預(yù)設(shè)類別 ID 排序 - 即升序。如果我們?cè)诰庉嫯a(chǎn)品時(shí)更改類別，則主要產(chǎn)品類別是 ID 號(hào)碼較小的類別。產(chǎn)品的 URL 以此為基礎(chǔ)，產(chǎn)品可以從一個(gè)類別跳到另一個(gè)類別。

但是，大約 2 年前，這種 JoomShopping 行為已被修復(fù)。由於該組件歷史悠久，受眾眾多，並且不能僅僅破壞向後兼容性，修復(fù)是可選的。必須在組件設(shè)定中啟用指定產(chǎn)品主類別的功能。然後 main_category_id 將會(huì)填入有產(chǎn)品的表中。

但這個(gè)功能預(yù)設(shè)是關(guān)閉的。 而在智慧搜尋外掛程式中，我們需要取得JoomShopping組件的參數(shù)，看看是否啟用了指定主商品類別的選項(xiàng)（並且它最近可能啟用，並且未指定某些產(chǎn)品的主類別- 也是一個(gè)細(xì)微差別...）並產(chǎn)生SQL 查詢以根據(jù)組件參數(shù)接收產(chǎn)品：或者是一個(gè)簡(jiǎn)單的查詢，其中我們添加main_category_id字段，或以舊的錯(cuò)誤方式獲取類別id 的JOIN 請(qǐng)求。

在此要求中，多語言的細(xì)微差別立即凸顯出來。根據(jù) Joomla 方式，為網(wǎng)站的每種語言創(chuàng)建一個(gè)單獨(dú)的元素，並在它們之間建立關(guān)聯(lián)。因此，對(duì)於俄語 - 一篇文章。同一篇英文文章正在單獨(dú)創(chuàng)建。然後我們使用語言關(guān)聯(lián)將它們相互連接起來，當(dāng)在 Joomla 前端切換語言時(shí)，我們將從一篇文章重新導(dǎo)向到另一篇文章。

這不是 JoomShopping 中的做法：所有語言的資料都與產(chǎn)品儲(chǔ)存在同一個(gè)表格中（好的）。添加其他語言的資料是透過添加帶有這些語言後綴的列來完成的（嗯...）。也就是說，我們的資料庫中不僅僅有標(biāo)題或名稱欄位。但還有 name_ru-RU、name_en-GB 等欄位

Joomla JoomShopping 產(chǎn)品表結(jié)構(gòu)片段
同時(shí)，我們需要設(shè)計(jì)一個(gè)通用的 SQL 查詢，以便可以從管理面板和 CLI 對(duì)其進(jìn)行索引。同時(shí)，使用 CRON 啟動(dòng) CLI 時(shí)選擇索引語言也是一項(xiàng)任務(wù)。我承認(rèn)，在撰寫本文時(shí)，我暫時(shí)推遲了對(duì)該問題的全面解決方案。使用我們自己的 getLangTag() 方法選擇語言，我們可以從 JoomShopping 參數(shù)中取得主要語言，也可以使用網(wǎng)站的預(yù)設(shè)語言。也就是說，到目前為止，該解決方案僅適用於單語言網(wǎng)站。目前還無法進(jìn)行不同語言的搜尋。

但是，3個(gè)月後我解決了這個(gè)問題，但已經(jīng)在 SW JProjects 組件的智慧搜尋插件中了。我會(huì)進(jìn)一步告訴你解決方案。

同時(shí)，讓我們看看JoomShopping發(fā)生了什麼事

檢查點(diǎn)

我們創(chuàng)建了一種從 Joomla 查詢資料庫的方法，並了解了很多關(guān)於智慧搜尋外掛程式如何運(yùn)作的知識(shí)。

在下一篇文章中，我們將建立一個(gè)索引內(nèi)容的方法並完成插件的建立。我們也將熟悉索引項(xiàng)如何儲(chǔ)存在資料庫中，並理解為什麼這很重要，並透過多語言的非標(biāo)準(zhǔn)實(shí)作解決多語言元件的索引內(nèi)容問題。

Joomla 社群資源

• https://joomla.org/
• Joomla 社區(qū)雜誌中的這篇文章
• Mattermost 中的 Joomla 社群聊天（了解更多）

以上是Joomla 藝術(shù)中智慧搜尋的剖析 創(chuàng)建插件 I.的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！