Joomla! Documentation™

Joomla! 

3.x

Tutorial

Creating a simple module

Articles in this Series

• Introduction
• Developing a Basic Module
• Using the Database
• Adding Form Fields
• Adding Auto Update
• Adding an install/uninstall/update script file

This is a multiple article series on how to create a module for Joomla! Version . You can navigate the articles in this series by using the navigation drop down menu.

Begin with the Introduction, and navigate the articles in this series by using the navigation button at the bottom or the box to the right (Articles in this series). There are 2 videos accompanying this tutorial which you can view at Basic Joomla Module Development video 1 and Basic Joomla Module Development video 2.

Form fields give a great deal of customisation in Joomla and for modules are the sole way of allowing the user to tweak the module to the needs of their site.

Adding Form Fields to the Module

In this case we are going to extend our previous example using the database to provide a list of languages for the user to select from. To allow this to happen we will use the SQL form field type. (The full details for this is on the SQL Form Field docs page).

First of all we are going to add a form field into our .xml file. Remember those config tags that we added in earlier? Now inside these tags we are going to add the following code:

<fields name="params">
    <fieldset name="basic">
        <field
               name="lang"
               type="sql"
               default="1"
               label="Select a language"
               query="SELECT id AS value, lang FROM #__helloworld" />
    </fieldset>
</fields>

This selects the languages from the database table and allows the user to choose one from a select element.

If you were to install the module as it is now you would see if you were to access the module in the backend of Joomla that a dropdown has appeared (although picking an option won't affect the module at the moment).

Note: The form field parameters are stored for each module in the #__modules table under the params field as JSON-encoded string.

Now let's make the form field do something!

Go into the mod_helloworld.php file and retrieve the parameter. (Note that you cannot retrieve the parameter in the helper.) Then pass it into the helper function.

/**
  * This retrieves the lang parameter we stored earlier. Note the second part
  * which assigns the default value of 1 if the parameter cannot be
  * retrieved for some reason.
**/
$language = $params->get('lang', '1');
$hello    = modHelloWorldHelper::getHello( $language );

Now let's edit our database query in the helper file to reflect our parameter choice.

// Obtain a database connection.
$db = JFactory::getDbo();
// Retrieve the shout. Note that we are now retrieving the id not the lang field.
$query = $db->getQuery(true)
            ->select($db->quoteName('hello'))
            ->from($db->quoteName('#__helloworld'))
            ->where('id = '. $db->Quote($params));
// Prepare the query
$db->setQuery($query);
// Load the row.
$result = $db->loadResult();
// Return the Hello.
return $result;

Conclusion

Form fields give the user an easy way to customise the module to their site's settings. This allows the module's scope to be increased as well for many languages and applications.

Prev: Using the Database

Next: Adding Auto Update