在 Joomla 中連接第三方 PHP 函式庫

PHP 庫很方便，因為可以從應用程式中的任何位置存取它們：從插件、元件模型、模組等。如果有人已經解決了類似的問題並將其設計為庫（甚至更新了它），將這個庫連接到您的 Joomla 是有意義的。例如，要為線上商店開發支付方式，您需要支付聚合器的官方庫。或者您對某些CRM官方的PHP SDK是否滿意。

作曲家

Joomla 不支援直接使用 Composer。為了在工作中使用該庫，您需要將其「包裝」在 Joomla 擴充類型庫中並安裝它。在嚴肅的專案中，採用修復專案所有元件版本的方法：程式碼經過多次檢查、測試並允許在生產中工作。

您使用您的庫建立一個包，將其安裝在您需要的任何地方。隨著庫的新版本發布，您可以更新包裝器並獲得使用 Joomla 擴展的所有優勢：以標準方式更新擴展，包括透過 CLI。在更新等之前，請在管理區域中查看擴充功能的變更日誌

更新至 Joomla 5 之前，請在管理區域中查看變更日誌擴充功能。

Joomla、PSR、Symfony

Joomla 符合 PSR 標準，因此在這方面使用它很方便。 Joomla 核心中包含一些 Symfony 軟體包（控制台、字串、vardumper、yaml、錯誤處理程序等），因此如果您突然想要添加更多軟體包，它們將適合併運行良好。除了庫/供應商中的 Symfony 元件之外，您還可以看到 Joomla 中還有哪些有價值的內容。

如何在 Joomla 擴充中包裝第 3 方 PHP 函式庫？

沒什麼複雜的。庫檔案通常位於 src 資料夾中。在此資料夾旁邊，您需要根據文件 (manual.joomla.org) 建立 Joomla 擴充功能的 XML 清單。然後我們將所有內容打包到 zip 檔案中，就是這樣！可以安裝了。

如果您需要在資料庫中擁有自己的表才能使程式庫正常運作，則需要在安裝或更新過程中使用 SQL 查詢新增必要的檔案。由於 Joomla 4 使用命名空間，因此在擴充功能的 XML 清單中指定此命名空間非常重要。以下是 Joomla 庫的 XML 清單的縮寫範例。

<?xml version="1.0" encoding="UTF-8" ?>
<extension type="library" method="upgrade">
     <name>WebTolk AmoCRM library</name>
     <libraryname>Webtolk/Amocrm</libraryname>
     <version>1.2.1</version>
     ...
     <namespace path="src">Webtolk\Amocrm</namespace>
     <files>
          <folder>src</folder>
          <filename>amocrm.xml</filename>
     </files>
</extension>

;標籤表示我們存檔中的 src 資料夾將複製到 JPATH_SITE/libraries/Webtolk/Amocrm。在中部分，我們指出需要從檔案中填寫的內容。和 WebtolkAmocrm表示必須為 JPATH_SITE/libraries/Webtolk/Amocrm 中的 src 資料夾註冊命名空間 WebtolkAmocrm。

重要注意事項！

• 在 Joomla 4.2.7 之前，事實上，標籤 是來自 XML 清單的方法不起作用。 因此，有必要在庫包中新增一個系統插件，該插件將使用 JLoader 類別在 onAfterInitialize 事件（事件調度程式）上註冊命名空間。因此，有必要從庫和插件建立一個包。 從 Joomla 4.2.7 開始，它已被修復，您可以不使用該插件。
• 到目前為止，更新庫=重新安裝。 即刪除並安裝擴充功能。這個決定是在 Joomla 3.x 版本的深處做出的。為什麼？ - 隱藏在公關山脈之下。我們需要尋找。為什麼這很重要？因為安裝任何擴充功能時，都會在擴充功能的「登錄」中建立一個項目 - 在 #__extensions 表的資料庫中。該表有 2 列 TEXT 類型 - params 和 custom_data。你必須承認，這是一個相當大的數據量。如果您使用 JoomlaCMSHelperLibraryHelper 將一些庫參數儲存在資料庫中，那麼您需要考慮安裝程式的這種行為並預先儲存，然後在更新庫時將保存的參數新增回擴充的安裝程式腳本中。

<?php
use Joomla\CMS\Helper\LibraryHelper;
use Joomla\CMS\Cache\Cache;

/**
 * Function called before extension installation/update/removal procedure commences.
 *
 * @param   string            $type     The type of change (install or discover_install, update, uninstall)
 * @param   InstallerAdapter  $adapter  The adapter calling this method
 *
 * @return  boolean  True on success
 *
 * @since   1.0.0
 */
public function preflight(string $type, InstallerAdapter $adapter): bool
{
    if ($type == 'uninstall')
    {
        return true;
    }

    /**
     *
     *  Joomla when updating extensions of the library type, it actually deletes them (along with the data in the database),
     *  and then installs it again.
     *  In order to avoid losing library data from the database, we are writing this crutch.
     *
     * @see https://github.com/joomla/joomla-cms/issues/39360
     *
     */

    if ($type == 'update')
    {
        $lib_params = LibraryHelper::getParams('Webtolk/Amocrm');
        $jconfig    = $this->app->getConfig();
        $options    = array(
            'defaultgroup' => 'wt_amo_crm_temp',
            'caching'      => true,
            'cachebase'    => $jconfig->get('cache_path'),
            'storage'      => $jconfig->get('cache_handler'),
        );
        $cache      = Cache::getInstance('', $options);
        $cache->store($lib_params, 'wt_amo_crm_temp');

    }

    return true;

}

相應地，在 postflight() 方法中，我們使用 LibraryHelper::saveParams('Webtolk/Amocrm', $lib_params); 將保存的參數放回原處。

• 要讓庫正常運作，必須在擴充功能管理器中啟用它（選單 - 系統 - 管理 - 擴充功能）。
• 通常，庫需要某些參數（API 金鑰、令牌等）才能運作，這些參數必須由 Joomla 管理區域的人員指定。 出於這些目的，編寫一個外掛程式很方便（擴充類型庫沒有自己的參數配置介面）。系統組或您自己的自訂組並不重要。在你的庫中，你可以像這樣快速取得插件參數：

<?php
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Registry\Registry;

if (PluginHelper::isEnabled('system', 'wt_amocrm'))
   {
      $plugin        = PluginHelper::getPlugin('system', 'wt_amocrm');
      $params        = \json_decode($plugin->params);
      $param = $params->param;
      // OR you can use Joomla\Registry\Registry
      $params = new Registry($plugin->params);
      $param = $params->get('param', 'defatul value if empty');
   }

Joomla 社群資源

• https://joomla.org/
• Mattermost 中的 Joomla 社群聊天
• WebTolk Joomla 擴充
• 這篇俄文文章

以上是在 Joomla 中連接第三方 PHP 函式庫的詳細內容。更多資訊請關注PHP中文網其他相關文章！