«

在 Joomla 中连接第三方 PHP 库

时间:2025-1-9 17:00     作者:emer     分类:


巧用joomla扩展轻松集成第三方php库

Joomla自身并不直接支持Composer,但我们可以通过将其“封装”进Joomla扩展库来方便地使用第三方PHP库。这种方法尤其适用于大型项目,确保代码经过充分测试,并在生产环境中稳定运行。

创建扩展包后,即可在任何需要的地方安装它。 当库有新版本发布时,更新封装后的扩展即可,享受Joomla扩展的标准更新机制,包括通过CLI进行更新。更新前,务必在管理后台查看扩展的变更日志。

Joomla、PSR和Symfony的兼容性

立即学习“”;

Joomla遵循PSR标准,因此使用起来非常方便。Joomla核心包含一些Symfony组件(Console, String, VarDumper, YAML, ErrorHandler等),这意味着添加更多Symfony组件将会非常容易集成。 除了这些组件,Joomla自身也提供许多有价值的功能。

如何在Joomla扩展中封装第三方PHP库?

方法很简单。通常,库文件位于src文件夹中。在该文件夹旁边,根据Joomla文档(manual.joomla.org)创建Joomla扩展的XML清单文件。最后,将所有内容打包成zip压缩文件即可安装。

如果库需要数据库表,则需在安装或更新过程中使用SQL查询添加必要的表结构。由于Joomla 4使用命名空间,在扩展的XML清单中指定命名空间至关重要。以下是一个简化的Joomla库XML清单示例:

<?xml version="1.0" encoding="utf-8"?>
<extension method="upgrade" type="library">
  <name>webtolk amocrm library</name>
  <libraryname>webtolk/amocrm</libraryname>
  <version>1.2.1</version>
  ...
  <namespace path="src">webtolkmocrm</namespace>
  <files>
    <folder>src</folder>
    <filename>amocrm.xml</filename>
  </files>
</extension>
登录后复制

标签指定src文件夹将被复制到jpath_site/libraries/webtolk/amocrm。 部分指定需要从压缩包中提取的文件。 webtolkmocrm 指定为jpath_site/libraries/webtolk/amocrm下的src文件夹注册命名空间webtolkmocrm。

重要注意事项:

以下代码片段展示了如何在安装/更新过程中处理数据库参数:

<?php
use JoomlaCMSHelperLibraryHelper;
use JoomlaCMSCacheCache;

/**
 * 在扩展安装/更新/卸载过程开始前调用的函数。
 *
 * @param   string            $type     更改类型 (install, discover_install, update, uninstall)
 * @param   InstallerAdapter  $adapter  调用此方法的适配器
 *
 * @return  boolean  成功返回true
 *
 * @since   1.0.0
 */
public function preflight(string $type, InstallerAdapter $adapter): bool
{
    if ($type == 'uninstall') {
        return true;
    }

    /**
     * Joomla更新库类型扩展时,会删除扩展(以及数据库中的数据),然后重新安装。
     * 为避免丢失数据库中的库数据,我们编写了这段代码。
     *
     * @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);将保存的参数恢复。

<?php
use JoomlaCMSPluginPluginHelper;
use JoomlaRegistryRegistry;

if (PluginHelper::isEnabled('system', 'wt_amocrm')) {
    $plugin = PluginHelper::getPlugin('system', 'wt_amocrm');
    $params = json_decode($plugin->params);
    $param = $params->param;
    // 或者使用 JoomlaRegistryRegistry
    $params = new Registry($plugin->params);
    $param = $params->get('param', '默认值');
}
登录后复制

Joomla社区资源:

希望以上信息对您有所帮助。

以上就是在 Joomla 中连接第三方 PHP 库的详细内容,