巧用joomla扩展轻松集成第三方php库
Joomla自身并不直接支持Composer,但我们可以通过将其“封装”进Joomla扩展库来方便地使用第三方PHP库。这种方法尤其适用于大型项目,确保代码经过充分测试,并在生产环境中稳定运行。
创建扩展包后,即可在任何需要的地方安装它。 当库有新版本发布时,更新封装后的扩展即可,享受Joomla扩展的标准更新机制,包括通过CLI进行更新。更新前,务必在管理后台查看扩展的变更日志。
Joomla、PSR和Symfony的兼容性
立即学习“PHP免费学习笔记(深入)”;
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>
重要注意事项:
-
Joomla 4.2.7之前的版本,XML清单中的
标签无效。 需要添加一个系统插件,在onafterinitialize事件中使用jloader类注册命名空间。因此,需要同时打包库和插件。从Joomla 4.2.7开始,此问题已修复,无需再使用插件。 - 目前,更新库等同于重新安装。 这意味着需要删除并重新安装扩展。这是Joomla 3.x版本遗留的问题。 这很重要,因为安装任何扩展都会在#__extensions表中创建一个条目。 如果库需要存储参数到数据库,则需要在安装和更新过程中都处理这些参数。
以下代码片段展示了如何在安装/更新过程中处理数据库参数:
<?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);将保存的参数恢复。
- 必须在扩展管理器中启用库(菜单 – 系统 – 管理 – 扩展)。
- 库通常需要参数(API密钥、令牌等),这些参数需要由Joomla管理后台人员指定。 为此,编写一个插件会比较方便(库扩展类型没有自己的参数配置界面)。可以使用系统组或自定义组。 可以在库中这样获取插件参数:
<?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社区资源:
- https://www.php.cn/link/4d2356339f13e4b3d5aec55ba88a6019
- Joomla社区Mattermost聊天室
- webtolk Joomla扩展
- (俄文文章链接)
希望以上信息对您有所帮助。
以上就是在 Joomla 中连接第三方 PHP 库的详细内容,更多请关注php中文网其它相关文章!