我正在为我们的产品编写一个集成模块,以进入任何Joomla 1.6页面。我需要一些帮助获得自定义数据(从API)进入基本设置部分,但似乎无法找到一种方法来获得它。
如果您查看创建模块的文档,您可以将模块的设置设置为XML格式。这使得您必须硬编码任何值或选择,而不需要任何动态选项。基本上,我想做的是设置一个非常基本的模块,它有三个基本属性:URL(用于定义API的路径)API密钥(API密钥)列表选择(连接到API并从您的帐户获取列表名称)
列表选择将为每个用户的API密钥自然更改,但由于您使用XML文件设置模块,我认为没有办法围绕列表选择选项的硬编码。
请告诉我你是否可以在Joomla 1.6模块中构建一个带有选项的动态<select>
。
注意:我说1.6是因为在Joomla中1.5和1.6的开发有很大的不同。
好了,经过一番挣扎,没有任何帮助,我终于可以说,我已经做到了。以下是未来谷歌用户的流程:
要构建一个动态下拉菜单,你必须做一些正确的事情,使它最终被Joomla拉到一起。
还记得仔细阅读文档,这个答案的方法不包含在里面,但也许有人会醒来,把它放在那里。
因此,在检查了1.6架构如何使用XML构建文件将模块变量放在一起之后,我们开始。
XML看起来像这样:
<?xml version="1.0" encoding="UTF-8"?>
<extension type="module" version="1.6.0" client="site">
<name>...</name>
<author>...</author>
<creationDate>April 2011</creationDate>
<copyright>Copyright (C) 2011 ... All rights reserved.</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<authorEmail>...</authorEmail>
<authorUrl>...</authorUrl>
<version>1.6.0</version>
<description>
...
</description>
<files>
<filename module="mod_your_mod">mod_your_mod.php</filename>
<filename>helper.php</filename>
<filename>index.html</filename>
<folder>tmpl</folder>
<folder>elements</folder>
<folder>lib</folder>
</files>
<languages />
<help />
<config>
<fields name="params">
<fieldset name="basic">
<!-- Custom field, list selection from API -->
<!-- Path to module external parameters -->
<field addfieldpath="/modules/mod_your_mod/elements"
name="mod_your_mod_id_selection" <!-- Name of variable -->
type="lists" <!-- New variable type -->
default=""
label="Select lists"
description="This is the list selection, where you select the list a contact can subscribe to." />
</fieldset>
<fieldset
name="advanced">
<field
name="layout"
type="modulelayout"
label="JFIELD_ALT_LAYOUT_LABEL"
description="JFIELD_ALT_MODULE_LAYOUT_DESC" />
<field
name="moduleclass_sfx"
type="text"
label="COM_MODULES_FIELD_MODULECLASS_SFX_LABEL"
description="COM_MODULES_FIELD_MODULECLASS_SFX_DESC" />
<field
name="cache"
type="list"
default="1"
label="COM_MODULES_FIELD_CACHING_LABEL"
description="COM_MODULES_FIELD_CACHING_DESC">
<option
value="1">JGLOBAL_USE_GLOBAL</option>
<option
value="0">COM_MODULES_FIELD_VALUE_NOCACHING</option>
</field>
<field
name="cache_time"
type="text"
default="900"
label="COM_MODULES_FIELD_CACHE_TIME_LABEL"
description="COM_MODULES_FIELD_CACHE_TIME_DESC" />
<field
name="cachemode"
type="hidden"
default="itemid">
<option value="itemid"></option>
</field>
</fieldset>
</fields>
</config>
</extension>
因此,在遵循Joomla实现模块的方式之后,我将新的参数变量类型添加到elements
文件夹中作为lists.php
,看到名称与您在XML文件中声明的类型相同。
这个文件里面的类看起来像这样:
<?php
// No direct access
defined('_JEXEC') or die('Direct Access to this location is not allowed.');
jimport('joomla.html.html');
//import the necessary class definition for formfield
jimport('joomla.form.formfield');
// Include API utility file
require_once(dirname(__FILE__) . '/../lib/your_api.php');
class JFormFieldLists extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.6
*/
protected $type = 'lists'; //the form field type see the name is the same
/**
* Method to retrieve the lists that resides in your application using the API.
*
* @return array The field option objects.
* @since 1.6
*/
protected function getInput()
{
$options = array();
$attr = '';
$attr .= ' multiple="multiple"';
$attr .= ' style="width:220px;height:220px;"';
// Get the database instance
$db = JFactory::getDbo();
// Build the select query
$query = 'SELECT params FROM jos_modules'
. ' WHERE module="mod_your_mod"';
$db->setQuery($query);
$params = $db->loadObjectList();
// Decode the options to get thje api key and url
$options = json_decode($params[0]->params, true);
// Gracefully catch empty fields
if ( empty($options['api_key']) === true )
{
$tmp = JHtml::_(
'select.option',
0,
'No lists available, please add an API key'
);
$lists[] = $tmp;
// The dropdown output, return empty list if no API key specified
return JHTML::_(
'select.genericlist',
$lists,
$this->name,
trim($attr),
'value',
'text',
$this->value,
$this->id
);
}
if ( empty($options['url']) === true )
{
$tmp = JHtml::_(
'select.option',
0,
'No lists available, please add the enterprise URL'
);
$lists[] = $tmp;
// The dropdown output, return empty list if no API key specified
return JHTML::_(
'select.genericlist',
$lists,
$this->name,
trim($attr),
'value',
'text',
$this->value,
$this->id
);
}
// Create a new API utility class
$api = new APIClass(
$options['url'],
$options['api_key']
);
try
{
// Get the lists needed for subscription
$response = $api->getLists();
}
catch ( Exception $e )
{
$tmp = JHtml::_(
'select.option',
0,
'Could not connect to the API'
);
$lists[] = $tmp;
// The dropdown output, return empty list if no API key specified
return JHTML::_(
'select.genericlist',
$lists,
$this->name,
trim($attr),
'value',
'text',
$this->value,
$this->id
);
}
$lists = array();
// Builds the options for the dropdown
foreach ( $response['data'] as $list )
{
// Build options object here
$tmp = JHtml::_(
'select.option',
$list['list_id'],
$list['list_name']
);
$lists[] = $tmp;
}
// The dropdown output
/* The name of the select box MUST be the same as in the XML file otherwise
* saving your selection using Joomla will NOT work. Also if you want to make it
* multiple selects don't forget the [].
*/
return JHTML::_(
'select.genericlist',
$lists,
'jform[params][mod_your_mod_id_selection][]',
trim($attr),
'value',
'text',
$this->value,
$this->id
);
}
}
?>
所以你会知道什么时候一切都在工作,因为你选择的下拉列表,由API构建(因此完全动态),将保存到模块数据库条目与选择框的名称,你可以很容易地通过调用:
检索:$api_key = $params->get('api_key', '');
在你的模块文件中。在这种情况下,它被称为mod_your_mod.php
。
我真的希望这对您在Joomla 1.6模块的后端定义自定义参数有所帮助。这允许极端的自定义,并与您喜欢使用的任何应用程序的API紧密集成。
唯一的缺点是它可能很慢,但是使用一堆检查,当API关闭或不能正确地提取数据时,它会优雅地失败。总而言之,这是一个非常不愉快的CMS,但这只是我的意见。
如果您的需求是基本的,还有一个更简单的解决方案:http://docs.joomla.org/SQL_form_field_type
有一个"sql"表单字段类型:
<field name="title" type="sql" default="10" label="Select an article" query="SELECT id AS value, title FROM #__content" />
(我同情你的沮丧-文档是可怕的,分散的,很难找到)